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

#include <Cxx_Grammar.h>

Inheritance diagram for SgSymbol:

Collaboration diagram for SgSymbol:

Public Types
enum	{ static_variant = V_SgSymbol }
	static variant value More...

typedef SgNode	base_node_type

Public Types inherited from SgNode
enum	{ static_variant = V_SgNode }
	static variant value More...

Public Member Functions
virtual SgName	get_name () const =0
	Access function for getting name from declarations or types internally. More...

virtual SgType *	get_type () const =0
	This function returns the type associated with the named entity. More...

virtual SgNode *	get_symbol_basis () const

virtual SgScopeStatement *	get_scope () const

SgName	get_mangled_name () const

SgDeclarationStatement *	get_declaration () const

virtual void	addNewAttribute (std::string s, AstAttribute *a)
	Add a new attribute represented by the named string. More...

virtual AstAttribute *	getAttribute (std::string s) const
	Returns attribute of name 's'. More...

virtual void	updateAttribute (std::string s, AstAttribute *a)
	Replace existing attribute of name 's' with new AstAttribute. More...

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. More...

virtual void	removeAttribute (std::string s)
	Remove attribute of name 's' if present. More...

virtual bool	attributeExists (std::string s) const
	Tests if attribute of name 's' is present. More...

virtual int	numberOfAttributes () const
	Returns the number of attributes on this IR node. More...

virtual std::string	class_name () const
	Copies AST (whole subtree, depending on the SgCopyHelp class. More...

virtual VariantT	variantT () const
	returns new style SageIII enum values More...

void *	operator new (size_t size)
	returns pointer to newly allocated IR node More...

void	operator delete (void *pointer, size_t size)
	deallocated memory for IR node (returns memory to memory pool for reuse) More...

void	operator delete (void *pointer)

virtual std::vector< SgNode * >	get_traversalSuccessorContainer ()
	FOR INTERNAL USE within ROSE traverals mechanism only. More...

virtual std::vector< std::string >	get_traversalSuccessorNamesContainer ()
	FOR INTERNAL USE within ROSE traverals mechanism only. More...

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. More...

virtual const char *	sage_class_name () const ROSE_DEPRECATED_FUNCTION

void	executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern. More...

virtual void	accept (ROSE_VisitorPattern &visitor)
	DXN (08/09/2010): support for the classic visitor pattern done in GoF. More...

virtual bool	isInMemoryPool ()
	FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...

virtual void	checkDataMemberPointersIfInMemoryPool ()
	FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...

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 More...

virtual void	processDataMemberReferenceToPointers (ReferenceToPointerHandler *)
	FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools More...

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. More...

	SgSymbol (const SgSymbolStorageClass &source)

SgSymbol *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression. More...

AstAttributeMechanism *	get_attributeMechanism () const
	FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error. More...

void	set_attributeMechanism (AstAttributeMechanism *attributeMechanism)
	FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism. More...

virtual	~SgSymbol ()
	This is the destructor. More...

	SgSymbol ()
	This is the default constructor. More...

Public Member Functions inherited from SgNode
virtual SgNode *	copy (SgCopyHelp &help) const
	This function clones the current IR node object recursively or not, depending on the argument. More...

void *	operator new (size_t size)
	returns pointer to newly allocated IR node More...

void	operator delete (void *pointer, size_t size)
	deallocated memory for IR node (returns memory to memory pool for reuse) More...

void	operator delete (void *pointer)

void	executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern. More...

	SgNode (const SgNodeStorageClass &source)

SgNode *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression. More...

void	set_isModified (bool isModified)
	All nodes in the AST contain a isModified flag used to track changes to the AST. More...

bool	get_isModified () const
	Acess function for isModified flag This flag records if the current IR node has been modified. It is set to false after and ROSE front-end processing. More...

void	set_parent (SgNode *parent)
	All nodes in the AST contain a reference to a parent node. More...

SgNode *	get_parent () const
	Access function for parent node. More...

bool	isChild (SgNode *node) const
	Query function for if the input IR nodes is a child of the current IR node. More...

virtual std::string	unparseToString (SgUnparse_Info *info) const
	This function unparses the AST node (excluding comments and unnecessary white space) More...

std::string	unparseToString () const

std::string	unparseToCompleteString ()
	This function unparses the AST node (including comments and white space) More...

int	variant () const ROSE_DEPRECATED_FUNCTION
	Older version function returns enum value "NODE". More...

virtual void	fixupCopy (SgNode *copy, SgCopyHelp &help) const

virtual Sg_File_Info *	get_file_info (void) const
	File information containing filename, line number, column number, and if the SgNode is a part of a new transformation, etc. More...

virtual Sg_File_Info *	get_startOfConstruct (void) const
	New function interface for Sg_File_Info data stores starting location of contruct (typically the opening brace or first letter of keyword). More...

virtual Sg_File_Info *	get_endOfConstruct (void) const
	New function interface for Sg_File_Info data stores ending location of contruct (typically the closing brace). More...

VirtualCFG::CFGNode	cfgForBeginning ()
	Returns the CFG node for just before this AST node. More...

VirtualCFG::CFGNode	cfgForEnd ()
	Returns the CFG node for just after this AST node. More...

virtual unsigned int	cfgIndexForEnd () const
	Determine the CFG index for the end of this construct. More...

virtual bool	cfgIsIndexInteresting (unsigned int index) const
	Determine whether a particular CFG node index is "interesting" for this kind of node. More...

virtual unsigned int	cfgFindChildIndex (SgNode *n)
	Find the index of n in this node's CFG children. More...

virtual unsigned int	cfgFindNextChildIndex (SgNode *n)
	Find the index just after n in this node's CFG children. More...

virtual std::vector < VirtualCFG::CFGEdge >	cfgOutEdges (unsigned int index=false)
	Find the out edges of a CFG node – internal version. More...

virtual std::vector < VirtualCFG::CFGEdge >	cfgInEdges (unsigned int index=false)
	Find the in edges of a CFG node – internal version. More...

int	numberOfNodesInSubtree ()
	Computes the number of nodes in the defined subtree of the AST. More...

int	depthOfSubtree ()
	Computes the depth of the current defined subtree of the AST. More...

SgNode *	get_freepointer () const

void	set_freepointer (SgNode *freepointer)

virtual	~SgNode ()
	This is the destructor. More...

	SgNode ()
	This is the constructor. More...

bool	get_isVisited () const ROSE_DEPRECATED_FUNCTION
	DOCS IN HEADER: Access function for p_isVisited flag used previously by the AST traversals. More...

void	set_isVisited (bool isVisited) ROSE_DEPRECATED_FUNCTION
	Access function for p_isVisited flag used previously by the AST traversals. More...

Static Public Member Functions
static size_t	numberOfNodes ()
	Returns the total number of IR nodes of this type. More...

static size_t	memoryUsage ()
	Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...

static void	traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for visitor pattern. More...

static void	traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern. More...

static void	visitRepresentativeNode (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for type-based traversal. More...

Static Public Member Functions inherited from SgNode
static size_t	numberOfNodes ()
	Returns the total number of IR nodes of this type. More...

static size_t	memoryUsage ()
	Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...

static void	traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for visitor pattern. More...

static void	traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern. More...

static void	visitRepresentativeNode (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for type-based traversal. More...

static std::vector< std::string >	buildCommandLineToSubstituteTransformationFile (const std::vector< std::string > &argv, std::string newFileName)
	Command line support for this compilation The command line is saved as a static variable so that it will be available to support the rewrite mechanism. More...

static std::vector< VariantT >	getClassHierarchySubTreeFunction (VariantT v)

static void	getClassHierarchySubTreeFunction (VariantT v, std::vector< VariantT > &)

static std::map< SgNode *, std::string > &	get_globalMangledNameMap ()
	Access function for performance optimizing global mangled name map. More...

static void	clearGlobalMangledNameMap ()
	Support to clear the performance optimizing global mangled name map. More...

static std::map< std::string, int > &	get_shortMangledNameCache ()
	Access function for lower level optimizing of global mangled name map. More...

static std::map< SgNode *, std::string > &	get_globalQualifiedNameMapForNames ()
	Access function for name qualification support (for names). More...

static void	set_globalQualifiedNameMapForNames (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for names). More...

static std::map< SgNode *, std::string > &	get_globalQualifiedNameMapForTypes ()
	Access function for name qualification support (for type). More...

static void	set_globalQualifiedNameMapForTypes (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for type). More...

static std::map< SgNode *, std::string > &	get_globalTypeNameMap ()
	Access function for name qualification support (for names of types). More...

static void	set_globalTypeNameMap (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for names of types). More...

static SgFunctionTypeTable *	get_globalFunctionTypeTable ()
	Access function for symbol table specific to function types. More...

static void	set_globalFunctionTypeTable (SgFunctionTypeTable *globalFunctionTypeTable)
	Access function for symbol table specific to function types. More...

static SgTypeTable *	get_globalTypeTable ()
	Access function for symbol table specific to non-function types. More...

static void	set_globalTypeTable (SgTypeTable *globalTypeTable)
	Access function for symbol table specific to non-function types. More...

Protected Attributes
AstAttributeMechanism *	p_attributeMechanism

Protected Attributes inherited from SgNode
SgNode *	p_parent
	This is the pointer to the parent IR node in the AST. More...

bool	p_isModified
	Records if IR node has been modified (data members reset). More...

SgNode *	p_freepointer
	This is the pointer to the chain of previously freed objects. More...

Friends
class	AST_FILE_IO

class	SgSymbolStorageClass

class	AstSpecificDataManagingClass

class	AstSpecificDataManagingClassStorageClass

ROSE_DLL_API friend SgSymbol *	isSgSymbol (SgNode *s)
	Casts pointer from base class to derived class. More...

ROSE_DLL_API friend const SgSymbol *	isSgSymbol (const SgNode *s)
	Casts pointer from base class to derived class (for const pointers) More...

SgSymbol *	SgSymbol_getPointerFromGlobalIndex (unsigned long globalIndex)
	Constructor for use by AST File I/O Mechanism. More...

unsigned long	SgSymbol_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
	Get the size of the memory pool. More...

void	SgSymbol_clearMemoryPool ()

void	SgSymbol_extendMemoryPoolForFileIO (unsigned long)

void	SgSymbol_getNextValidPointer (std::pair< SgSymbol , std::vector< unsigned char >::const_iterator > &)

void	SgSymbol_resetValidFreepointers ()

Additional Inherited Members
Protected Member Functions inherited from SgNode
virtual 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. More...

Static Protected Attributes inherited from SgNode
static SgFunctionTypeTable *	p_globalFunctionTypeTable
	Pointer to symbol table specific to function types. More...

static SgTypeTable *	p_globalTypeTable

static std::map< SgNode *, std::string >	p_globalMangledNameMap
	Cache of mangled names to avoid regeneration of previously build mangled names or parts of mangled names. This is a performance optimization. More...

static std::map< std::string, int >	p_shortMangledNameCache
	STL map used as a cache to shorten generated mangled names. This is mostly a space optimization ofr mangled names of templates. More...

static std::map< SgNode *, std::string >	p_globalQualifiedNameMapForNames

static std::map< SgNode *, std::string >	p_globalQualifiedNameMapForTypes

static std::map< SgNode *, std::string >	p_globalTypeNameMap

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 \n

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.

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

Definition at line 240632 of file Cxx_Grammar.h.

Member Typedef Documentation

typedef SgNode SgSymbol::base_node_type

Definition at line 241058 of file Cxx_Grammar.h.

Member Enumeration Documentation

anonymous enum

static variant value

Enumerator
static_variant

Definition at line 240746 of file Cxx_Grammar.h.

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.

This is a virtual function.

Returns: Returns SgName.

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

SgSymbol::get_type ( ) const

pure virtual

This function returns the type associated with the named entity.

This is a virtual function.

Returns: Returns SgType*.

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

virtual SgNode* SgSymbol::get_symbol_basis ( ) const

virtual

virtual SgScopeStatement* SgSymbol::get_scope ( ) const

virtual

Reimplemented in SgMemberFunctionSymbol.

SgName SgSymbol::get_mangled_name ( ) const

SgDeclarationStatement* SgSymbol::get_declaration ( ) const

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 SgJavaLabelSymbol, SgAsmBinaryDataSymbol, SgAsmBinaryAddressSymbol, SgAliasSymbol, SgCommonSymbol, SgInterfaceSymbol, SgModuleSymbol, SgIntrinsicSymbol, SgNamespaceSymbol, SgDefaultSymbol, SgLabelSymbol, SgTypedefSymbol, SgEnumFieldSymbol, SgEnumSymbol, SgTemplateSymbol, SgTemplateClassSymbol, SgClassSymbol, SgFunctionTypeSymbol, SgRenameSymbol, SgTemplateFunctionSymbol, SgTemplateMemberFunctionSymbol, SgMemberFunctionSymbol, SgFunctionSymbol, SgTemplateVariableSymbol, and SgVariableSymbol.

virtual VariantT SgSymbol::variantT ( ) const

virtual

returns new style SageIII enum values

Reimplemented from SgNode.

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

void* SgSymbol::operator new ( size_t size)

returns pointer to newly allocated IR node

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

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

void SgSymbol::operator delete ( void * pointer)

static size_t SgSymbol::numberOfNodes ( )

static

Returns the total number of IR nodes of this type.

static size_t SgSymbol::memoryUsage ( )

static

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

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 SgJavaLabelSymbol, SgAsmBinaryDataSymbol, SgAsmBinaryAddressSymbol, SgAliasSymbol, SgCommonSymbol, SgInterfaceSymbol, SgModuleSymbol, SgIntrinsicSymbol, SgNamespaceSymbol, SgDefaultSymbol, SgLabelSymbol, SgTypedefSymbol, SgEnumFieldSymbol, SgEnumSymbol, SgTemplateSymbol, SgTemplateClassSymbol, SgClassSymbol, SgFunctionTypeSymbol, SgRenameSymbol, SgTemplateFunctionSymbol, SgTemplateMemberFunctionSymbol, SgMemberFunctionSymbol, SgFunctionSymbol, SgTemplateVariableSymbol, and SgVariableSymbol.

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 SgJavaLabelSymbol, SgAsmBinaryDataSymbol, SgAsmBinaryAddressSymbol, SgAliasSymbol, SgCommonSymbol, SgInterfaceSymbol, SgModuleSymbol, SgIntrinsicSymbol, SgNamespaceSymbol, SgDefaultSymbol, SgLabelSymbol, SgTypedefSymbol, SgEnumFieldSymbol, SgEnumSymbol, SgTemplateSymbol, SgTemplateClassSymbol, SgClassSymbol, SgFunctionTypeSymbol, SgRenameSymbol, SgTemplateFunctionSymbol, SgTemplateMemberFunctionSymbol, SgMemberFunctionSymbol, SgFunctionSymbol, SgTemplateVariableSymbol, and SgVariableSymbol.

virtual size_t SgSymbol::get_numberOfTraversalSuccessors ( )

virtual

virtual SgNode* SgSymbol::get_traversalSuccessorByIndex ( size_t idx)

virtual

virtual size_t SgSymbol::get_childIndex ( SgNode * child)

virtual

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 SgJavaLabelSymbol, SgAsmBinaryDataSymbol, SgAsmBinaryAddressSymbol, SgAliasSymbol, SgCommonSymbol, SgInterfaceSymbol, SgModuleSymbol, SgIntrinsicSymbol, SgNamespaceSymbol, SgDefaultSymbol, SgLabelSymbol, SgTypedefSymbol, SgEnumFieldSymbol, SgEnumSymbol, SgTemplateSymbol, SgTemplateClassSymbol, SgClassSymbol, SgFunctionTypeSymbol, SgRenameSymbol, SgTemplateFunctionSymbol, SgTemplateMemberFunctionSymbol, SgMemberFunctionSymbol, SgFunctionSymbol, SgTemplateVariableSymbol, and SgVariableSymbol.

virtual const char* SgSymbol::sage_class_name ( ) const

virtual

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

Reimplemented from SgNode.

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

void SgSymbol::executeVisitorMemberFunction ( ROSE_VisitorPattern & visitor)

FOR INTERNAL USE Support for visitor pattern.

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 SgJavaLabelSymbol, SgAsmBinaryDataSymbol, SgAsmBinaryAddressSymbol, SgAliasSymbol, SgCommonSymbol, SgInterfaceSymbol, SgModuleSymbol, SgIntrinsicSymbol, SgNamespaceSymbol, SgDefaultSymbol, SgLabelSymbol, SgTypedefSymbol, SgEnumFieldSymbol, SgEnumSymbol, SgTemplateSymbol, SgTemplateClassSymbol, SgClassSymbol, SgFunctionTypeSymbol, SgRenameSymbol, SgTemplateFunctionSymbol, SgTemplateMemberFunctionSymbol, SgMemberFunctionSymbol, SgFunctionSymbol, SgTemplateVariableSymbol, and SgVariableSymbol.

static void SgSymbol::traverseMemoryPoolNodes ( ROSE_VisitTraversal & visit)

static

FOR INTERNAL USE Support for visitor pattern.

static void SgSymbol::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern & visitor)

static

FOR INTERNAL USE Support for visitor pattern.

static void SgSymbol::visitRepresentativeNode ( ROSE_VisitTraversal & visit)

static

FOR INTERNAL USE Support for type-based traversal.

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 SgJavaLabelSymbol, SgAsmBinaryDataSymbol, SgAsmBinaryAddressSymbol, SgAliasSymbol, SgCommonSymbol, SgInterfaceSymbol, SgModuleSymbol, SgIntrinsicSymbol, SgNamespaceSymbol, SgDefaultSymbol, SgLabelSymbol, SgTypedefSymbol, SgEnumFieldSymbol, SgEnumSymbol, SgTemplateSymbol, SgTemplateClassSymbol, SgClassSymbol, SgFunctionTypeSymbol, SgRenameSymbol, SgTemplateFunctionSymbol, SgTemplateMemberFunctionSymbol, SgMemberFunctionSymbol, SgFunctionSymbol, SgTemplateVariableSymbol, and SgVariableSymbol.

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 SgJavaLabelSymbol, SgAsmBinaryDataSymbol, SgAsmBinaryAddressSymbol, SgAliasSymbol, SgCommonSymbol, SgInterfaceSymbol, SgModuleSymbol, SgIntrinsicSymbol, SgNamespaceSymbol, SgDefaultSymbol, SgLabelSymbol, SgTypedefSymbol, SgEnumFieldSymbol, SgEnumSymbol, SgTemplateSymbol, SgTemplateClassSymbol, SgClassSymbol, SgFunctionTypeSymbol, SgRenameSymbol, SgTemplateFunctionSymbol, SgTemplateMemberFunctionSymbol, SgMemberFunctionSymbol, SgFunctionSymbol, SgTemplateVariableSymbol, and SgVariableSymbol.

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 SgJavaLabelSymbol, SgAsmBinaryDataSymbol, SgAsmBinaryAddressSymbol, SgAliasSymbol, SgCommonSymbol, SgInterfaceSymbol, SgModuleSymbol, SgIntrinsicSymbol, SgNamespaceSymbol, SgDefaultSymbol, SgLabelSymbol, SgTypedefSymbol, SgEnumFieldSymbol, SgEnumSymbol, SgTemplateSymbol, SgTemplateClassSymbol, SgClassSymbol, SgFunctionTypeSymbol, SgRenameSymbol, SgTemplateFunctionSymbol, SgTemplateMemberFunctionSymbol, SgMemberFunctionSymbol, SgFunctionSymbol, SgTemplateVariableSymbol, and SgVariableSymbol.

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 SgJavaLabelSymbol, SgAsmBinaryDataSymbol, SgAsmBinaryAddressSymbol, SgAliasSymbol, SgCommonSymbol, SgInterfaceSymbol, SgModuleSymbol, SgIntrinsicSymbol, SgNamespaceSymbol, SgDefaultSymbol, SgLabelSymbol, SgTypedefSymbol, SgEnumFieldSymbol, SgEnumSymbol, SgTemplateSymbol, SgTemplateClassSymbol, SgClassSymbol, SgFunctionTypeSymbol, SgRenameSymbol, SgTemplateFunctionSymbol, SgTemplateMemberFunctionSymbol, SgMemberFunctionSymbol, SgFunctionSymbol, SgTemplateVariableSymbol, and SgVariableSymbol.

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 SgJavaLabelSymbol, SgAsmBinaryDataSymbol, SgAsmBinaryAddressSymbol, SgAliasSymbol, SgCommonSymbol, SgInterfaceSymbol, SgModuleSymbol, SgIntrinsicSymbol, SgNamespaceSymbol, SgDefaultSymbol, SgLabelSymbol, SgTypedefSymbol, SgEnumFieldSymbol, SgEnumSymbol, SgTemplateSymbol, SgTemplateClassSymbol, SgClassSymbol, SgFunctionTypeSymbol, SgRenameSymbol, SgTemplateFunctionSymbol, SgTemplateMemberFunctionSymbol, SgMemberFunctionSymbol, SgFunctionSymbol, SgTemplateVariableSymbol, and SgVariableSymbol.

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.

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

Definition at line 241017 of file Cxx_Grammar.h.

friend class SgSymbolStorageClass

friend

Definition at line 241018 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClass

friend

Definition at line 241019 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClassStorageClass

friend

Definition at line 241020 of file Cxx_Grammar.h.

SgSymbol::isSgSymbol ( SgNode * s)

friend

Casts pointer from base class to derived class.

Cast function (from derived class to SgSymbol pointer).

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)

Cast function (from derived class to SgSymbol pointer).

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 Mechanism.

This constructor permits the IR node to be rebuilt from the contiguously arranged data in memory which obtained via fast binary file I/O from disk.

Typedef 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

Definition at line 241077 of file Cxx_Grammar.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation