sootup.callgraph

Class GraphBasedCallGraph

java.lang.Object

sootup.callgraph.GraphBasedCallGraph

All Implemented Interfaces:

CallGraph, MutableCallGraph

public class GraphBasedCallGraph
extends Object
implements MutableCallGraph

This class implements a mutable call graph as a graph.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	GraphBasedCallGraph.Edge This internal class is used to describe the edge in the graph.
protected static class	GraphBasedCallGraph.Vertex This internal class is used to describe a vertex in the graph.

Constructor Summary

Constructors

Constructor and Description
GraphBasedCallGraph() The constructor of the graph based call graph.
GraphBasedCallGraph(org.jgrapht.graph.DefaultDirectedGraph<GraphBasedCallGraph.Vertex,GraphBasedCallGraph.Edge> graph, Map<MethodSignature,GraphBasedCallGraph.Vertex> signatureToVertex)

Method Summary

Modifier and Type	Method and Description
void	addCall(MethodSignature sourceMethod, MethodSignature targetMethod) This method enables to add calls that are edges in the call graph.
protected void	addCall(MethodSignature sourceMethod, MethodSignature targetMethod, GraphBasedCallGraph.Edge edge)
void	addMethod(MethodSignature calledMethod) This method enables to add method that are nodes in the call graph.
protected void	addMethod(MethodSignature calledMethod, GraphBasedCallGraph.Vertex vertex)
int	callCount() This method counts every edge in the call graph.
Set<MethodSignature>	callsFrom(MethodSignature sourceMethod) This method returns all method signatures that are called by a given method signature.
Set<MethodSignature>	callsTo(MethodSignature targetMethod) This method returns all method signatures that call a given method signature.
boolean	containsCall(MethodSignature sourceMethod, MethodSignature targetMethod) This method checks if an edge is contained in the call graph.
boolean	containsMethod(MethodSignature method) This method checks if a given method signature is a node in the call graph.
MutableCallGraph	copy() This method copies a call graph.
String	exportAsDot() This method converts the call graph object into dot format and write it to a string file.
protected org.jgrapht.graph.DefaultDirectedGraph<GraphBasedCallGraph.Vertex,GraphBasedCallGraph.Edge>	getGraph()
Set<MethodSignature>	getMethodSignatures() This method returns method signatures in the call graph.
protected Map<MethodSignature,GraphBasedCallGraph.Vertex>	getSignatureToVertex()
String	toString() This method exports the call graph in a human-readable string.
protected MethodSignature	vertex2MethodSignature(GraphBasedCallGraph.Vertex vertex)
protected GraphBasedCallGraph.Vertex	vertexOf(MethodSignature method) it returns the vertex of the graph that describes the given method signature in the call graph.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GraphBasedCallGraph

public GraphBasedCallGraph()

The constructor of the graph based call graph. it initializes the call graph object.

GraphBasedCallGraph

public GraphBasedCallGraph(@Nonnull
                           org.jgrapht.graph.DefaultDirectedGraph<GraphBasedCallGraph.Vertex,GraphBasedCallGraph.Edge> graph,
                           @Nonnull
                           Map<MethodSignature,GraphBasedCallGraph.Vertex> signatureToVertex)

Method Detail

addMethod

public void addMethod(@Nonnull
                      MethodSignature calledMethod)

Description copied from interface: MutableCallGraph

This method enables to add method that are nodes in the call graph.

Specified by:

addMethod in interface MutableCallGraph

Parameters:

calledMethod - the method that will be added to the call graph.

addMethod

protected void addMethod(@Nonnull
                         MethodSignature calledMethod,
                         GraphBasedCallGraph.Vertex vertex)

addCall

public void addCall(@Nonnull
                    MethodSignature sourceMethod,
                    @Nonnull
                    MethodSignature targetMethod)

Description copied from interface: MutableCallGraph

This method enables to add calls that are edges in the call graph.

Specified by:

addCall in interface MutableCallGraph

Parameters:

sourceMethod - this parameter defines the source node of the edge in the call graph.

targetMethod - this paramter defines the target node of the edge in the call graph.

addCall

protected void addCall(@Nonnull
                       MethodSignature sourceMethod,
                       @Nonnull
                       MethodSignature targetMethod,
                       GraphBasedCallGraph.Edge edge)

getMethodSignatures

@Nonnull
public Set<MethodSignature> getMethodSignatures()

Description copied from interface: CallGraph

This method returns method signatures in the call graph. A method signature is a node in the call graph.

Specified by:

getMethodSignatures in interface CallGraph

Returns:

a set containing all method signatures in the call graph.

callsFrom

@Nonnull
public Set<MethodSignature> callsFrom(@Nonnull
                                               MethodSignature sourceMethod)

Description copied from interface: CallGraph

This method returns all method signatures that are called by a given method signature. It returns the targets of outgoing edges of the given node (method signature) in the call graph

Specified by:

callsFrom in interface CallGraph

Parameters:

sourceMethod - the method signature of the requested node in the call graph

Returns:

a set of method signatures that are reached by a direct outgoing edge in the call graph

callsTo

@Nonnull
public Set<MethodSignature> callsTo(@Nonnull
                                             MethodSignature targetMethod)

Description copied from interface: CallGraph

This method returns all method signatures that call a given method signature. It returns the sources of incoming edges of the given node (method signature) in the call graph

Specified by:

callsTo in interface CallGraph

Parameters:

targetMethod - the method signature of the requested node in the call graph

Returns:

a set of method signatures that reach the targetMethod by a direct edge in the call graph

containsMethod

public boolean containsMethod(@Nonnull
                              MethodSignature method)

Description copied from interface: CallGraph

This method checks if a given method signature is a node in the call graph.

Specified by:

containsMethod in interface CallGraph

Parameters:

method - the method signature of the requested node

Returns:

it returns true if the node described by the method signature is included in the call graph, otherwise it will return false.

containsCall

public boolean containsCall(@Nonnull
                            MethodSignature sourceMethod,
                            @Nonnull
                            MethodSignature targetMethod)

Description copied from interface: CallGraph

This method checks if an edge is contained in the call graph. The edge is defined by a source and target method signature which can be nodes in the call graph

Specified by:

containsCall in interface CallGraph

Parameters:

sourceMethod - it defines the source node in the call graph

targetMethod - it defines the target node in the call graph

Returns:

true if the edge is contained in the call graph, otherwise it will be false.

callCount

public int callCount()

Description copied from interface: CallGraph

This method counts every edge in the call graph.

Specified by:

callCount in interface CallGraph

Returns:

it returns the number of all edges in the call graph.

exportAsDot

public String exportAsDot()

Description copied from interface: CallGraph

This method converts the call graph object into dot format and write it to a string file.

Specified by:

exportAsDot in interface CallGraph

copy

@Nonnull
public MutableCallGraph copy()

Description copied from interface: CallGraph

This method copies a call graph.

Specified by:

copy in interface CallGraph

Returns:

it returns a copied call graph.

vertexOf

@Nonnull
protected GraphBasedCallGraph.Vertex vertexOf(@Nonnull
                                                       MethodSignature method)

it returns the vertex of the graph that describes the given method signature in the call graph.

Parameters:

method - the method signature searched in the call graph

Returns:

the vertex of the requested method signature.

getGraph

@Nonnull
protected org.jgrapht.graph.DefaultDirectedGraph<GraphBasedCallGraph.Vertex,GraphBasedCallGraph.Edge> getGraph()

getSignatureToVertex

@Nonnull
protected Map<MethodSignature,GraphBasedCallGraph.Vertex> getSignatureToVertex()

vertex2MethodSignature

@Nonnull
protected MethodSignature vertex2MethodSignature(@Nonnull
                                                          GraphBasedCallGraph.Vertex vertex)

toString

public String toString()

This method exports the call graph in a human-readable string. The String lists all nodes in the call graph. For each node it also lists the outgoing and incoming edges. An outgoing edge is marked by a "To" and an incoming edge by a "From" The nodes, incoming edges, and outgoing edges are sorted in order by the classname, method name, parameter list

Overrides:

toString in class Object

Returns:

a string containing all nodes and edges of the call graph.