Skip to content

SgNamespaceDeclarationStatement

This class represents the concept of a C++ namespace declaration.

Synopsis

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

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

Description

The namespace declaration is differernt from many other declarations in that there is not concept of a namespace declaration that does not have an associated definition (SgNamespaceDefinitionStatement). In a sense each SgNamespaceDeclarationStatement is a defining declaration, yet there can be more than one of them, so this concept of a defining declaration doesn't fit were we consider that there must be only a single defining declaration under the One-time Definition Rule (ODR). This we don't consider that SgNamespaceDeclarationStatement as a defining declaration. As a result:

  • The defining declaration returned by get_definindDeclaration() is always NULL, and
  • The get_firstNondefiningDeclaration() member function will:
  • Always return a valid pointer, and
  • Will point to the first declaration of SgNamespaceDeclarationStatement The scope of SgNamespaceDeclarationStatement is computed structurally from the parent information.
  • Todo: Consider having a function which could generate a list of all the SgNamespaceDeclarationStatement IR nodes that match the same namspace. This would make a good first project for a new student.
  • Todo: Include a graph to show how scopes are handled within the AST.
  • See also: Example of using a SgNamespaceDeclarationStatement object

Data members

SgNamespaceDeclarationStatement::p_name

This the name of the new namespace alias (usually a shorter name).

SgNamespaceDeclarationStatement::p_definition

This pointer points to the SgNamespaceDefinitionStatement, which holds the declarations within the namespace.

SgNamespaceDeclarationStatement::p_isUnnamedNamespace

Records special case of an unnamed namespace.

  • Internal: Marking the IR nodes as unnamed is better than just having an empty string for p_name. This provides a reasonable mechanism to implement error checking internally.

SgNamespaceDeclarationStatement::p_scope

This a pointer to the scope of the first declaration for the namespace.

Member functions

SgNamespaceDeclarationStatement::get_name() const

Access function for p_name.

  • Return: Returns SgName.

SgNamespaceDeclarationStatement::set_name(SgName name)

Access function for p_name.

  • Return: Returns void.

SgNamespaceDeclarationStatement::get_definition() const

Returns pointer to SgNamespaceDefinitionStatement.

  • Return: Returns pointer to SgNamespaceDefinitionStatement.

`SgNamespaceDeclarationStatement::set_definition(SgNamespaceDefinitionStatement* definition)` Access function for p_definition.

  • Return: Returns void.

SgNamespaceDeclarationStatement::get_isUnnamedNamespace() const

Access function for p_isUnnamedNamespace.

  • Return: Returns SgName.

`SgNamespaceDeclarationStatement::set_isUnnamedNamespace(bool

isUnnamedNamespace)` Access function for p_isUnnamedNamespace.

  • 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
SgNamespaceDeclarationStatement
SgNamespaceDeclarationStatement( SgName name, SgNamespaceDefinitionStatement* definition, bool isUnnamedNamespace); [constructor]
Constructors
~SgNamespaceDeclarationStatement
virtual ~SgNamespaceDeclarationStatement(); [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]
attach_source_fragments
void attach_source_fragments( SgNamespaceSourceFragment* opening_introducer, SgNamespaceSourceFragment* opening, SgNamespaceSourceFragment* closing);
Install the physical syntax fragments owned by this namespace. A split opening has one exact introducer fragment followed by the name/brace fragment; ordinary openings have no separate introducer.
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_closing_source_fragment
SgNamespaceSourceFragment* get_closing_source_fragment();
get_definition
SgNamespaceDefinitionStatement* get_definition() const;
get_first_opening_source_fragment
SgNamespaceSourceFragment* get_first_opening_source_fragment();
Return the earliest typed fragment in the namespace opening transaction.
get_isInlinedNamespace
bool get_isInlinedNamespace() const;
get_isUnnamedNamespace
bool get_isUnnamedNamespace() const;
get_mangled_name
virtual SgName get_mangled_name() const override; [virtual]
get_name
SgName get_name() const;
get_numberOfTraversalSuccessors
virtual size_t get_numberOfTraversalSuccessors() const override; [virtual]
return number of children in the traversal successor list
get_opening_introducer_source_fragment
SgNamespaceSourceFragment* get_opening_introducer_source_fragment();
get_opening_source_fragment
SgNamespaceSourceFragment* get_opening_source_fragment();
get_qualified_name
virtual SgName get_qualified_name() const; [virtual]
get_symbol_from_symbol_table
virtual SgSymbol* get_symbol_from_symbol_table() 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
has_source_fragments
bool has_source_fragments() const;
True only when both typed syntax fragments have been installed.
isSameNamespace
bool isSameNamespace(SgNamespaceDeclarationStatement const* n) const;
Check if two namespaces are the same
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_definition
void set_definition(SgNamespaceDefinitionStatement* definition);
set_isInlinedNamespace
void set_isInlinedNamespace(bool isInlinedNamespace);
set_isUnnamedNamespace
void set_isUnnamedNamespace(bool isUnnamedNamespace);
set_name
void set_name(SgName name);
validate_source_fragments
void validate_source_fragments() const;
Reject partial, multiply-owned, mistyped, or inconsistent fragments.
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_closing_source_fragment
p_definition
p_isInlinedNamespace
p_isUnnamedNamespace
p_name
p_opening_introducer_source_fragment
p_opening_source_fragment

Friends

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

Created with MrDocs