Skip to content

SgNamespaceSymbol

This class represents the concept of a namespace name within the compiler.

Synopsis

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

class [[visibility("default")]] SgNamespaceSymbol
    : public SgSymbol

Description

This symbol holds a reference to a SgNamespaceDeclarationStatement and also any of its alias (referencing a SgNamespaceAliasDeclarationStatement).

  • Internal: The constructor for this symbol takes a name and a declaration. The reason is that it is used to handle the case of a namespace alias which uses the same symbol but uses a different name. I'm not certain that this is the best implementation since it stores the symbol in the symbol table under two names. It is not clear if that would be clear if the name were changes and this could cause the symbol table to not be completely removed from the symbol table.
  • Todo: It might be that we should have a SgNamespaceAliasSymbol so that namespace aliasing can be better supported. We can consider this for future work.
  • See also: SgSymbol for more details about symbols and why they are used in ROSE.
  • See also: Example of using a SgNamespaceSymbol object

Member functions

SgNamespaceSymbol::get_name() const

Access function for getting name stored internally (not the one in the declaration).

  • Return: Returns SgName.

SgNamespaceSymbol::get_type() const

This function returns the type associated with the named entity.

  • Return: Returns SgType*.

SgNamespaceSymbol::get_declaration() const

Access function for getting the declaration of the original namespace.

  • Return: Returns SgNamespaceDeclarationStatement.

`SgNamespaceSymbol::set_declaration(SgNamespaceDeclarationStatement

*declaration)` Access function for setting the declaration stored internally.

  • Return: Returns SgNamespaceDeclarationStatement.

Base Classes

Name Description
SgSymbol This class represents the concept of a name within the compiler.

Type Aliases

Name
base_node_type

Enums

Name Description
Unnamed enum static variant value

Member Functions

Name Description
SgNamespaceSymbol
SgNamespaceSymbol( SgNamespaceDeclarationStatement* declaration = NULL, SgNamespaceAliasDeclarationStatement* aliasDeclaration = NULL); [constructor]
Default constructor
~SgNamespaceSymbol
virtual ~SgNamespaceSymbol(); [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]
get_aliasDeclaration
SgNamespaceAliasDeclarationStatement* get_aliasDeclaration() const;
get_childIndex
virtual size_t get_childIndex(SgNode* child) const override; [virtual]
index-based access to traversal successors by child node
get_declaration
SgNamespaceDeclarationStatement* get_declaration() const;
get_name
virtual SgName get_name() const override; [virtual]
get_numberOfTraversalSuccessors
virtual size_t get_numberOfTraversalSuccessors() const override; [virtual]
return number of children in the traversal successor list
get_symbol_basis
virtual SgNode* get_symbol_basis() const override; [virtual]
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
get_type
virtual SgType* get_type() const override; [virtual]
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_aliasDeclaration
void set_aliasDeclaration(SgNamespaceAliasDeclarationStatement* aliasDeclaration);
set_declaration
void set_declaration(SgNamespaceDeclarationStatement* declaration);
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_aliasDeclaration
p_declaration

Friends

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

Created with MrDocs