SgSymbol Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgSymbol:

[legend]Collaboration diagram for SgSymbol:

[legend]List of all members.

---

Detailed Description

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

Symbols are a simpler way for the compiler to quickly associate types, declarations and names. It is also more compact than carrying around names as strings. The SgSymbol can contain many references and is a shared IR node.

A "symbol" within the compiler is a concept of a name. The simplest example is a variable name, the variable most often has a name but internally within the compiler the variable is referenced as a symbol, the symbol data struction contains a name, type, and declaration (where the name was first associated with the type). Each variable has an associated symbol and each variable reference internally stores a pointer to the single symbol representing that variable. this avoids the compiler internally relying upon string processing to compile variable (different symbols can be trivially compared to either have the same address on not). Each named entity within the language's translation within the AST has a unique symbol. Mappings from names to symbols are held in the "Symbol Table" which provides for a quick (hashed) lookup on the symbol for any name. Mappings from the symbol to the name are held through pointers to the declaration (stored within the symbol).

To organize the symbols, they are differentiated by type, each symbol is derived from the SgSymbol class and defines a specialized interface for that specific kind of IR node. For example, there are symbol objects specific to classes, templates, variable, enums, functions, member functions, lables, function types, namespaces, typedefs, etc. In each case these symbols contain a name (or method for generating a name when it is located elsewhere), and a declaration, and often a reference to a type (or function to returning the type if not held in the symbol directly).

Each SgSymbol has a get_name() member function which gets the associated name of the symbol, usually from the stored declaration. A few symbols have an explicitly stored name (SgName), this is done where the name is derived from a named type (SgNamedType).

IMPORTANT: Declarations in Symbols
Indepedent of the different kinds of declarations (declarations are statements), declarations can be considered to be definind and non-defining. See SgDeclarationStatement for details. where there exist defining and non-defining declarations symbols within Sage III always reference non-defining declarations (only non-defining declarations are shared within the AST).

There are no uses of this IR node anywhere. All expressions and statements are derived from this IR node to build either SgExpression or SgStatement derived classes.

For internal use only.

This is a base class for all symbols.

Todo:

Consider derivation of SgEnumSymbol, SgClassSymbol, and SgTypedefSymbol from a common SgTypeSymbol. Then supporting functions for SgTypeSymbol would lookup any of these type based symbols.

See also:

SgDeclarationStatement

Example of using a SgSymbol object

Public Types
typedef SgNode	base_node_type
	static_variant = V_SgSymbol
enum	{ static_variant = V_SgSymbol }
	static variant value More...
Public Member Functions
virtual SgName	get_name () const =0
	Access function for getting name from declarations or types internally.
virtual SgType *	get_type () const =0
	This function returns the type associated with the named entity.
virtual SgNode *	get_symbol_basis () const
virtual SgScopeStatement *	get_scope () const
virtual void	addNewAttribute (std::string s, AstAttribute *a)
	Add a new attribute represented by the named string.
virtual AstAttribute *	getAttribute (std::string s) const
	Returns attribute of name 's'.
virtual void	updateAttribute (std::string s, AstAttribute *a)
	Replace existing attribute of name 's' with new AstAttribute.
virtual void	setAttribute (std::string s, AstAttribute *a)
	This is a wrapper function with the following semantics: if no attribute of name 's' exists then addNewAttribute(s,a); is called, otherwise updateAttribute(s,a); is called.
virtual void	removeAttribute (std::string s)
	Remove attribute of name 's' if present.
virtual bool	attributeExists (std::string s) const
	Tests if attribute of name 's' is present.
virtual int	numberOfAttributes () const
	Returns the number of attributes on this IR node.
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.
	SgSymbol (const SgSymbolStorageClass &source)
SgSymbol *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression.
AstAttributeMechanism *	get_attributeMechanism () const
	FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error.
void	set_attributeMechanism (AstAttributeMechanism *attributeMechanism)
	FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism.
virtual	~SgSymbol ()
	This is the destructor.
	SgSymbol ()
	This is the default constructor.
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
AstAttributeMechanism *	p_attributeMechanism
Friends
class	AST_FILE_IO
class	SgSymbolStorageClass
class	AstSpecificDataManagingClass
class	AstSpecificDataManagingClassStorageClass
SgSymbol *	isSgSymbol (SgNode *s)
	Casts pointer from base class to derived class.
const SgSymbol *	isSgSymbol (const SgNode *s)
	Casts pointer from base class to derived class (for const pointers).
SgSymbol *	SgSymbol_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	SgSymbol_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
	Get the size of the memory pool.
void	SgSymbol_clearMemoryPool ()
void	SgSymbol_extendMemoryPoolForFileIO (unsigned long)
void	SgSymbol_getNextValidPointer (std::pair< SgSymbol *, std::vector< unsigned char * >::const_iterator > &)
void	SgSymbol_resetValidFreepointers ()

---

Member Typedef Documentation

typedef SgNode SgSymbol::base_node_type

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

---

Member Enumeration Documentation

anonymous enum

static variant value

Enumerator:

static_variant

---

Constructor & Destructor Documentation

SgSymbol::SgSymbol

(

const SgSymbolStorageClass &

source

)

SgSymbol::~SgSymbol

(

)

[virtual]

This is the destructor.

SgSymbol::SgSymbol

(

)

This is the default constructor.

This constructor builds the SgSymbol base class.

See also:

Example:create an SgSymbol object

---

Member Function Documentation

SgSymbol::get_name

(

)

const [pure virtual]

Access function for getting name from declarations or types internally.

For internal use only.

This is a virtual function.

Returns:

Returns SgName.

Implemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

SgSymbol::get_type

(

)

const [pure virtual]

This function returns the type associated with the named entity.

For internal use only.

This is a virtual function.

Returns:

Returns SgType*.

Implemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

virtual SgNode* SgSymbol::get_symbol_basis

(

)

const [virtual]

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

virtual SgScopeStatement* SgSymbol::get_scope

(

)

const [virtual]

Reimplemented in SgMemberFunctionSymbol.

virtual void SgSymbol::addNewAttribute	(	std::string	s,
		AstAttribute *	a
	)			[virtual]

Add a new attribute represented by the named string.

Reimplemented from SgNode.

virtual AstAttribute* SgSymbol::getAttribute

(

std::string

s

)

const [virtual]

Returns attribute of name 's'.

Reimplemented from SgNode.

virtual void SgSymbol::updateAttribute	(	std::string	s,
		AstAttribute *	a
	)			[virtual]

Replace existing attribute of name 's' with new AstAttribute.

Reimplemented from SgNode.

virtual void SgSymbol::setAttribute	(	std::string	s,
		AstAttribute *	a
	)			[virtual]

This is a wrapper function with the following semantics: if no attribute of name 's' exists then addNewAttribute(s,a); is called, otherwise updateAttribute(s,a); is called.

Reimplemented from SgNode.

virtual void SgSymbol::removeAttribute

(

std::string

s

)

[virtual]

Remove attribute of name 's' if present.

Reimplemented from SgNode.

virtual bool SgSymbol::attributeExists

(

std::string

s

)

const [virtual]

Tests if attribute of name 's' is present.

Reimplemented from SgNode.

virtual int SgSymbol::numberOfAttributes

(

)

const [virtual]

Returns the number of attributes on this IR node.

Reimplemented from SgNode.

virtual std::string SgSymbol::class_name

(

)

const [virtual]

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

Reimplemented from SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

virtual VariantT SgSymbol::variantT

(

)

const [virtual]

returns new style SageIII enum values

Reimplemented from SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

void* SgSymbol::operator new

(

size_t

size

)

returns pointer to newly allocated IR node

Reimplemented from SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

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

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

Reimplemented from SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

void SgSymbol::operator delete

(

void *

pointer

)

Reimplemented from SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

static size_t SgSymbol::numberOfNodes

(

)

[static]

Returns the total number of IR nodes of this type.

Reimplemented from SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

static size_t SgSymbol::memoryUsage

(

)

[static]

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

Reimplemented from SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

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

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

virtual std::vector<std::string> SgSymbol::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 SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

virtual size_t SgSymbol::get_numberOfTraversalSuccessors

(

)

[virtual]

Reimplemented from SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

virtual SgNode* SgSymbol::get_traversalSuccessorByIndex

(

size_t

idx

)

[virtual]

Reimplemented from SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

virtual size_t SgSymbol::get_childIndex

(

SgNode *

child

)

[virtual]

Reimplemented from SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

virtual RTIReturnType SgSymbol::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 SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

virtual const char* SgSymbol::sage_class_name

(

)

const [virtual]

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

Reimplemented from SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

void SgSymbol::executeVisitorMemberFunction

(

ROSE_VisitorPattern &

visitor

)

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

virtual void SgSymbol::accept

(

ROSE_VisitorPattern &

visitor

)

[virtual]

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

Reimplemented from SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

static void SgSymbol::traverseMemoryPoolNodes

(

ROSE_VisitTraversal &

visit

)

[static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

static void SgSymbol::traverseMemoryPoolVisitorPattern

(

ROSE_VisitorPattern &

visitor

)

[static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

static void SgSymbol::visitRepresentativeNode

(

ROSE_VisitTraversal &

visit

)

[static]

FOR INTERNAL USE Support for type-based traversal.

Reimplemented from SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

virtual bool SgSymbol::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 SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

virtual void SgSymbol::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 SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

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

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

virtual void SgSymbol::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 SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

virtual long SgSymbol::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 SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

SgSymbol* SgSymbol::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 SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

AstAttributeMechanism * SgSymbol::get_attributeMechanism

(

)

const [virtual]

FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error.

This is an access function used for getting the interally held pointer to a valid AstAttributeMechanism. It provides access to lower level functionality of the AstAttributeMechanism, put is mostly of use to internal tools.

Reimplemented from SgNode.

void SgSymbol::set_attributeMechanism

(

AstAttributeMechanism *

a

)

[virtual]

FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism.

This is an access function used for setting the interally held pointer to a valid AstAttributeMechanism.

Reimplemented from SgNode.

---

Friends And Related Function Documentation

friend class AST_FILE_IO [friend]

Reimplemented from SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

friend class SgSymbolStorageClass [friend]

friend class AstSpecificDataManagingClass [friend]

Reimplemented from SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

friend class AstSpecificDataManagingClassStorageClass [friend]

Reimplemented from SgNode.

Reimplemented in SgVariableSymbol, SgFunctionSymbol, SgMemberFunctionSymbol, SgRenameSymbol, SgFunctionTypeSymbol, SgClassSymbol, SgTemplateSymbol, SgEnumSymbol, SgEnumFieldSymbol, SgTypedefSymbol, SgLabelSymbol, SgDefaultSymbol, SgNamespaceSymbol, SgIntrinsicSymbol, SgModuleSymbol, SgInterfaceSymbol, SgCommonSymbol, SgAliasSymbol, SgAsmBinaryAddressSymbol, SgAsmBinaryDataSymbol, and SgJavaLabelSymbol.

SgSymbol::isSgSymbol

(

SgNode *

s

)

[friend]

Casts pointer from base class to derived class.

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

Returns:

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

SgSymbol::isSgSymbol

(

const SgNode *

s

)

[friend]

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

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

Returns:

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

SgSymbol* SgSymbol_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 SgSymbol_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 SgSymbol_clearMemoryPool

(

)

[friend]

void SgSymbol_extendMemoryPoolForFileIO

(

unsigned

long

)

[friend]

void SgSymbol_getNextValidPointer

(

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

)

[friend]

void SgSymbol_resetValidFreepointers

(

)

[friend]

---

Member Data Documentation

AstAttributeMechanism* SgSymbol::p_attributeMechanism [protected]

---

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

• Cxx_Grammar.h
• SgSymbol.docs

---