Skip to content

SgTemplateInstantiationDirectiveStatement

This class represents the concept of a C++ template instantiation directive.

Synopsis

Declared in <src/frontend/SageIII/Cxx_Grammar.h> (not stored in Git)

class [[visibility("default")]] SgTemplateInstantiationDirectiveStatement
    : public SgDeclarationStatement

Description

This statement controls the instantiation of template, forcing their explicit instantiation. It provides a mechanism to control the instantiation of template, useful in large projects and libraries. The directive owns and traverses its associated declaration.

  • See also: Example of using a SgTemplateInstantiationDirectiveStatement object

Data members

SgTemplateInstantiationDirectiveStatement::p_declaration

This pointer points to associated template instantiation declaration meant to be explicitly instantiated. Points to either (I think this is a complete list):

  • SgTemplateInstantiationDecl
  • SgTemplateInstantiationFunctionDecl
  • SgTemplateInstantiationMemberFunctionDecl
  • Internal: This is a SgDeclarationStatement so that it can reference a number of different declaration IR nodes (but not any SgDeclaration, since many don't make sense).

Member functions

`SgTemplateInstantiationDirectiveStatement::SgTemplateInstantiationDirectiveStatement ( Sg_File_Info* startOfConstruct = NULL )` This is the constructor. This constructor builds the SgTemplateInstantiationDirectiveStatement base class.

  • Param startOfConstruct: represents the position in the source code

SgTemplateInstantiationDirectiveStatement::get_declaration() const

Returns pointer to SgDeclarationStatement.

  • Return: Returns pointer to SgDeclarationStatement.

`SgTemplateInstantiationDirectiveStatement::set_declaration(SgDeclarationStatement* declaration)` Access function for p_declaration.

  • 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

Member Functions

Name Description
SgTemplateInstantiationDirectiveStatement
SgTemplateInstantiationDirectiveStatement(SgDeclarationStatement* declaration); [constructor]
Constructors
~SgTemplateInstantiationDirectiveStatement
virtual ~SgTemplateInstantiationDirectiveStatement(); [destructor] [virtual]
Destructor
accept
virtual void accept(ROSE_VisitorPattern& visitor) override; [virtual]
support for the classic visitor pattern done in GoF
appendDestructorOwnedNodes
virtual void appendDestructorOwnedNodes(std::vector<SgNode*>& nodes) const override; [virtual]
class_name
virtual std::string class_name() const override; [virtual]
returns a string representing the class name
copy
virtual SgNode* copy(SgCopyHelp& help) const override; [virtual]
fixupCopy_references
virtual void fixupCopy_references( SgNode* copy, SgCopyHelp& help) const override; [virtual]
fixupCopy_scopes
virtual void fixupCopy_scopes( SgNode* copy, SgCopyHelp& help) const override; [virtual]
fixupCopy_symbols
virtual void fixupCopy_symbols( SgNode* copy, SgCopyHelp& help) const override; [virtual]
get_childIndex
virtual size_t get_childIndex(SgNode* child) const override; [virtual]
index-based access to traversal successors by child node
get_declaration
SgDeclarationStatement* get_declaration() const;
get_do_not_instantiate
bool get_do_not_instantiate() const;
get_mangled_name
virtual SgName get_mangled_name() const override; [virtual]
get_numberOfTraversalSuccessors
virtual size_t get_numberOfTraversalSuccessors() const override; [virtual]
return number of children in the traversal successor list
get_traversalSuccessorByIndex
virtual SgNode* get_traversalSuccessorByIndex(size_t idx) const override; [virtual]
index-based access to traversal successors by index number
get_traversalSuccessorContainer
virtual 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_traversalSuccessorIsListElement
virtual std::vector<bool> get_traversalSuccessorIsListElement() const override; [virtual]
get_traversalSuccessorNamesContainer
virtual 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
operator delete
void operator delete( void* pointer, size_t size);
deallocated memory for IR node (returns memory to memory pool for reuse)
operator new
void* operator new(size_t size);
returns pointer to newly allocated IR node
post_construction_initialization
virtual void post_construction_initialization() override; [virtual]
processDataMemberReferenceToPointers
virtual void processDataMemberReferenceToPointers(ReferenceToPointerHandler*) override; [virtual]
Pass references to stored node pointers to a handler.
returnDataMemberPointers
virtual std::vector<std::pair<SgNode*, std::string>> returnDataMemberPointers() const override; [virtual]
Return the node pointers stored in this node's data members.
roseRTI
virtual RTIReturnType roseRTI() override; [virtual]
return C++ Runtime-Time-Information
sage_class_name
virtual char const* sage_class_name() const override; [virtual]
returns a C style string (char*) representing the class name
set_declaration
void set_declaration(SgDeclarationStatement* declaration);
set_do_not_instantiate
void set_do_not_instantiate(bool do_not_instantiate);
variantT
virtual VariantT variantT() const override; [virtual]
returns new style SageIII enum values

Static Member Functions

Name Description
memoryUsage
static size_t memoryUsage();
Returns the size in bytes of the total memory allocated for all IR nodes of this type
numberOfNodes
static size_t numberOfNodes();
Returns the total number of IR nodes of this type
traverseMemoryPoolNodes
static void traverseMemoryPoolNodes(ROSE_VisitTraversal& visit);
FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node.
traverseMemoryPoolVisitorPattern
static void traverseMemoryPoolVisitorPattern(ROSE_VisitorPattern& visitor);
FOR INTERNAL USE Support for visitor pattern.
visitRepresentativeNode
static 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_declaration
p_do_not_instantiate

Friends

Name Description
isSgTemplateInstantiationDirectiveStatement Casts pointer from base class to derived class (for const pointers)
isSgTemplateInstantiationDirectiveStatement Casts pointer from base class to derived class

Created with MrDocs