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 |
|---|---|
SgNamespaceSymbolSgNamespaceSymbol( SgNamespaceDeclarationStatement* declaration = NULL, SgNamespaceAliasDeclarationStatement* aliasDeclaration = NULL); [constructor] | Default constructor |
~SgNamespaceSymbolvirtual ~SgNamespaceSymbol(); [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] | |
get_aliasDeclarationSgNamespaceAliasDeclarationStatement* get_aliasDeclaration() const; | |
get_childIndexvirtual size_t get_childIndex(SgNode* child) const override; [virtual] | index-based access to traversal successors by child node |
get_declarationSgNamespaceDeclarationStatement* get_declaration() const; | |
get_namevirtual SgName get_name() const override; [virtual] | |
get_numberOfTraversalSuccessorsvirtual size_t get_numberOfTraversalSuccessors() const override; [virtual] | return number of children in the traversal successor list |
get_symbol_basisvirtual SgNode* get_symbol_basis() const override; [virtual] | |
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 |
get_typevirtual SgType* get_type() const override; [virtual] | |
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_aliasDeclarationvoid set_aliasDeclaration(SgNamespaceAliasDeclarationStatement* aliasDeclaration); | |
set_declarationvoid set_declaration(SgNamespaceDeclarationStatement* declaration); | |
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_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