SgIncidenceUndirectedGraph Class Reference

Description

Definition at line 35973 of file Cxx_Grammar.h.

Inheritance diagram for SgIncidenceUndirectedGraph:

Collaboration diagram for SgIncidenceUndirectedGraph:

Public Types
enum	{ static_variant = V_SgIncidenceUndirectedGraph }
	static variant value
typedef SgGraph	base_node_type
Public Types inherited from SgGraph
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
typedef std::pair< int, int >	BoostEdgeType
	Simple edge type used to input data to Boost algorithms.
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
typedef SgNode	base_node_type
Public Types inherited from SgNode
enum	{ static_variant = V_SgNode }
	static variant value

Public Member Functions
virtual SgNode *	copy (SgCopyHelp &help) const override
	This function clones the current IR node object recursively or not, depending on the argument. More...
virtual std::string	class_name () const override
	returns a string representing the class name
virtual VariantT	variantT () const override
	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 () override
	container of pointers to AST successor nodes used in the traversal overridden in every class by generated implementation
virtual std::vector< std::string >	get_traversalSuccessorNamesContainer () override
	container of names of variables or container indices used used in the traversal to access AST successor nodes overridden in every class by generated implementation
virtual size_t	get_numberOfTraversalSuccessors () override
	return number of children in the traversal successor list
virtual SgNode *	get_traversalSuccessorByIndex (size_t idx) override
	index-based access to traversal successors by index number
virtual size_t	get_childIndex (SgNode *child) override
	index-based access to traversal successors by child node
virtual RTIReturnType	roseRTI () override
	return C++ Runtime-Time-Information
virtual const char *	sage_class_name () const override ROSE_DEPRECATED_FUNCTION
void	executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern.
virtual void	accept (ROSE_VisitorPattern &visitor) override
	support for the classic visitor pattern done in GoF
virtual bool	isInMemoryPool () override
	FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...
virtual void	checkDataMemberPointersIfInMemoryPool () override
	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 override
	FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools More...
virtual void	processDataMemberReferenceToPointers (ReferenceToPointerHandler *) override
	FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools More...
virtual long	getChildIndex (SgNode *childNode) const override
	FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node. More...
	SgIncidenceUndirectedGraph (const SgIncidenceUndirectedGraphStorageClass &source)
	IR node constructor to support AST File I/O.
SgIncidenceUndirectedGraph *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression. More...
	SgIncidenceUndirectedGraph (std::string name="")
Public Member Functions inherited from SgGraph
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.
SgGraphNode *	addNode (SgGraphNode *node)
	Add support for externally build SgGraphNode objects.
SgGraphEdge *	addEdge (SgGraphNode *a, SgGraphNode *b, const std::string &name="")
	Support for adding SgGraphEdge to SgGraph.
SgGraphEdge *	addEdge (SgGraphEdge *edge)
	Add support for externally build SgGraphNode objects.
void	post_construction_initialization () override
	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.
std::vector< SgGraphEdge * >	generateSpanningTree ()
	Support for Boost Minimum Spanning Tree.
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.
bool	exists (SgGraphEdge *edge)
	Check if the edge is present in the graph.
std::set< SgGraphEdge * >	computeEdgeSet (SgGraphNode *node)
	Builds a set of edges that are associated with a specific node.
std::set< int >	computeEdgeSet (int node_index)
	Integer index version of "std::set<SgGraphEdge*> computeEdgeSet( SgGraphNode* node );".
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).
std::set< SgGraphNode * >	computeNodeSet (const std::string &label)
	Builds a set of node index values associated with a label.
std::set< SgGraphNode * >	computeNodeSet ()
	Builds a set of all nodes in the graph.
std::set< int >	computeNodeIndexSet (const std::string &label)
	Integer index version of "std::set<SgGraphNode*> computeNodeSet( const std::string & label );".
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" ).
size_t	memory_usage ()
	Report the size in bytes of the graph (includes all edges and ndes from all hash_maps and hash_multimaps).
virtual void	addNewAttribute (std::string s, AstAttribute *a) override
	Add a new attribute represented by the named string.
virtual AstAttribute *	getAttribute (std::string s) const override
	Returns attribute of name 's'.
virtual void	updateAttribute (std::string s, AstAttribute *a) override
	Replace existing attribute of name 's' with new AstAttribute.
virtual void	setAttribute (std::string s, AstAttribute *a) override
	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) override
	Remove attribute of name 's' if present.
virtual bool	attributeExists (std::string s) const override
	Tests if attribute of name 's' is present.
virtual int	numberOfAttributes () const override
	Returns the number of attributes on this IR node.
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)
void	executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern.
	SgGraph (const SgGraphStorageClass &source)
	IR node constructor to support AST File I/O.
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 override
	FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error. More...
void	set_attributeMechanism (AstAttributeMechanism *attributeMechanism) override
	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 ()
	SgGraph (std::string name="")
Public Member Functions inherited from SgSupport
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)
void	executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern.
	SgSupport (const SgSupportStorageClass &source)
	IR node constructor to support AST File I/O.
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
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)
void	executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern.
	SgNode (const SgNodeStorageClass &source)
	IR node constructor to support AST File I/O.
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...
void	set_containsTransformation (bool containsTransformation)
	Many nodes can hide other AST nodes and we need to track when outer nodes contain modified nodes even if they are not themselves modified. More...
bool	get_isModified () const
	Acess function for isModified flag. More...
bool	get_containsTransformation () const
	Acess function for containsTransformation flag. More...
bool	isChild (SgNode *node) const
	Query function for if the input IR nodes is a child of the current IR node.
virtual std::string	unparseToString (SgUnparse_Info *info) const
	This function unparses the AST node (excluding comments and unnecessary white space)
std::string	unparseToString () const
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.
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).
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).
VirtualCFG::CFGNode	cfgForBeginning ()
	Returns the CFG node for just before this AST node.
VirtualCFG::CFGNode	cfgForEnd ()
	Returns the CFG node for just after this AST node.
virtual unsigned int	cfgIndexForEnd () const
	Determine the CFG index for the end of this construct.
virtual bool	cfgIsIndexInteresting (unsigned int index) const
	Determine whether a particular CFG node index is "interesting" for this kind of node.
virtual unsigned int	cfgFindChildIndex (SgNode *n)
	Find the index of n in this node's CFG children.
virtual unsigned int	cfgFindNextChildIndex (SgNode *n)
	Find the index just after n in this node's CFG children.
virtual std::vector< VirtualCFG::CFGEdge >	cfgOutEdges (unsigned int index=false)
	Find the out edges of a CFG node – internal version.
virtual std::vector< VirtualCFG::CFGEdge >	cfgInEdges (unsigned int index=false)
	Find the in edges of a CFG node – internal version.
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...
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...
std::string	unparseToCompleteString ()
	This function unparses the AST node (including comments and white space) 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 void	deleteMemoryPool ()
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 over all IR nodes by type of IR node.
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.
Static Public Member Functions inherited from SgGraph
static void	deleteMemoryPool ()
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 over all IR nodes by type of IR node.
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.
Static Public Member Functions inherited from SgSupport
static void	deleteMemoryPool ()
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 over all IR nodes by type of IR node.
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.
Static Public Member Functions inherited from SgNode
static void	deleteMemoryPool ()
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 over all IR nodes by type of IR node.
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.
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.
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::map< SgNode *, std::string > > &	get_globalQualifiedNameMapForMapsOfTypes ()
	Access function for name qualification support (for maps of types). More...
static void	set_globalQualifiedNameMapForMapsOfTypes (const std::map< SgNode *, std::map< SgNode *, std::string > > &X)
	Access function for name qualification support (for maps of types). More...
static std::map< SgNode *, std::string > &	get_globalQualifiedNameMapForTemplateHeaders ()
	Access function for name qualification support (for template headers in template declarations). More...
static void	set_globalQualifiedNameMapForTemplateHeaders (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for template headers in template declarations). 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.
static void	set_globalFunctionTypeTable (SgFunctionTypeTable *globalFunctionTypeTable)
	Access function for symbol table specific to function types.
static SgTypeTable *	get_globalTypeTable ()
	Access function for symbol table specific to non-function types.
static void	set_globalTypeTable (SgTypeTable *globalTypeTable)
	Access function for symbol table specific to non-function types.
static VariantT	variantFromPool (SgNode const *n)

Additional Inherited Members
Protected Attributes inherited from SgGraph
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
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...
bool	p_containsTransformation
SgNode *	p_freepointer
	This is the pointer to the chain of previously freed objects.
Static Protected Attributes inherited from SgGraph
static int	p_index_counter
Static Protected Attributes inherited from SgNode
static std::vector< std::tuple< unsigned char *, unsigned, VariantT > >	all_pools
static SgFunctionTypeTable *	p_globalFunctionTypeTable
	Pointer to symbol table specific to function types.
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.
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.
static std::map< SgNode *, std::string >	p_globalQualifiedNameMapForNames
static std::map< SgNode *, std::string >	p_globalQualifiedNameMapForTypes
static std::map< SgNode *, std::string >	p_globalQualifiedNameMapForTemplateHeaders
static std::map< SgNode *, std::string >	p_globalTypeNameMap
static std::map< SgNode *, std::map< SgNode *, std::string > >	p_globalQualifiedNameMapForMapsOfTypes

Member Function Documentation

copy()

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

overridevirtual

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.

Reimplemented from SgGraph.

sage_class_name()

virtual const char* SgIncidenceUndirectedGraph::sage_class_name ( ) const

overridevirtual

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

Reimplemented from SgGraph.

isInMemoryPool()

virtual bool SgIncidenceUndirectedGraph::isInMemoryPool ( )

overridevirtual

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

checkDataMemberPointersIfInMemoryPool()

virtual void SgIncidenceUndirectedGraph::checkDataMemberPointersIfInMemoryPool ( )

overridevirtual

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

returnDataMemberPointers()

virtual std::vector<std::pair<SgNode*,std::string> > SgIncidenceUndirectedGraph::returnDataMemberPointers ( ) const

overridevirtual

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

processDataMemberReferenceToPointers()

virtual void SgIncidenceUndirectedGraph::processDataMemberReferenceToPointers ( ReferenceToPointerHandler *  )

overridevirtual

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

getChildIndex()

virtual long SgIncidenceUndirectedGraph::getChildIndex ( SgNode *  childNode ) const

overridevirtual

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

addRegExpAttribute()

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

---

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

• Cxx_Grammar.h