SgNamespaceDefinitionStatement¶
This class represents the concept of a namespace definition.
Synopsis¶
Declared in <src/frontend/SageIII/Cxx_Grammar.h> (not stored in Git)
class [[visibility("default")]] SgNamespaceDefinitionStatement
: public SgScopeStatement Description¶
Namespace definitions are coupled with namespace declarations to defin the namespace (hold the list of declarations in the namespace. Within C++ namespaces are "reentrant" and as a result multiple namespace declarations (SgNamespaceDeclarationStatement) and definitions (SgNamespaceDefinitionStatement) may exist for a single namespace.
- Note: Note that the namespace "std" is special in C++, such that a program with the statement "using namespace std" can exist all by itself and is a valid program (even though "std" as a namespace is not defined).
Data members
SgNamespaceDefinitionStatement::p_declarations¶
This is an STL list of SgDeclarationStatement objects.
- Internal: The name is perhaps all to similar to p_declaration (which exists on many IR nodes).
SgNamespaceDefinitionStatement::p_namespaceDeclaration¶
This is a pointer to the SgNamespaceDeclarationStatement.
- Internal: The name would have been p_declaration, except that such a name is too close to p_declarations. These naming details might be fixed later.
Member functions
SgNamespaceDefinitionStatement::get_qualified_name() const¶
Returns SgName (a string) representing the name of the current scope. See discussion of mangled names in the documentation.
- Return: Returns SgName (a string).
SgNamespaceDefinitionStatement::copy(const SgCopyHelp & help)¶
Makes a copy (deap of shallow depending on SgCopyHelp).
- Return: Returns pointer to copy of SgNamespaceDefinitionStatement.
Base Classes¶
| Name | Description |
|---|---|
SgScopeStatement | This class represents the concept of a scope in C++ (e.g. global scope, fuction scope, etc.). |
Type Aliases¶
| Name |
|---|
base_node_type |
Enums¶
| Name | Description |
|---|---|
Unnamed enum | static variant value |
Member Functions¶
| Name | Description |
|---|---|
SgNamespaceDefinitionStatementSgNamespaceDefinitionStatement(SgNamespaceDeclarationStatement* namespaceDeclaration); [constructor] | Constructors |
~SgNamespaceDefinitionStatementvirtual ~SgNamespaceDefinitionStatement(); [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] | |
append_declarationvirtual void append_declaration(SgDeclarationStatement* element); [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_declarationsSgDeclarationStatementPtrList const& get_declarations() const; | |
get_global_definitionSgNamespaceDefinitionStatement* get_global_definition() const; | |
get_isUnionOfReentrantNamespaceDefinitionsbool get_isUnionOfReentrantNamespaceDefinitions() const; | |
get_mangled_namevirtual SgName get_mangled_name() const override; [virtual] | |
get_namespaceDeclarationSgNamespaceDeclarationStatement* get_namespaceDeclaration() const; | |
get_nextNamespaceDefinitionSgNamespaceDefinitionStatement* get_nextNamespaceDefinition() const; | |
get_numberOfTraversalSuccessorsvirtual size_t get_numberOfTraversalSuccessors() const override; [virtual] | return number of children in the traversal successor list |
get_previousNamespaceDefinitionSgNamespaceDefinitionStatement* get_previousNamespaceDefinition() const; | |
get_qualified_namevirtual SgName get_qualified_name() 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 |
isSameNamespacebool isSameNamespace(SgNamespaceDefinitionStatement const* n) const; | Compare if to namespaces are the same namespace (may be different scopes). |
namespaceIndexsize_t namespaceIndex() const; | |
numberOfNamespaceDefinitionssize_t numberOfNamespaceDefinitions() const; | |
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] | |
prepend_declarationvirtual void prepend_declaration(SgDeclarationStatement* element); [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_global_definitionvoid set_global_definition(SgNamespaceDefinitionStatement* global_definition); | |
set_isUnionOfReentrantNamespaceDefinitionsvoid set_isUnionOfReentrantNamespaceDefinitions(bool isUnionOfReentrantNamespaceDefinitions); | |
set_namespaceDeclarationvoid set_namespaceDeclaration(SgNamespaceDeclarationStatement* namespaceDeclaration); | |
set_nextNamespaceDefinitionvoid set_nextNamespaceDefinition(SgNamespaceDefinitionStatement* nextNamespaceDefinition); | |
set_previousNamespaceDefinitionvoid set_previousNamespaceDefinition(SgNamespaceDefinitionStatement* previousNamespaceDefinition); | |
variantTvirtual VariantT variantT() const override; [virtual] | returns new style SageIII enum values |
Static Member Functions¶
| Name | Description |
|---|---|
get_reopening_chain_revisionstatic uint64_t get_reopening_chain_revision(); | Changes whenever any reopening chain gains, loses, or reorders a definition, or a definition is destroyed. Indexes derived from the chains are current only while this value is unchanged. |
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 Member Functions¶
| Name |
|---|
insert_childvirtual bool insert_child( SgStatement*, SgStatement*, bool inFront = true, bool extractListFromBasicBlock = false) override; [virtual] |
replace_childvirtual bool replace_child( SgStatement*, SgStatement*, bool extractListFromBasicBlock = false) override; [virtual] |
Protected Data Members¶
| Name |
|---|
p_declarations |
p_global_definition |
p_isUnionOfReentrantNamespaceDefinitions |
p_namespaceDeclaration |
p_nextNamespaceDefinition |
p_previousNamespaceDefinition |
Private Static Member Functions¶
| Name |
|---|
advanceReopeningChainRevisionstatic void advanceReopeningChainRevision(); |
reopeningChainRevisionstatic std::atomic<uint64_t>& reopeningChainRevision(); |
Friends¶
| Name | Description |
|---|---|
isSgNamespaceDefinitionStatement | Casts pointer from base class to derived class (for const pointers) |
isSgNamespaceDefinitionStatement | Casts pointer from base class to derived class |
Created with MrDocs