#include <Cxx_Grammar.h>

Inheritance diagram for SgGraph:

Collaboration diagram for SgGraph:

Public Types
enum	GraphEdgeType { e_type_error, none, cfg, usage, e_last_type }
	Edge Type. More...

enum	GraphProperties { e_property_error, name, type, nodest_jmp, itself_call, nodest_call, interrupt, eval, regs, done, dfa_standard, dfa_resolved_func, dfa_unresolved_func, dfa_variable, dfa_conditional_def, edgeLabel, visitedCounter, variable, dfa_bufferoverflow, e_last_property }
	Graph Properties. More...

enum	{ static_variant = V_SgGraph }
	static variant value More...

typedef std::pair< int, int >	BoostEdgeType
	Simple edge type used to input data to Boost algorithms. More...

typedef std::vector < BoostEdgeType >	SgBoostEdgeList

typedef std::vector< int >	SgBoostEdgeWeightList

typedef SgSupport	base_node_type

Public Types inherited from SgSupport
enum	{ static_variant = V_SgSupport }
	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 SgNode *	copy (SgCopyHelp &help) const
	This function clones the current IR node object recursively or not, depending on the argument. More...

int	hashCode (const char *p, int len) const

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

SgGraphNode *	addNode (const std::string &name="", SgNode *sg_node=NULL)
	Support for adding SgGraphNode to SgGraph. More...

SgGraphNode *	addNode (SgGraphNode *node)
	Add support for externally build SgGraphNode objects. More...

SgGraphEdge *	addEdge (SgGraphNode a, SgGraphNode b, const std::string &name="")
	Support for adding SgGraphEdge to SgGraph. More...

SgGraphEdge *	addEdge (SgGraphEdge *edge)
	Add support for externally build SgGraphNode objects. More...

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

std::vector< SgGraphEdge * >	generateSpanningTree ()
	Support for Boost Minimum Spanning Tree. More...

std::string	getProperty (SgGraph::GraphProperties property, SgGraphNode *node)

std::string	getProperty (SgGraph::GraphProperties property, SgGraphEdge *edge)

void	setProperty (SgGraph::GraphProperties property, SgGraphNode *node, std::string value)

void	setProperty (SgGraph::GraphProperties property, SgGraphEdge *edge, std::string value)

void	checkIfGraphNodeExists (const std::string &trg_mnemonic, std::vector< SgGraphNode * > &nodes)

bool	exists (SgGraphNode *node)
	Check if the node is present in the graph. More...

bool	exists (SgGraphEdge *edge)
	Check if the edge is present in the graph. More...

std::set< SgGraphEdge * >	computeEdgeSet (SgGraphNode *node)
	Builds a set of edges that are associated with a specific node. More...

std::set< int >	computeEdgeSet (int node_index)
	Integer index version of "std::set<SgGraphEdge> computeEdgeSet( SgGraphNode node );". More...

std::set< std::pair< int, int > >	computeNodeIndexPairSet (int node_index)
	Build set of node index pairs associated with node index (one of the value of the pair will be equal to the input node_index). More...

std::set< SgGraphNode * >	computeNodeSet (const std::string &label)
	Builds a set of node index values associated with a label. More...

std::set< SgGraphNode * >	computeNodeSet ()
	Builds a set of all nodes in the graph. More...

std::set< int >	computeNodeIndexSet (const std::string &label)
	Integer index version of "std::set<SgGraphNode*> computeNodeSet( const std::string & label );". More...

size_t	numberOfGraphNodes () const

size_t	numberOfGraphEdges () const

void	display_node_index_to_edge_multimap () const

void	display_node_index_to_node_map () const

void	display_edge_index_to_edge_map () const

void	display_node_index_pair_to_edge_multimap () const

void	display_string_to_node_index_multimap () const

void	display_string_to_edge_index_multimap () const

void	resize_hash_maps (size_t numberOfNodes, size_t numberOfEdges=10)
	Resize the internal hash tables based on the number of nodes (hash_maps and hash_multimaps for edges are made larger by multiplying by the value "numberOfEdges" ). More...

size_t	memory_usage ()
	Report the size in bytes of the graph (includes all edges and ndes from all hash_maps and hash_multimaps). More...

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

	SgGraph (const SgGraphStorageClass &source)

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

std::string	get_name () const

void	set_name (std::string name)

const rose_graph_integer_node_hash_map &	get_node_index_to_node_map () const

rose_graph_integer_node_hash_map &	get_node_index_to_node_map ()

const rose_graph_integer_edge_hash_map &	get_edge_index_to_edge_map () const

rose_graph_integer_edge_hash_map &	get_edge_index_to_edge_map ()

const rose_graph_integerpair_edge_hash_multimap &	get_node_index_pair_to_edge_multimap () const

rose_graph_integerpair_edge_hash_multimap &	get_node_index_pair_to_edge_multimap ()

const rose_graph_string_integer_hash_multimap &	get_string_to_node_index_multimap () const

rose_graph_string_integer_hash_multimap &	get_string_to_node_index_multimap ()

const rose_graph_string_integer_hash_multimap &	get_string_to_edge_index_multimap () const

rose_graph_string_integer_hash_multimap &	get_string_to_edge_index_multimap ()

const rose_graph_integer_edge_hash_multimap &	get_node_index_to_edge_multimap () const

rose_graph_integer_edge_hash_multimap &	get_node_index_to_edge_multimap ()

int	get_index () const

void	set_index (int index)

const SgBoostEdgeList &	get_boost_edges () const

SgBoostEdgeList &	get_boost_edges ()

const SgBoostEdgeWeightList &	get_boost_edge_weights () const

SgBoostEdgeWeightList &	get_boost_edge_weights ()

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

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

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

virtual	~SgGraph ()

	SgGraph (std::string name="")

Public Member Functions inherited from SgSupport
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...

	SgSupport (const SgSupportStorageClass &source)

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

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

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

Public Member Functions inherited from SgNode
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 SgSupport
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...

Static Protected Attributes
static int	p_index_counter

Friends
class	AST_FILE_IO

class	SgGraphStorageClass

class	AstSpecificDataManagingClass

class	AstSpecificDataManagingClassStorageClass

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

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

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

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

void	SgGraph_clearMemoryPool ()

void	SgGraph_extendMemoryPoolForFileIO (unsigned long)

void	SgGraph_getNextValidPointer (std::pair< SgGraph , std::vector< unsigned char >::const_iterator > &)

void	SgGraph_resetValidFreepointers ()

Detailed Description

Doxygen documentation for graph class (should maybe be put with the rest of the

doxygen documentation in docs/testDoxygen directory instead).

Definition at line 32090 of file Cxx_Grammar.h.

Member Typedef Documentation

typedef std::pair<int, int> SgGraph::BoostEdgeType

Simple edge type used to input data to Boost algorithms.

Definition at line 32163 of file Cxx_Grammar.h.

typedef std::vector<BoostEdgeType> SgGraph::SgBoostEdgeList

Definition at line 32168 of file Cxx_Grammar.h.

typedef std::vector<int> SgGraph::SgBoostEdgeWeightList

Definition at line 32172 of file Cxx_Grammar.h.

typedef SgSupport SgGraph::base_node_type

Definition at line 32658 of file Cxx_Grammar.h.

Member Enumeration Documentation

enum SgGraph::GraphEdgeType

Edge Type.

Values used to indicate types of edges used for program analysis.

Enumerator
e_type_error	error value
none	none ???
cfg	edge used for Control Flow Graph
usage	usage???
e_last_type	last value (unused, serves as upper bound on values)

Definition at line 32106 of file Cxx_Grammar.h.

enum SgGraph::GraphProperties

Graph Properties.

Values used to indicate types of graphs used for program analysis.

Enumerator
e_property_error	error value
name	name of the node
type	name of the node
nodest_jmp	this a jump without dest
itself_call	this call calls itself
nodest_call	call without dest
interrupt	interrupt (int)
eval	dfa : evaluation
regs	dfa : registers
done	dfa : indicates that this node has successfully been visited
dfa_standard	dfa_standard_node color
dfa_resolved_func	a function that has been resolved by dfa
dfa_unresolved_func	a function that cant be resolved by dfa
dfa_variable	defines the variable found by dfa
dfa_conditional_def	specifies the nodes that are defines but also conditional instructions
edgeLabel	???
visitedCounter	counts the amount of a node being visited during dfa
variable	stores the string of the variable
dfa_bufferoverflow	indicates buffer overflow
e_last_property	last value (unused, serves as upper bound on values)

Definition at line 32120 of file Cxx_Grammar.h.

anonymous enum

static variant value

Enumerator
static_variant

Definition at line 32346 of file Cxx_Grammar.h.

Constructor & Destructor Documentation

SgGraph::SgGraph ( const SgGraphStorageClass & source)

virtual SgGraph::~SgGraph ( )

virtual

SgGraph::SgGraph ( std::string name = "")

Member Function Documentation

virtual SgNode* SgGraph::copy ( SgCopyHelp & help) const

virtual

This function clones the current IR node object recursively or not, depending on the argument.

This function performs a copy based on the specification of the input parameter. The input parameter is used to determin which data members are copied by reference and which are copied by value.

Parameters

help	- If this argument is of type SgTreeCopy, then the IR node is cloned recursively. If its of type SgShallowCopy only the first level of the IR node is copied, everything else is left pointing to the the original IR node's object's data members.

Returns: a pointer to the new clone.

It appears the the copy functions don't set the parents of anything that they do a deep copy of! This can cause AST tests to fail. In particular some functions that require the parent pointers to be valid will return NULL pointers (e.g. SgInitializedName::get_declaration()). It might be that we should allow this to be done as part of the SgCopyHelp::clone function or perhaps another member function of SgCopyHelp would be useful for this support. It is not serious if the AST post processing is done since that will set any NULL pointers that are found within its traversal.

Exceptions

none	No exceptions are thrown by this function.

Reimplemented from SgSupport.

Reimplemented in SgIncidenceUndirectedGraph, SgIntKeyedBidirectionalGraph, SgStringKeyedBidirectionalGraph, SgBidirectionalGraph, and SgIncidenceDirectedGraph.

int SgGraph::hashCode	(	const char *	p,
		int	len
	)		const

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

SgGraphNode* SgGraph::addNode	(	const std::string &	name = `""`,
		SgNode *	sg_node = `NULL`
	)

Support for adding SgGraphNode to SgGraph.

Referenced by CallGraphBuilder::buildCallGraph().

SgGraphNode* SgGraph::addNode ( SgGraphNode * node)

Add support for externally build SgGraphNode objects.

SgGraphEdge* SgGraph::addEdge	(	SgGraphNode *	a,
		SgGraphNode *	b,
		const std::string &	name = `""`
	)

Support for adding SgGraphEdge to SgGraph.

SgGraphEdge* SgGraph::addEdge ( SgGraphEdge * edge)

Add support for externally build SgGraphNode objects.

void SgGraph::post_construction_initialization ( )

virtual

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

Reimplemented from SgNode.

Reimplemented in SgIncidenceDirectedGraph.

std::vector<SgGraphEdge*> SgGraph::generateSpanningTree ( )

Support for Boost Minimum Spanning Tree.

std::string SgGraph::getProperty	(	SgGraph::GraphProperties	property,
		SgGraphNode *	node
	)

std::string SgGraph::getProperty	(	SgGraph::GraphProperties	property,
		SgGraphEdge *	edge
	)

void SgGraph::setProperty	(	SgGraph::GraphProperties	property,
		SgGraphNode *	node,
		std::string	value
	)

void SgGraph::setProperty	(	SgGraph::GraphProperties	property,
		SgGraphEdge *	edge,
		std::string	value
	)

void SgGraph::checkIfGraphNodeExists	(	const std::string &	trg_mnemonic,
		std::vector< SgGraphNode * > &	nodes
	)

bool SgGraph::exists ( SgGraphNode * node)

Check if the node is present in the graph.

bool SgGraph::exists ( SgGraphEdge * edge)

Check if the edge is present in the graph.

std::set<SgGraphEdge*> SgGraph::computeEdgeSet ( SgGraphNode * node)

Builds a set of edges that are associated with a specific node.

std::set<int> SgGraph::computeEdgeSet ( int node_index)

Integer index version of "std::set<SgGraphEdge*> computeEdgeSet( SgGraphNode* node );".

std::set< std::pair<int,int> > SgGraph::computeNodeIndexPairSet ( int node_index)

Build set of node index pairs associated with node index (one of the value of the pair will be equal to the input node_index).

std::set<SgGraphNode*> SgGraph::computeNodeSet ( const std::string & label)

Builds a set of node index values associated with a label.

std::set<SgGraphNode*> SgGraph::computeNodeSet ( )

Builds a set of all nodes in the graph.

std::set<int> SgGraph::computeNodeIndexSet ( const std::string & label)

Integer index version of "std::set<SgGraphNode*> computeNodeSet( const std::string & label );".

size_t SgGraph::numberOfGraphNodes ( ) const

size_t SgGraph::numberOfGraphEdges ( ) const

void SgGraph::display_node_index_to_edge_multimap ( ) const

void SgGraph::display_node_index_to_node_map ( ) const

void SgGraph::display_edge_index_to_edge_map ( ) const

void SgGraph::display_node_index_pair_to_edge_multimap ( ) const

void SgGraph::display_string_to_node_index_multimap ( ) const

void SgGraph::display_string_to_edge_index_multimap ( ) const

void SgGraph::resize_hash_maps	(	size_t	numberOfNodes,
		size_t	numberOfEdges = `10`
	)

Resize the internal hash tables based on the number of nodes (hash_maps and hash_multimaps for edges are made larger by multiplying by the value "numberOfEdges" ).

size_t SgGraph::memory_usage ( )

Report the size in bytes of the graph (includes all edges and ndes from all hash_maps and hash_multimaps).

virtual void SgGraph::addNewAttribute	(	std::string	s,
		AstAttribute *	a
	)

virtual

Add a new attribute represented by the named string.

Reimplemented from SgNode.

virtual AstAttribute* SgGraph::getAttribute ( std::string s) const

virtual

Returns attribute of name 's'.

Reimplemented from SgNode.

virtual void SgGraph::updateAttribute	(	std::string	s,
		AstAttribute *	a
	)

virtual

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

Reimplemented from SgNode.

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

virtual

Remove attribute of name 's' if present.

Reimplemented from SgNode.

virtual bool SgGraph::attributeExists ( std::string s) const

virtual

Tests if attribute of name 's' is present.

Reimplemented from SgNode.

virtual int SgGraph::numberOfAttributes ( ) const

virtual

Returns the number of attributes on this IR node.

Reimplemented from SgNode.

virtual std::string SgGraph::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 SgIncidenceUndirectedGraph, SgIntKeyedBidirectionalGraph, SgStringKeyedBidirectionalGraph, SgBidirectionalGraph, and SgIncidenceDirectedGraph.

virtual VariantT SgGraph::variantT ( ) const

virtual

returns new style SageIII enum values

Reimplemented from SgSupport.

Reimplemented in SgIncidenceUndirectedGraph, SgIntKeyedBidirectionalGraph, SgStringKeyedBidirectionalGraph, SgBidirectionalGraph, and SgIncidenceDirectedGraph.

void* SgGraph::operator new ( size_t size)

returns pointer to newly allocated IR node

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

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

void SgGraph::operator delete ( void * pointer)

static size_t SgGraph::numberOfNodes ( )

static

Returns the total number of IR nodes of this type.

static size_t SgGraph::memoryUsage ( )

static

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

virtual std::vector<SgNode*> SgGraph::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 SgIncidenceUndirectedGraph, SgIntKeyedBidirectionalGraph, SgStringKeyedBidirectionalGraph, SgBidirectionalGraph, and SgIncidenceDirectedGraph.

virtual std::vector<std::string> SgGraph::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 SgIncidenceUndirectedGraph, SgIntKeyedBidirectionalGraph, SgStringKeyedBidirectionalGraph, SgBidirectionalGraph, and SgIncidenceDirectedGraph.

virtual size_t SgGraph::get_numberOfTraversalSuccessors ( )

virtual

Reimplemented from SgSupport.

Reimplemented in SgIncidenceUndirectedGraph, SgIntKeyedBidirectionalGraph, SgStringKeyedBidirectionalGraph, SgBidirectionalGraph, and SgIncidenceDirectedGraph.

virtual SgNode* SgGraph::get_traversalSuccessorByIndex ( size_t idx)

virtual

Reimplemented from SgSupport.

Reimplemented in SgIncidenceUndirectedGraph, SgIntKeyedBidirectionalGraph, SgStringKeyedBidirectionalGraph, SgBidirectionalGraph, and SgIncidenceDirectedGraph.

virtual size_t SgGraph::get_childIndex ( SgNode * child)

virtual

Reimplemented from SgSupport.

Reimplemented in SgIncidenceUndirectedGraph, SgIntKeyedBidirectionalGraph, SgStringKeyedBidirectionalGraph, SgBidirectionalGraph, and SgIncidenceDirectedGraph.

virtual RTIReturnType SgGraph::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 SgIncidenceUndirectedGraph, SgIntKeyedBidirectionalGraph, SgStringKeyedBidirectionalGraph, SgBidirectionalGraph, and SgIncidenceDirectedGraph.

virtual const char* SgGraph::sage_class_name ( ) const

virtual

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

Reimplemented from SgSupport.

Reimplemented in SgIncidenceUndirectedGraph, SgIntKeyedBidirectionalGraph, SgStringKeyedBidirectionalGraph, SgBidirectionalGraph, and SgIncidenceDirectedGraph.

void SgGraph::executeVisitorMemberFunction ( ROSE_VisitorPattern & visitor)

FOR INTERNAL USE Support for visitor pattern.

virtual void SgGraph::accept ( ROSE_VisitorPattern & visitor)

virtual

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

Reimplemented from SgSupport.

Reimplemented in SgIncidenceUndirectedGraph, SgIntKeyedBidirectionalGraph, SgStringKeyedBidirectionalGraph, SgBidirectionalGraph, and SgIncidenceDirectedGraph.

static void SgGraph::traverseMemoryPoolNodes ( ROSE_VisitTraversal & visit)

static

FOR INTERNAL USE Support for visitor pattern.

static void SgGraph::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern & visitor)

static

FOR INTERNAL USE Support for visitor pattern.

static void SgGraph::visitRepresentativeNode ( ROSE_VisitTraversal & visit)

static

FOR INTERNAL USE Support for type-based traversal.

virtual bool SgGraph::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 SgIncidenceUndirectedGraph, SgIntKeyedBidirectionalGraph, SgStringKeyedBidirectionalGraph, SgBidirectionalGraph, and SgIncidenceDirectedGraph.

virtual void SgGraph::checkDataMemberPointersIfInMemoryPool ( )

virtual

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

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

Reimplemented from SgSupport.

Reimplemented in SgIncidenceUndirectedGraph, SgIntKeyedBidirectionalGraph, SgStringKeyedBidirectionalGraph, SgBidirectionalGraph, and SgIncidenceDirectedGraph.

virtual std::vector<std::pair<SgNode*,std::string> > SgGraph::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 SgIncidenceUndirectedGraph, SgIntKeyedBidirectionalGraph, SgStringKeyedBidirectionalGraph, SgBidirectionalGraph, and SgIncidenceDirectedGraph.

virtual void SgGraph::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 SgIncidenceUndirectedGraph, SgIntKeyedBidirectionalGraph, SgStringKeyedBidirectionalGraph, SgBidirectionalGraph, and SgIncidenceDirectedGraph.

virtual long SgGraph::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 SgIncidenceUndirectedGraph, SgIntKeyedBidirectionalGraph, SgStringKeyedBidirectionalGraph, SgBidirectionalGraph, and SgIncidenceDirectedGraph.

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

std::string SgGraph::get_name ( ) const

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

const rose_graph_integer_node_hash_map& SgGraph::get_node_index_to_node_map ( ) const

rose_graph_integer_node_hash_map& SgGraph::get_node_index_to_node_map ( )

const rose_graph_integer_edge_hash_map& SgGraph::get_edge_index_to_edge_map ( ) const

rose_graph_integer_edge_hash_map& SgGraph::get_edge_index_to_edge_map ( )

const rose_graph_integerpair_edge_hash_multimap& SgGraph::get_node_index_pair_to_edge_multimap ( ) const

rose_graph_integerpair_edge_hash_multimap& SgGraph::get_node_index_pair_to_edge_multimap ( )

const rose_graph_string_integer_hash_multimap& SgGraph::get_string_to_node_index_multimap ( ) const

rose_graph_string_integer_hash_multimap& SgGraph::get_string_to_node_index_multimap ( )

const rose_graph_string_integer_hash_multimap& SgGraph::get_string_to_edge_index_multimap ( ) const

rose_graph_string_integer_hash_multimap& SgGraph::get_string_to_edge_index_multimap ( )

const rose_graph_integer_edge_hash_multimap& SgGraph::get_node_index_to_edge_multimap ( ) const

rose_graph_integer_edge_hash_multimap& SgGraph::get_node_index_to_edge_multimap ( )

int SgGraph::get_index ( ) const

void SgGraph::set_index ( int index)

const SgBoostEdgeList& SgGraph::get_boost_edges ( ) const

SgBoostEdgeList& SgGraph::get_boost_edges ( )

const SgBoostEdgeWeightList& SgGraph::get_boost_edge_weights ( ) const

SgBoostEdgeWeightList& SgGraph::get_boost_edge_weights ( )

AstAttributeMechanism * SgGraph::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 SgGraph::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>& SgGraph::get_properties ( ) const

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

Friends And Related Function Documentation

friend class AST_FILE_IO

friend

Definition at line 32617 of file Cxx_Grammar.h.

friend class SgGraphStorageClass

friend

Definition at line 32618 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClass

friend

Definition at line 32619 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClassStorageClass

friend

Definition at line 32620 of file Cxx_Grammar.h.

ROSE_DLL_API friend SgGraph* isSgGraph ( SgNode * s)

friend

Casts pointer from base class to derived class.

ROSE_DLL_API friend const SgGraph* isSgGraph ( const SgNode * s)

friend

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

SgGraph* SgGraph_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 SgGraph_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 SgGraph_clearMemoryPool ( )

friend

void SgGraph_extendMemoryPoolForFileIO ( unsigned long)

friend

void SgGraph_getNextValidPointer ( std::pair< SgGraph *, std::vector< unsigned char * >::const_iterator > & )

friend

void SgGraph_resetValidFreepointers ( )

friend

Member Data Documentation

std::string SgGraph::p_name

protected

Definition at line 32722 of file Cxx_Grammar.h.

rose_graph_integer_node_hash_map SgGraph::p_node_index_to_node_map

protected

Definition at line 32726 of file Cxx_Grammar.h.

rose_graph_integer_edge_hash_map SgGraph::p_edge_index_to_edge_map

protected

Definition at line 32730 of file Cxx_Grammar.h.

rose_graph_integerpair_edge_hash_multimap SgGraph::p_node_index_pair_to_edge_multimap

protected

Definition at line 32734 of file Cxx_Grammar.h.

rose_graph_string_integer_hash_multimap SgGraph::p_string_to_node_index_multimap

protected

Definition at line 32738 of file Cxx_Grammar.h.

rose_graph_string_integer_hash_multimap SgGraph::p_string_to_edge_index_multimap

protected

Definition at line 32742 of file Cxx_Grammar.h.

rose_graph_integer_edge_hash_multimap SgGraph::p_node_index_to_edge_multimap

protected

Definition at line 32746 of file Cxx_Grammar.h.

int SgGraph::p_index

protected

Definition at line 32750 of file Cxx_Grammar.h.

int SgGraph::p_index_counter

staticprotected

Definition at line 32754 of file Cxx_Grammar.h.

SgBoostEdgeList SgGraph::p_boost_edges

protected

Definition at line 32758 of file Cxx_Grammar.h.

SgBoostEdgeWeightList SgGraph::p_boost_edge_weights

protected

Definition at line 32762 of file Cxx_Grammar.h.

AstAttributeMechanism* SgGraph::p_attributeMechanism

protected

Definition at line 32766 of file Cxx_Grammar.h.

std::map<int, std::string> SgGraph::p_properties

protected

Definition at line 32770 of file Cxx_Grammar.h.

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

Cxx_Grammar.h

Protected Attributes
std::string	p_name

rose_graph_integer_node_hash_map	p_node_index_to_node_map

rose_graph_integer_edge_hash_map	p_edge_index_to_edge_map

rose_graph_integerpair_edge_hash_multimap	p_node_index_pair_to_edge_multimap

rose_graph_string_integer_hash_multimap	p_string_to_node_index_multimap

rose_graph_string_integer_hash_multimap	p_string_to_edge_index_multimap

rose_graph_integer_edge_hash_multimap	p_node_index_to_edge_multimap

int	p_index

SgBoostEdgeList	p_boost_edges

SgBoostEdgeWeightList	p_boost_edge_weights

AstAttributeMechanism *	p_attributeMechanism

std::map< int, std::string >	p_properties

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation