SgGraphEdge Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgGraphEdge:

[legend]Collaboration diagram for SgGraphEdge:


Public Types
	static_variant = V_SgGraphEdge
enum	{ static_variant = V_SgGraphEdge }
	static variant value More...
Public Member Functions
virtual SgNode *	copy (SgCopyHelp &help) const
void	append_properties (int addr, const std::string &prop)
void	post_construction_initialization ()
	Final initializaion for constructors This function is called at the end of generated constructors to allow the specification writer to add special initialization functions or tests. Default is to do nothing. Otherwise it should be overridden in the spec file, in NewHeaderCode/NewOutlinedCode.
virtual 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 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.
	SgGraphEdge (const SgGraphEdgeStorageClass &source)
SgGraphEdge *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression.
SgGraphNode *	get_node_A () const
void	set_node_A (SgGraphNode *node_A)
SgGraphNode *	get_node_B () const
void	set_node_B (SgGraphNode *node_B)
std::string	get_name () const
void	set_name (std::string name)
int	get_index () const
void	set_index (int index)
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.
const std::map< int, std::string > &	get_properties () const
std::map< int, std::string > &	get_properties ()
virtual	~SgGraphEdge ()
	SgGraphEdge (SgGraphNode node_A=NULL, SgGraphNode node_B=NULL, std::string name="")
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
SgGraphNode *	p_node_A
SgGraphNode *	p_node_B
std::string	p_name
int	p_index
AstAttributeMechanism *	p_attributeMechanism
std::map< int, std::string >	p_properties
Static Protected Attributes
static int	p_index_counter
Friends
class	AST_FILE_IO
class	SgGraphEdgeStorageClass
class	AstSpecificDataManagingClass
class	AstSpecificDataManagingClassStorageClass
SgGraphEdge *	isSgGraphEdge (SgNode *s)
	Casts pointer from base class to derived class.
const SgGraphEdge *	isSgGraphEdge (const SgNode *s)
	Casts pointer from base class to derived class (for const pointers).
SgGraphEdge *	SgGraphEdge_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	SgGraphEdge_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
	Get the size of the memory pool.
void	SgGraphEdge_clearMemoryPool ()
void	SgGraphEdge_extendMemoryPoolForFileIO (unsigned long)
void	SgGraphEdge_getNextValidPointer (std::pair< SgGraphEdge , std::vector< unsigned char >::const_iterator > &)
void	SgGraphEdge_resetValidFreepointers ()

Member Enumeration Documentation

anonymous enum

static variant value

Enumerator:

static_variant

Constructor & Destructor Documentation

SgGraphEdge::SgGraphEdge ( const SgGraphEdgeStorageClass & source )

virtual SgGraphEdge::~SgGraphEdge ( ) [virtual]

SgGraphEdge::SgGraphEdge	(	SgGraphNode *	node_A = `NULL`,
		SgGraphNode *	node_B = `NULL`,
		std::string	name = `""`
	)

Member Function Documentation

virtual SgNode* SgGraphEdge::copy ( SgCopyHelp & help ) const [virtual]

Reimplemented from SgSupport.

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

void SgGraphEdge::append_properties	(	int	addr,
		const std::string &	prop
	)

void SgGraphEdge::post_construction_initialization ( ) [virtual]

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

Reimplemented from SgNode.

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

Add a new attribute represented by the named string.

Reimplemented from SgNode.

virtual AstAttribute* SgGraphEdge::getAttribute ( std::string s ) const [virtual]

Returns attribute of name 's'.

Reimplemented from SgNode.

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

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

Reimplemented from SgNode.

virtual void SgGraphEdge::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 SgGraphEdge::removeAttribute ( std::string s ) [virtual]

Remove attribute of name 's' if present.

Reimplemented from SgNode.

virtual bool SgGraphEdge::attributeExists ( std::string s ) const [virtual]

Tests if attribute of name 's' is present.

Reimplemented from SgNode.

virtual int SgGraphEdge::numberOfAttributes ( ) const [virtual]

Returns the number of attributes on this IR node.

Reimplemented from SgNode.

virtual std::string SgGraphEdge::class_name ( ) const [virtual]

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

Reimplemented from SgSupport.

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

virtual VariantT SgGraphEdge::variantT ( ) const [virtual]

returns new style SageIII enum values

Reimplemented from SgSupport.

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

void* SgGraphEdge::operator new ( size_t size )

returns pointer to newly allocated IR node

Reimplemented from SgSupport.

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

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

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

Reimplemented from SgSupport.

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

void SgGraphEdge::operator delete ( void * pointer )

Reimplemented from SgSupport.

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

static size_t SgGraphEdge::numberOfNodes ( ) [static]

Returns the total number of IR nodes of this type.

Reimplemented from SgSupport.

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

static size_t SgGraphEdge::memoryUsage ( ) [static]

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

Reimplemented from SgSupport.

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

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

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

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

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

virtual size_t SgGraphEdge::get_numberOfTraversalSuccessors ( ) [virtual]

Reimplemented from SgSupport.

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

virtual SgNode* SgGraphEdge::get_traversalSuccessorByIndex ( size_t idx ) [virtual]

Reimplemented from SgSupport.

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

virtual size_t SgGraphEdge::get_childIndex ( SgNode * child ) [virtual]

Reimplemented from SgSupport.

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

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

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

virtual const char* SgGraphEdge::sage_class_name ( ) const [virtual]

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

Reimplemented from SgSupport.

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

void SgGraphEdge::executeVisitorMemberFunction ( ROSE_VisitorPattern & visitor )

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgSupport.

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

static void SgGraphEdge::traverseMemoryPoolNodes ( ROSE_VisitTraversal & visit ) [static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgSupport.

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

static void SgGraphEdge::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern & visitor ) [static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgSupport.

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

static void SgGraphEdge::visitRepresentativeNode ( ROSE_VisitTraversal & visit ) [static]

FOR INTERNAL USE Support for type-based traversal.

Reimplemented from SgSupport.

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

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

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

virtual void SgGraphEdge::checkDataMemberPointersIfInMemoryPool ( ) [virtual]

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

Reimplemented from SgSupport.

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

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

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

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

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

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

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

SgGraphEdge* SgGraphEdge::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.

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

SgGraphNode* SgGraphEdge::get_node_A ( ) const

void SgGraphEdge::set_node_A ( SgGraphNode * node_A )

SgGraphNode* SgGraphEdge::get_node_B ( ) const

void SgGraphEdge::set_node_B ( SgGraphNode * node_B )

std::string SgGraphEdge::get_name ( ) const

void SgGraphEdge::set_name ( std::string name )

int SgGraphEdge::get_index ( ) const

void SgGraphEdge::set_index ( int index )

AstAttributeMechanism * SgGraphEdge::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 SgGraphEdge::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.

const std::map<int, std::string>& SgGraphEdge::get_properties ( ) const

std::map<int, std::string>& SgGraphEdge::get_properties ( )

Friends And Related Function Documentation

friend class AST_FILE_IO [friend]

Reimplemented from SgSupport.

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

friend class SgGraphEdgeStorageClass [friend]

friend class AstSpecificDataManagingClass [friend]

Reimplemented from SgSupport.

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

friend class AstSpecificDataManagingClassStorageClass [friend]

Reimplemented from SgSupport.

Reimplemented in SgDirectedGraphEdge, and SgUndirectedGraphEdge.

SgGraphEdge* isSgGraphEdge ( SgNode * s ) [friend]

Casts pointer from base class to derived class.

const SgGraphEdge* isSgGraphEdge ( const SgNode * s ) [friend]

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

SgGraphEdge* SgGraphEdge_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 SgGraphEdge_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 SgGraphEdge_clearMemoryPool ( ) [friend]