SgNamespaceSymbol Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgNamespaceSymbol:

[legend]Collaboration diagram for SgNamespaceSymbol:

[legend]List of all members.

---

Detailed Description

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

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

For internal use only.

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.

Example of using a SgNamespaceSymbol object

Public Types
typedef SgSymbol	base_node_type
	static_variant = V_SgNamespaceSymbol
enum	{ static_variant = V_SgNamespaceSymbol }
	static variant value More...
Public Member Functions
virtual SgNode *	copy (SgCopyHelp &help) const
void	post_construction_initialization ()
	Final initialization for constructors This function is called at the end of generated constructors to allow the specification writer to add special initialization functions or tests. Default is to do nothing. Otherwise it should be overridden in the spec file, in NewHeaderCode/NewOutlinedCode.
virtual std::string	class_name () const
	Copies AST (whole subtree, depending on the SgCopyHelp class returns a string representing the class name.
virtual VariantT	variantT () const
	returns new style SageIII enum values
void *	operator new (size_t size)
	returns pointer to newly allocated IR node
void	operator delete (void *pointer, size_t size)
	deallocated memory for IR node (returns memory to memory pool for reuse)
void	operator delete (void *pointer)
virtual std::vector< SgNode * >	get_traversalSuccessorContainer ()
	FOR INTERNAL USE within ROSE traverals mechanism only.
virtual std::vector< std::string >	get_traversalSuccessorNamesContainer ()
	FOR INTERNAL USE within ROSE traverals mechanism only.
virtual size_t	get_numberOfTraversalSuccessors ()
virtual SgNode *	get_traversalSuccessorByIndex (size_t idx)
virtual size_t	get_childIndex (SgNode *child)
virtual RTIReturnType	roseRTI ()
	FOR INTERNAL USE Access to Runtime Type Information (RTI) for this IR nodes.
virtual const char *	sage_class_name () const ROSE_DEPRECATED_FUNCTION
void	executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern.
virtual void	accept (ROSE_VisitorPattern &visitor)
	DXN (08/09/2010): support for the classic visitor pattern done in GoF.
virtual bool	isInMemoryPool ()
	FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.
virtual void	checkDataMemberPointersIfInMemoryPool ()
	FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.
virtual std::vector< std::pair< SgNode *, std::string > >	returnDataMemberPointers () const
	FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools
virtual void	processDataMemberReferenceToPointers (ReferenceToPointerHandler *)
	FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools
virtual long	getChildIndex (SgNode *childNode) const
	FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node.
	SgNamespaceSymbol (const SgNamespaceSymbolStorageClass &source)
SgNamespaceSymbol *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression.
SgName	get_name () const
	Access function for getting name stored internally (not the one in the declaration).
SgNode *	get_symbol_basis () const
SgType *	get_type () const
	This function returns the type associated with the named entity.
SgNamespaceDeclarationStatement *	get_declaration () const
	Access function for getting the declaration of the original namespace.
void	set_declaration (SgNamespaceDeclarationStatement *declaration)
	Access function for setting the declaration stored internally.
SgNamespaceAliasDeclarationStatement *	get_aliasDeclaration () const
void	set_aliasDeclaration (SgNamespaceAliasDeclarationStatement *aliasDeclaration)
bool	get_isAlias () const
void	set_isAlias (bool isAlias)
virtual	~SgNamespaceSymbol ()
	This is the destructor.
	SgNamespaceSymbol (SgName name="", SgNamespaceDeclarationStatement *declaration=NULL, SgNamespaceAliasDeclarationStatement *aliasDeclaration=NULL, bool isAlias=false)
Static Public Member Functions
static size_t	numberOfNodes ()
	Returns the total number of IR nodes of this type.
static size_t	memoryUsage ()
	Returns the size in bytes of the total memory allocated for all IR nodes of this type.
static void	traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for visitor pattern.
static void	traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern.
static void	visitRepresentativeNode (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for type-based traversal.
Protected Attributes
SgName	p_name
SgNamespaceDeclarationStatement *	p_declaration
SgNamespaceAliasDeclarationStatement *	p_aliasDeclaration
bool	p_isAlias
Friends
class	AST_FILE_IO
class	SgNamespaceSymbolStorageClass
class	AstSpecificDataManagingClass
class	AstSpecificDataManagingClassStorageClass
SgNamespaceSymbol *	isSgNamespaceSymbol (SgNode *s)
	Casts pointer from base class to derived class.
const SgNamespaceSymbol *	isSgNamespaceSymbol (const SgNode *s)
	Casts pointer from base class to derived class (for const pointers).
SgNamespaceSymbol *	SgNamespaceSymbol_getPointerFromGlobalIndex (unsigned long globalIndex)
	Constructor for use by AST File I/O MechanismTypedef used for low level memory access. Typedef used to hold memory addresses as values. Methods to find the pointer to a global and local index.
unsigned long	SgNamespaceSymbol_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
	Get the size of the memory pool.
void	SgNamespaceSymbol_clearMemoryPool ()
void	SgNamespaceSymbol_extendMemoryPoolForFileIO (unsigned long)
void	SgNamespaceSymbol_getNextValidPointer (std::pair< SgNamespaceSymbol *, std::vector< unsigned char * >::const_iterator > &)
void	SgNamespaceSymbol_resetValidFreepointers ()

---

Member Typedef Documentation

typedef SgSymbol SgNamespaceSymbol::base_node_type

Reimplemented from SgSymbol.

---

Member Enumeration Documentation

anonymous enum

static variant value

Enumerator:

static_variant

---

Constructor & Destructor Documentation

SgNamespaceSymbol::SgNamespaceSymbol

(

const SgNamespaceSymbolStorageClass &

source

)

SgNamespaceSymbol::~SgNamespaceSymbol

(

)

[virtual]

This is the destructor.

SgNamespaceSymbol::SgNamespaceSymbol	(	SgName	name = "",
		SgNamespaceDeclarationStatement *	declaration = NULL,
		SgNamespaceAliasDeclarationStatement *	aliasDeclaration = NULL,
		bool	isAlias = false
	)

---

Member Function Documentation

virtual SgNode* SgNamespaceSymbol::copy

(

SgCopyHelp &

help

)

const [virtual]

Reimplemented from SgNode.

void SgNamespaceSymbol::post_construction_initialization

(

)

[virtual]

Final initialization for constructors This function is called at the end of generated constructors to allow the specification writer to add special initialization functions or tests. Default is to do nothing. Otherwise it should be overridden in the spec file, in NewHeaderCode/NewOutlinedCode.

Reimplemented from SgNode.

virtual std::string SgNamespaceSymbol::class_name

(

)

const [virtual]

Copies AST (whole subtree, depending on the SgCopyHelp class returns a string representing the class name.

Reimplemented from SgSymbol.

virtual VariantT SgNamespaceSymbol::variantT

(

)

const [virtual]

returns new style SageIII enum values

Reimplemented from SgSymbol.

void* SgNamespaceSymbol::operator new

(

size_t

size

)

returns pointer to newly allocated IR node

Reimplemented from SgSymbol.

void SgNamespaceSymbol::operator delete	(	void *	pointer,
		size_t	size
	)

deallocated memory for IR node (returns memory to memory pool for reuse)

Reimplemented from SgSymbol.

void SgNamespaceSymbol::operator delete

(

void *

pointer

)

Reimplemented from SgSymbol.

static size_t SgNamespaceSymbol::numberOfNodes

(

)

[static]

Returns the total number of IR nodes of this type.

Reimplemented from SgSymbol.

static size_t SgNamespaceSymbol::memoryUsage

(

)

[static]

Returns the size in bytes of the total memory allocated for all IR nodes of this type.

Reimplemented from SgSymbol.

virtual std::vector<SgNode*> SgNamespaceSymbol::get_traversalSuccessorContainer

(

)

[virtual]

FOR INTERNAL USE within ROSE traverals mechanism only.

This function builds and returns a copy of ordered container holding pointers to children of this node in a traversal. It is associated with the definition of a tree that is travered by the AST traversal mechanism; a tree that is embeded in the AST (which is a more general graph). This function is used within the implementation of the AST traversal and has a semantics may change in subtle ways that makes it difficult to use in user code. It can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Warning:

This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Returns:

Returns ordered STL Container of pointers to children nodes in AST.

Reimplemented from SgSymbol.

virtual std::vector<std::string> SgNamespaceSymbol::get_traversalSuccessorNamesContainer

(

)

[virtual]

FOR INTERNAL USE within ROSE traverals mechanism only.

This function builds and returns a copy of ordered container holding strings used to name data members that are traversed in the IR node. It is associated with the definition of a tree that is travered by the AST traversal mechanism; a tree that is embeded in the AST (which is a more general graph). This function is used within the implementation of the AST traversal and has a semantics may change in subtle ways that makes it difficult to use in user code. It can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Warning:

This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Each string is a name of a member variable holding a pointer to a child in the AST. The names are the same as used in the generated enums for accessing attributes in a traversal. The order is the same in which they are traversed and the same in which the access enums are defined. Therefore this method can be used to get the corresponding name (string) of an access enum which allows to produce more meaningful messages for attribute computations.

Returns:

Returns ordered STL container of names (strings) of access names to children nodes in AST.

Reimplemented from SgSymbol.

virtual size_t SgNamespaceSymbol::get_numberOfTraversalSuccessors

(

)

[virtual]

Reimplemented from SgSymbol.

virtual SgNode* SgNamespaceSymbol::get_traversalSuccessorByIndex

(

size_t

idx

)

[virtual]

Reimplemented from SgSymbol.

virtual size_t SgNamespaceSymbol::get_childIndex

(

SgNode *

child

)

[virtual]

Reimplemented from SgSymbol.

virtual RTIReturnType SgNamespaceSymbol::roseRTI

(

)

[virtual]

FOR INTERNAL USE Access to Runtime Type Information (RTI) for this IR nodes.

This function provides runtime type information for accessing the structure of the current node. It is useful for generating code which would dump out or rebuild IR nodes.

Returns:

Returns a RTIReturnType object (runtime type information).

Reimplemented from SgSymbol.

virtual const char* SgNamespaceSymbol::sage_class_name

(

)

const [virtual]

returns a C style string (char*) representing the class name

Reimplemented from SgSymbol.

void SgNamespaceSymbol::executeVisitorMemberFunction

(

ROSE_VisitorPattern &

visitor

)

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgSymbol.

virtual void SgNamespaceSymbol::accept

(

ROSE_VisitorPattern &

visitor

)

[virtual]

DXN (08/09/2010): support for the classic visitor pattern done in GoF.

Reimplemented from SgSymbol.

static void SgNamespaceSymbol::traverseMemoryPoolNodes

(

ROSE_VisitTraversal &

visit

)

[static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgSymbol.

static void SgNamespaceSymbol::traverseMemoryPoolVisitorPattern

(

ROSE_VisitorPattern &

visitor

)

[static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgSymbol.

static void SgNamespaceSymbol::visitRepresentativeNode

(

ROSE_VisitTraversal &

visit

)

[static]

FOR INTERNAL USE Support for type-based traversal.

Reimplemented from SgSymbol.

virtual bool SgNamespaceSymbol::isInMemoryPool

(

)

[virtual]

FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.

The AST File I/O depends upon the allocation of IR nodes being from the heap, stack based or global IR nodes should not appear in the AST if it will be written out to a file and read back in. To enforce this concept, this function implements a test to verify that the IR node can be found on the heap and is part of a larger test of the whole AST. This test must pass before the AST can be written out to a file. This is part of a compromise in the design of the AST File I/O to support binary streaming of data to files; for performance. It is also rather difficult, but possible, to build a useful AST with IR nodes allocated on the stack or frm global scope, this test filters out such cased from being used with the AST File I/O mechanism.

Reimplemented from SgSymbol.

virtual void SgNamespaceSymbol::checkDataMemberPointersIfInMemoryPool

(

)

[virtual]

FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.

The AST File I/O depends upon the allocation of IR nodes being from the heap, stack based or global IR nodes should not appear in the AST if it will be written out to a file and read back in. To enforce this concept, this function implements a test to verify that the IR node can be found on the heap and is part of a larger test of the whole AST. This test must pass before the AST can be written out to a file. This is part of a compromise in the design of the AST File I/O to support binary streaming of data to files; for performance. It is also rather difficult, but possible, to build a useful AST with IR nodes allocated on the stack or frm global scope, this test filters out such cased from being used with the AST File I/O mechanism.

Reimplemented from SgSymbol.

virtual std::vector<std::pair<SgNode*,std::string> > SgNamespaceSymbol::returnDataMemberPointers

(

)

const [virtual]

FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools

This functions is part of general support for many possible tools to operate on the AST. The forms a list of ALL IR node pointers used by each IR node, and is a supperset of the get_traversalSuccessorContainer(). It is (I think) less than the set of pointers used by the AST file I/O. This is part of work implemented by Andreas, and support tools such as the AST graph generation.

Warning:

This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Returns:

STL vector of pairs of SgNode* and strings

Reimplemented from SgSymbol.

virtual void SgNamespaceSymbol::processDataMemberReferenceToPointers

(

ReferenceToPointerHandler *

)

[virtual]

FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools

This functions similar to returnDataMemberPointers() except that it passes references to a handler object. As a result there is FAR more damage that can be done by using this function, but it is type-safe. This is provided for support of internal tools that operate on the AST, e.g the AST Merge mechanism.

Warning:

This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Reimplemented from SgSymbol.

virtual long SgNamespaceSymbol::getChildIndex

(

SgNode *

childNode

)

const [virtual]

FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node.

This function returns a unique value for the input childNode in set of children at this IR node. Note that a negative value indicates that the input node is not a child. This is the basis for the implementation of the isChild(SgNode*) member function. Data members that are NULL in the IR node are counted internally (so that this function returns value that could be statically defined, and so are not dynamically determined).

Warning:

The mapping on children to integer values could change from release to release of ROSE.

Returns:

long

Reimplemented from SgSymbol.

SgNamespaceSymbol* SgNamespaceSymbol::addRegExpAttribute	(	std::string	s,
		AstRegExAttribute *	a
	)

Support for AST matching using regular expression.

This support is incomplete and the subject of current research to define RegEx trees to support inexact matching.

Reimplemented from SgSymbol.

SgNamespaceSymbol::get_name

(

)

const [virtual]

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

Returns:

Returns SgName.

Implements SgSymbol.

SgNode* SgNamespaceSymbol::get_symbol_basis

(

)

const [virtual]

Reimplemented from SgSymbol.

SgNamespaceSymbol::get_type

(

)

const [virtual]

This function returns the type associated with the named entity.

Returns:

Returns SgType*.

Implements SgSymbol.

SgNamespaceSymbol::get_declaration

(

)

const

Access function for getting the declaration of the original namespace.

Returns:

Returns SgNamespaceDeclarationStatement.

SgNamespaceSymbol::set_declaration

(

SgNamespaceDeclarationStatement *

declaration

)

Access function for setting the declaration stored internally.

Returns:

Returns SgNamespaceDeclarationStatement.

SgNamespaceAliasDeclarationStatement* SgNamespaceSymbol::get_aliasDeclaration

(

)

const

void SgNamespaceSymbol::set_aliasDeclaration

(

SgNamespaceAliasDeclarationStatement *

aliasDeclaration

)

bool SgNamespaceSymbol::get_isAlias

(

)

const

void SgNamespaceSymbol::set_isAlias

(

bool

isAlias

)

---

Friends And Related Function Documentation

friend class AST_FILE_IO [friend]

Reimplemented from SgSymbol.

friend class SgNamespaceSymbolStorageClass [friend]

friend class AstSpecificDataManagingClass [friend]

Reimplemented from SgSymbol.

friend class AstSpecificDataManagingClassStorageClass [friend]

Reimplemented from SgSymbol.

SgNamespaceSymbol::isSgNamespaceSymbol

(

SgNode *

s

)

[friend]

Casts pointer from base class to derived class.

This functions returns a SgNamespaceSymbol pointer for any input of a pointer to an object derived from a SgNamespaceSymbol.

Returns:

Returns valid pointer to SgNamespaceSymbol if input is derived from a SgNamespaceSymbol.

SgNamespaceSymbol::isSgNamespaceSymbol

(

const SgNode *

s

)

[friend]

Casts pointer from base class to derived class (for const pointers).

This functions returns a SgNamespaceSymbol pointer for any input of a pointer to an object derived from a SgNamespaceSymbol.

Returns:

Returns valid pointer to SgNamespaceSymbol if input is derived from a SgNamespaceSymbol.

SgNamespaceSymbol* SgNamespaceSymbol_getPointerFromGlobalIndex

(

unsigned long

globalIndex

)

[friend]

Constructor for use by AST File I/O MechanismTypedef used for low level memory access. Typedef used to hold memory addresses as values. Methods to find the pointer to a global and local index.

unsigned long SgNamespaceSymbol_getNumberOfValidNodesAndSetGlobalIndexInFreepointer

(

unsigned

long

)

[friend]

Get the size of the memory pool.

It actually returns the size of the whole blocks allocated, no matter they contain valid pointers or not.

void SgNamespaceSymbol_clearMemoryPool

(

)

[friend]

void SgNamespaceSymbol_extendMemoryPoolForFileIO

(

unsigned

long

)

[friend]

void SgNamespaceSymbol_getNextValidPointer

(

std::pair< SgNamespaceSymbol *, std::vector< unsigned char * >::const_iterator > &

)

[friend]

void SgNamespaceSymbol_resetValidFreepointers

(

)

[friend]

---

Member Data Documentation

SgName SgNamespaceSymbol::p_name [protected]

SgNamespaceDeclarationStatement* SgNamespaceSymbol::p_declaration [protected]

SgNamespaceAliasDeclarationStatement* SgNamespaceSymbol::p_aliasDeclaration [protected]

bool SgNamespaceSymbol::p_isAlias [protected]

---

The documentation for this class was generated from the following files:

• Cxx_Grammar.h
• SgNamespaceSymbol.docs

---