SgSymbolTable Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgSymbolTable:

[legend]Collaboration diagram for SgSymbolTable:

[legend]List of all members.

---

Detailed Description

This class represents the symbol tables used in both SgScopeStatement and the SgFunctionTypeSymbolTable IR node.

Todo:

The rose_hash_multimap should perhaps be included as a data member instead of implemented as a pointer. We should consider this detail.

Todo:

We should decide if we want to give Symbol Tables a name or not, it seems that we rarely if ever do this so perhaps we should not have such a field.

See also:

Example of using a SgSymbolTable object

Public Types
typedef rose_hash_multimap	BaseHashType
typedef BaseHashType::iterator	hash_iterator
typedef SgSupport	base_node_type
	static_variant = V_SgSymbolTable
enum	{ static_variant = V_SgSymbolTable }
	static variant value More...
Public Member Functions
virtual SgNode *	copy (SgCopyHelp &help) const
	SgSymbolTable ()
	This is the constructor.
	SgSymbolTable (int sz)
	Added to support scopes that have more symbols (e.g. SgGlobal, and the function type table).
void	insert (const SgName &name, SgSymbol *sp)
bool	find (const SgName &name, SgSymbol *sp) ROSE_DEPRECATED_FUNCTION
bool	exists (const SgName &, SgSymbol *sp) const
bool	exists (const SgName &name) const
	Complexity O(log n), checks for existence of symbol before matching against names.
bool	exists (const SgSymbol *sp) const
	Complexity O(log n).
SgSymbol *	find (const SgInitializedName *initializedName)
	Complexity O(log n).
SgSymbol *	find (const SgFunctionType *functionType)
	Complexity O(n).
SgSymbol *	find (const SgStatement *statement)
	Complexity O(n).
void	remove (const SgSymbol *symbol)
	Complexity O(n).
void	remove_function_type (const SgName &name)
	Complexity O(log n).
SgSymbol *	find_any (const SgName &name)
	Complexity O(log n).
SgVariableSymbol *	find_variable (const SgName &name)
	Complexity O(log n) for first match against name, then O(n).
SgClassSymbol *	find_class (const SgName &name)
	Complexity O(log n) for first match against name, then O(n).
SgFunctionSymbol *	find_function (const SgName &name)
	Complexity O(log n) for first match against name, then O(n).
SgFunctionSymbol *	find_function (const SgName &, const SgType *name)
	Complexity O(log n) for first match against name, then O(n).
SgFunctionTypeSymbol *	find_function_type (const SgName &name)
	Complexity O(log n) for first match against name, then O(n).
SgTypedefSymbol *	find_typedef (const SgName &name)
	Complexity O(log n) for first match against name, then O(n).
SgEnumSymbol *	find_enum (const SgName &name)
	Complexity O(log n) for first match against name, then O(n).
SgEnumFieldSymbol *	find_enum_field (const SgName &name)
	Complexity O(log n) for first match against name, then O(n).
SgLabelSymbol *	find_label (const SgName &name)
	Complexity O(log n) for first match against name, then O(n).
SgJavaLabelSymbol *	find_java_label (const SgName &name)
	Complexity O(log n) for first match against name, then O(n).
SgNamespaceSymbol *	find_namespace (const SgName &name)
	Complexity O(log n) for first match against name, then O(n).
SgTemplateSymbol *	find_template (const SgName &name)
	Complexity O(log n) for first match against name, then O(n).
SgSymbol *	find_any ()
	Complexity O(log n) for first match against name, then O(n).
SgVariableSymbol *	find_variable ()
	Complexity O(log n) for first match against name, then O(n).
SgClassSymbol *	find_class ()
	Complexity O(log n) for first match against name, then O(n).
SgFunctionSymbol *	find_function ()
	Complexity O(log n) for first match against name, then O(n).
SgTypedefSymbol *	find_typedef ()
	Complexity O(log n) for first match against name, then O(n).
SgEnumSymbol *	find_enum ()
	Complexity O(log n) for first match against name, then O(n).
SgEnumFieldSymbol *	find_enum_field ()
	Complexity O(log n) for first match against name, then O(n).
SgLabelSymbol *	find_label ()
	Complexity O(log n) for first match against name, then O(n).
SgNamespaceSymbol *	find_namespace ()
	Complexity O(log n) for first match against name, then O(n).
SgTemplateSymbol *	find_template ()
	Complexity O(log n) for first match against name, then O(n).
SgSymbol *	next_any ()
	Complexity O(log n) for first match against name, then O(n).
SgVariableSymbol *	next_variable ()
	Complexity O(n).
SgClassSymbol *	next_class ()
	Complexity O(n).
SgFunctionSymbol *	next_function ()
	Complexity O(n).
SgTypedefSymbol *	next_typedef ()
	Complexity O(n).
SgEnumSymbol *	next_enum ()
	Complexity O(n).
SgEnumFieldSymbol *	next_enum_field ()
	Complexity O(n).
SgLabelSymbol *	next_label ()
	Complexity O(n).
SgNamespaceSymbol *	next_namespace ()
	Complexity O(n).
SgTemplateSymbol *	next_template ()
	Complexity O(n).
int	count (const SgName &) const
	Computes the number of symbols of a specific name.
int	count_aliases (const SgName &) const
	Computes the number of alias symbols of a specific name (used in name qualification support).
void	print (std::string label, VariantT nodeType=V_SgSymbol)
	Outputs symbol table information (useful for debugging).
void	print ()
int	size () const
	Computes the number of symbols in the symbol table (forced to count them, I think, internal STL detail).
std::set< SgNode * >	get_symbols () const
	generate an STL set of all symbols (supports AST merge, but may be temporary)
SgName	get_name (const SgNode *node) const
	Generates name from any IR node used to generate symbols (only works on specific IR nodes).
bool	isCaseInsensitive () const
	Query of scope symbol table behavior (is symbol table behavior case sensitive (C/C++) or case insensitive (Fortran).
void	setCaseInsensitive (bool b)
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.
	SgSymbolTable (const SgSymbolTableStorageClass &source)
SgSymbolTable *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression.
SgName	get_name () const
void	set_name (SgName name)
bool	get_no_name () const
void	set_no_name (bool no_name)
rose_hash_multimap *	get_table () const
void	set_table (rose_hash_multimap *table)
SgNodeSet	get_symbolSet () const
void	set_symbolSet (SgNodeSet symbolSet)
virtual	~SgSymbolTable ()
	This is the destructor.
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
hash_iterator	p_iterator
	This iterator is used within some of the deprecated functions.
SgName	p_name
	This is the symbol name (mangled is required).
bool	p_no_name
	This is a flag to indicate that p_name is empty.
rose_hash_multimap *	p_table
	This is lower level symbol table implementation (using an STL hash_multimap).
SgNodeSet	p_symbolSet
bool	p_case_insensitive
Friends
class	AST_FILE_IO
class	SgSymbolTableStorageClass
class	AstSpecificDataManagingClass
class	AstSpecificDataManagingClassStorageClass
SgSymbolTable *	isSgSymbolTable (SgNode *s)
	Casts pointer from base class to derived class.
const SgSymbolTable *	isSgSymbolTable (const SgNode *s)
	Casts pointer from base class to derived class (for const pointers).
SgSymbolTable *	SgSymbolTable_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	SgSymbolTable_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
	Get the size of the memory pool.
void	SgSymbolTable_clearMemoryPool ()
void	SgSymbolTable_extendMemoryPoolForFileIO (unsigned long)
void	SgSymbolTable_getNextValidPointer (std::pair< SgSymbolTable *, std::vector< unsigned char * >::const_iterator > &)
void	SgSymbolTable_resetValidFreepointers ()

---

Member Typedef Documentation

typedef rose_hash_multimap SgSymbolTable::BaseHashType

typedef BaseHashType::iterator SgSymbolTable::hash_iterator

typedef SgSupport SgSymbolTable::base_node_type

Reimplemented from SgSupport.

---

Member Enumeration Documentation

anonymous enum

static variant value

Enumerator:

static_variant

---

Constructor & Destructor Documentation

SgSymbolTable::SgSymbolTable

(

)

This is the constructor.

This constructor builds the SgSymbolTable base class.

See also:

Example:create an SgSymbolTable object

SgSymbolTable::SgSymbolTable

(

int

sz

)

Added to support scopes that have more symbols (e.g. SgGlobal, and the function type table).

SgSymbolTable::SgSymbolTable

(

const SgSymbolTableStorageClass &

source

)

SgSymbolTable::~SgSymbolTable

(

)

[virtual]

This is the destructor.

There is nothing to delete in this object.

---

Member Function Documentation

virtual SgNode* SgSymbolTable::copy

(

SgCopyHelp &

help

)

const [virtual]

Reimplemented from SgSupport.

void SgSymbolTable::insert	(	const SgName &	name,
		SgSymbol *	sp
	)

bool SgSymbolTable::find	(	const SgName &	name,
		SgSymbol *	sp
	)

bool SgSymbolTable::exists	(	const SgName &	,
		SgSymbol *	sp
	)			const

bool SgSymbolTable::exists

(

const SgName &

name

)

const

Complexity O(log n), checks for existence of symbol before matching against names.

bool SgSymbolTable::exists

(

const SgSymbol *

sp

)

const

Complexity O(log n).

SgSymbol* SgSymbolTable::find

(

const SgInitializedName *

initializedName

)

Complexity O(log n).

SgSymbol* SgSymbolTable::find

(

const SgFunctionType *

functionType

)

Complexity O(n).

SgSymbol* SgSymbolTable::find

(

const SgStatement *

statement

)

Complexity O(n).

void SgSymbolTable::remove

(

const SgSymbol *

symbol

)

Complexity O(n).

void SgSymbolTable::remove_function_type

(

const SgName &

name

)

Complexity O(log n).

SgSymbol* SgSymbolTable::find_any

(

const SgName &

name

)

Complexity O(log n).

SgVariableSymbol* SgSymbolTable::find_variable

(

const SgName &

name

)

Complexity O(log n) for first match against name, then O(n).

SgClassSymbol* SgSymbolTable::find_class

(

const SgName &

name

)

Complexity O(log n) for first match against name, then O(n).

SgFunctionSymbol* SgSymbolTable::find_function

(

const SgName &

name

)

Complexity O(log n) for first match against name, then O(n).

SgFunctionSymbol* SgSymbolTable::find_function	(	const SgName &	,
		const SgType *	name
	)

Complexity O(log n) for first match against name, then O(n).

SgFunctionTypeSymbol* SgSymbolTable::find_function_type

(

const SgName &

name

)

Complexity O(log n) for first match against name, then O(n).

SgTypedefSymbol* SgSymbolTable::find_typedef

(

const SgName &

name

)

Complexity O(log n) for first match against name, then O(n).

SgEnumSymbol* SgSymbolTable::find_enum

(

const SgName &

name

)

Complexity O(log n) for first match against name, then O(n).

SgEnumFieldSymbol* SgSymbolTable::find_enum_field

(

const SgName &

name

)

Complexity O(log n) for first match against name, then O(n).

SgLabelSymbol* SgSymbolTable::find_label

(

const SgName &

name

)

Complexity O(log n) for first match against name, then O(n).

SgJavaLabelSymbol* SgSymbolTable::find_java_label

(

const SgName &

name

)

Complexity O(log n) for first match against name, then O(n).

SgNamespaceSymbol* SgSymbolTable::find_namespace

(

const SgName &

name

)

Complexity O(log n) for first match against name, then O(n).

SgTemplateSymbol* SgSymbolTable::find_template

(

const SgName &

name

)

Complexity O(log n) for first match against name, then O(n).

SgSymbol* SgSymbolTable::find_any

(

)

Complexity O(log n) for first match against name, then O(n).

SgVariableSymbol* SgSymbolTable::find_variable

(

)

Complexity O(log n) for first match against name, then O(n).

SgClassSymbol* SgSymbolTable::find_class

(

)

Complexity O(log n) for first match against name, then O(n).

SgFunctionSymbol* SgSymbolTable::find_function

(

)

Complexity O(log n) for first match against name, then O(n).

SgTypedefSymbol* SgSymbolTable::find_typedef

(

)

Complexity O(log n) for first match against name, then O(n).

SgEnumSymbol* SgSymbolTable::find_enum

(

)

Complexity O(log n) for first match against name, then O(n).

SgEnumFieldSymbol* SgSymbolTable::find_enum_field

(

)

Complexity O(log n) for first match against name, then O(n).

SgLabelSymbol* SgSymbolTable::find_label

(

)

Complexity O(log n) for first match against name, then O(n).

SgNamespaceSymbol* SgSymbolTable::find_namespace

(

)

Complexity O(log n) for first match against name, then O(n).

SgTemplateSymbol* SgSymbolTable::find_template

(

)

Complexity O(log n) for first match against name, then O(n).

SgSymbol* SgSymbolTable::next_any

(

)

Complexity O(log n) for first match against name, then O(n).

SgVariableSymbol* SgSymbolTable::next_variable

(

)

Complexity O(n).

SgClassSymbol* SgSymbolTable::next_class

(

)

Complexity O(n).

SgFunctionSymbol* SgSymbolTable::next_function

(

)

Complexity O(n).

SgTypedefSymbol* SgSymbolTable::next_typedef

(

)

Complexity O(n).

SgEnumSymbol* SgSymbolTable::next_enum

(

)

Complexity O(n).

SgEnumFieldSymbol* SgSymbolTable::next_enum_field

(

)

Complexity O(n).

SgLabelSymbol* SgSymbolTable::next_label

(

)

Complexity O(n).

SgNamespaceSymbol* SgSymbolTable::next_namespace

(

)

Complexity O(n).

SgTemplateSymbol* SgSymbolTable::next_template

(

)

Complexity O(n).

int SgSymbolTable::count

(

const SgName &

)

const

Computes the number of symbols of a specific name.

int SgSymbolTable::count_aliases

(

const SgName &

)

const

Computes the number of alias symbols of a specific name (used in name qualification support).

void SgSymbolTable::print	(	std::string	label,
		VariantT	nodeType = V_SgSymbol
	)

Outputs symbol table information (useful for debugging).

void SgSymbolTable::print

(

)

int SgSymbolTable::size

(

)

const

Computes the number of symbols in the symbol table (forced to count them, I think, internal STL detail).

std::set<SgNode*> SgSymbolTable::get_symbols

(

)

const

generate an STL set of all symbols (supports AST merge, but may be temporary)

SgName SgSymbolTable::get_name

(

const SgNode *

node

)

const

Generates name from any IR node used to generate symbols (only works on specific IR nodes).

bool SgSymbolTable::isCaseInsensitive

(

)

const

Query of scope symbol table behavior (is symbol table behavior case sensitive (C/C++) or case insensitive (Fortran).

Note that a case insensitive symbol table can only be built that way from the SgSymbolTable constructor and not be toggled back and forth at will.

void SgSymbolTable::setCaseInsensitive

(

bool

b

)

virtual std::string SgSymbolTable::class_name

(

)

const [virtual]

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

Reimplemented from SgSupport.

virtual VariantT SgSymbolTable::variantT

(

)

const [virtual]

returns new style SageIII enum values

Reimplemented from SgSupport.

void* SgSymbolTable::operator new

(

size_t

size

)

returns pointer to newly allocated IR node

Reimplemented from SgSupport.

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

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

Reimplemented from SgSupport.

void SgSymbolTable::operator delete

(

void *

pointer

)

Reimplemented from SgSupport.

static size_t SgSymbolTable::numberOfNodes

(

)

[static]

Returns the total number of IR nodes of this type.

Reimplemented from SgSupport.

static size_t SgSymbolTable::memoryUsage

(

)

[static]

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

Reimplemented from SgSupport.

virtual std::vector<SgNode*> SgSymbolTable::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 SgSupport.

virtual std::vector<std::string> SgSymbolTable::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 SgSupport.

virtual size_t SgSymbolTable::get_numberOfTraversalSuccessors

(

)

[virtual]

Reimplemented from SgSupport.

virtual SgNode* SgSymbolTable::get_traversalSuccessorByIndex

(

size_t

idx

)

[virtual]

Reimplemented from SgSupport.

virtual size_t SgSymbolTable::get_childIndex

(

SgNode *

child

)

[virtual]

Reimplemented from SgSupport.

virtual RTIReturnType SgSymbolTable::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 SgSupport.

virtual const char* SgSymbolTable::sage_class_name

(

)

const [virtual]

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

Reimplemented from SgSupport.

void SgSymbolTable::executeVisitorMemberFunction

(

ROSE_VisitorPattern &

visitor

)

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgSupport.

virtual void SgSymbolTable::accept

(

ROSE_VisitorPattern &

visitor

)

[virtual]

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

Reimplemented from SgSupport.

static void SgSymbolTable::traverseMemoryPoolNodes

(

ROSE_VisitTraversal &

visit

)

[static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgSupport.

static void SgSymbolTable::traverseMemoryPoolVisitorPattern

(

ROSE_VisitorPattern &

visitor

)

[static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgSupport.

static void SgSymbolTable::visitRepresentativeNode

(

ROSE_VisitTraversal &

visit

)

[static]

FOR INTERNAL USE Support for type-based traversal.

Reimplemented from SgSupport.

virtual bool SgSymbolTable::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 SgSupport.

virtual void SgSymbolTable::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 SgSupport.

virtual std::vector<std::pair<SgNode*,std::string> > SgSymbolTable::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 SgSupport.

virtual void SgSymbolTable::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 SgSupport.

virtual long SgSymbolTable::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 SgSupport.

SgSymbolTable* SgSymbolTable::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 SgSupport.

SgName SgSymbolTable::get_name

(

)

const

void SgSymbolTable::set_name

(

SgName

name

)

bool SgSymbolTable::get_no_name

(

)

const

void SgSymbolTable::set_no_name

(

bool

no_name

)

rose_hash_multimap* SgSymbolTable::get_table

(

)

const

void SgSymbolTable::set_table

(

rose_hash_multimap *

table

)

SgNodeSet SgSymbolTable::get_symbolSet

(

)

const

void SgSymbolTable::set_symbolSet

(

SgNodeSet

symbolSet

)

---

Friends And Related Function Documentation

friend class AST_FILE_IO [friend]

Reimplemented from SgSupport.

friend class SgSymbolTableStorageClass [friend]

friend class AstSpecificDataManagingClass [friend]

Reimplemented from SgSupport.

friend class AstSpecificDataManagingClassStorageClass [friend]

Reimplemented from SgSupport.

SgSymbolTable::isSgSymbolTable

(

SgNode *

s

)

[friend]

Casts pointer from base class to derived class.

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

Returns:

Returns valid pointer to SgSymbolTable if input is a SgSymbolTable.

SgSymbolTable::isSgSymbolTable

(

const SgNode *

s

)

[friend]

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

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

Returns:

Returns valid pointer to SgSymbolTable if input is a SgSymbolTable.

SgSymbolTable* SgSymbolTable_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 SgSymbolTable_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 SgSymbolTable_clearMemoryPool

(

)

[friend]

void SgSymbolTable_extendMemoryPoolForFileIO

(

unsigned

long

)

[friend]

void SgSymbolTable_getNextValidPointer

(

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

)

[friend]

void SgSymbolTable_resetValidFreepointers

(

)

[friend]

---

Member Data Documentation

SgSymbolTable::p_iterator [protected]

This iterator is used within some of the deprecated functions.

Deprecated:

I think this iterator should be removed.

SgSymbolTable::p_name [protected]

This is the symbol name (mangled is required).

SgSymbolTable::p_no_name [protected]

This is a flag to indicate that p_name is empty.

Some symbols don't have a name.

Todo:

generate a list of instances where symbols don't have names. (Namespaces don't have to have a name for example).

SgSymbolTable::p_table [protected]

This is lower level symbol table implementation (using an STL hash_multimap).

SgNodeSet SgSymbolTable::p_symbolSet [protected]

bool SgSymbolTable::p_case_insensitive [protected]

---

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

• Cxx_Grammar.h
• SgSymbolTable.docs

---