SgGraph Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgGraph:

Inheritance graph
[legend]
Collaboration diagram for SgGraph:

Collaboration graph
[legend]
List of all members.

Detailed Description

Doxygen documentation for graph class (should maybe be put with the rest of the doxygen documentation in docs/testDoxygen directory instead).


Public Types

typedef std::pair< int, int > BoostEdgeType
 Simple edge type used to input data to Boost algorithms.
typedef std::vector< BoostEdgeTypeSgBoostEdgeList
typedef std::vector< int > SgBoostEdgeWeightList
typedef SgSupport base_node_type
 e_type_error
 none
 cfg
 usage
 e_last_type
 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
 static_variant = V_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 More...

Public Member Functions

virtual SgNodecopy (SgCopyHelp &help) const
int hashCode (const char *p, int len) const
void append_properties (int addr, const std::string &prop)
SgGraphNodeaddNode (const std::string &name="", SgNode *sg_node=NULL)
 Support for adding SgGraphNode to SgGraph.
SgGraphNodeaddNode (SgGraphNode *node)
 Add support for externally build SgGraphNode objects.
SgGraphEdgeaddEdge (SgGraphNode *a, SgGraphNode *b, const std::string &name="")
 Support for adding SgGraphEdge to SgGraph.
SgGraphEdgeaddEdge (SgGraphEdge *edge)
 Add support for externally build SgGraphNode objects.
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.
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)
 Add a new attribute represented by the named string.
virtual AstAttributegetAttribute (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 SgNodeget_traversalSuccessorByIndex (size_t idx)
virtual size_t get_childIndex (SgNode *child)
virtual RTIReturnType roseRTI ()
 FOR INTERNAL USE Access to Runtime Type Information (RTI) for this IR nodes.
virtual const char * sage_class_name () const ROSE_DEPRECATED_FUNCTION
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
virtual void accept (ROSE_VisitorPattern &visitor)
 DXN (08/09/2010): support for the classic visitor pattern done in GoF.
virtual bool isInMemoryPool ()
 FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.
virtual void checkDataMemberPointersIfInMemoryPool ()
 FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.
virtual std::vector< std::pair<
SgNode *, std::string > > 
returnDataMemberPointers () const
 FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools
virtual void processDataMemberReferenceToPointers (ReferenceToPointerHandler *)
 FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools
virtual long getChildIndex (SgNode *childNode) const
 FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node.
 SgGraph (const SgGraphStorageClass &source)
SgGraphaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression.
std::string get_name () const
void set_name (std::string name)
const rose_graph_integer_node_hash_mapget_node_index_to_node_map () const
rose_graph_integer_node_hash_mapget_node_index_to_node_map ()
const rose_graph_integer_edge_hash_mapget_edge_index_to_edge_map () const
rose_graph_integer_edge_hash_mapget_edge_index_to_edge_map ()
const rose_graph_integerpair_edge_hash_multimapget_node_index_pair_to_edge_multimap () const
rose_graph_integerpair_edge_hash_multimapget_node_index_pair_to_edge_multimap ()
const rose_graph_string_integer_hash_multimapget_string_to_node_index_multimap () const
rose_graph_string_integer_hash_multimapget_string_to_node_index_multimap ()
const rose_graph_string_integer_hash_multimapget_string_to_edge_index_multimap () const
rose_graph_string_integer_hash_multimapget_string_to_edge_index_multimap ()
const rose_graph_integer_edge_hash_multimapget_node_index_to_edge_multimap () const
rose_graph_integer_edge_hash_multimapget_node_index_to_edge_multimap ()
int get_index () const
void set_index (int index)
const SgBoostEdgeListget_boost_edges () const
SgBoostEdgeListget_boost_edges ()
const SgBoostEdgeWeightListget_boost_edge_weights () const
SgBoostEdgeWeightListget_boost_edge_weights ()
AstAttributeMechanismget_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 ~SgGraph ()
 SgGraph (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

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
AstAttributeMechanismp_attributeMechanism
std::map< int, std::string > p_properties

Static Protected Attributes

static int p_index_counter

Friends

class AST_FILE_IO
class SgGraphStorageClass
class AstSpecificDataManagingClass
class AstSpecificDataManagingClassStorageClass
SgGraphisSgGraph (SgNode *s)
 Casts pointer from base class to derived class.
const SgGraphisSgGraph (const SgNode *s)
 Casts pointer from base class to derived class (for const pointers).
SgGraphSgGraph_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 SgGraph_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
 Get the size of the memory pool.
void SgGraph_clearMemoryPool ()
void SgGraph_extendMemoryPoolForFileIO (unsigned long)
void SgGraph_getNextValidPointer (std::pair< SgGraph *, std::vector< unsigned char * >::const_iterator > &)
void SgGraph_resetValidFreepointers ()


Member Typedef Documentation

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

Simple edge type used to input data to Boost algorithms.

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

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

typedef SgSupport SgGraph::base_node_type

Reimplemented from SgSupport.

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


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)

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)

anonymous enum

static variant value

Enumerator:
static_variant 


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]

Reimplemented from SgSupport.

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

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.

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

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

returns new style SageIII enum values

Reimplemented from SgSupport.

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

void* SgGraph::operator new ( size_t  size  ) 

returns pointer to newly allocated IR node

Reimplemented from SgSupport.

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

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

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

Reimplemented from SgSupport.

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

void SgGraph::operator delete ( void *  pointer  ) 

Reimplemented from SgSupport.

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

static size_t SgGraph::numberOfNodes (  )  [static]

Returns the total number of IR nodes of this type.

Reimplemented from SgSupport.

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

static size_t SgGraph::memoryUsage (  )  [static]

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

Reimplemented from SgSupport.

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

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

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

virtual size_t SgGraph::get_numberOfTraversalSuccessors (  )  [virtual]

Reimplemented from SgSupport.

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

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

Reimplemented from SgSupport.

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

virtual size_t SgGraph::get_childIndex ( SgNode child  )  [virtual]

Reimplemented from SgSupport.

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

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

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

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

Reimplemented from SgSupport.

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

void SgGraph::executeVisitorMemberFunction ( ROSE_VisitorPattern visitor  ) 

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgSupport.

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

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

static void SgGraph::traverseMemoryPoolNodes ( ROSE_VisitTraversal visit  )  [static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgSupport.

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

static void SgGraph::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern visitor  )  [static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgSupport.

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

static void SgGraph::visitRepresentativeNode ( ROSE_VisitTraversal visit  )  [static]

FOR INTERNAL USE Support for type-based traversal.

Reimplemented from SgSupport.

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

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

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

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

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

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

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.

Reimplemented from SgSupport.

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

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]

Reimplemented from SgSupport.

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

friend class SgGraphStorageClass [friend]

friend class AstSpecificDataManagingClass [friend]

Reimplemented from SgSupport.

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

friend class AstSpecificDataManagingClassStorageClass [friend]

Reimplemented from SgSupport.

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

SgGraph* isSgGraph ( SgNode s  )  [friend]

Casts pointer from base class to derived class.

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

rose_graph_integer_node_hash_map SgGraph::p_node_index_to_node_map [protected]

rose_graph_integer_edge_hash_map SgGraph::p_edge_index_to_edge_map [protected]

rose_graph_integerpair_edge_hash_multimap SgGraph::p_node_index_pair_to_edge_multimap [protected]

rose_graph_string_integer_hash_multimap SgGraph::p_string_to_node_index_multimap [protected]

rose_graph_string_integer_hash_multimap SgGraph::p_string_to_edge_index_multimap [protected]

rose_graph_integer_edge_hash_multimap SgGraph::p_node_index_to_edge_multimap [protected]

int SgGraph::p_index [protected]

int SgGraph::p_index_counter [static, protected]

SgBoostEdgeList SgGraph::p_boost_edges [protected]

SgBoostEdgeWeightList SgGraph::p_boost_edge_weights [protected]

AstAttributeMechanism* SgGraph::p_attributeMechanism [protected]

std::map<int, std::string> SgGraph::p_properties [protected]


The documentation for this class was generated from the following file:
Generated on Tue Jan 31 05:40:20 2012 for ROSE by  doxygen 1.4.7