com.goldencode.p2j.uast

Class CallGraphGenerator

java.lang.Object

com.goldencode.p2j.uast.CallGraphGenerator

public class CallGraphGenerator
extends java.lang.Object

Special-purpose driver for the pattern engine to create a new call graph for one or more root entry points. This provides a command line interface, see main(java.lang.String[]) for the syntax.

Field Summary

Fields

Modifier and Type	Field and Description
private static ConversionStatus	LOG Logger.

Constructor Summary

Constructors

Constructor and Description
CallGraphGenerator()

Method Summary

Modifier and Type	Method and Description
static void	generateGraphs(java.lang.String[] rootNodes, int debug) Implements the core of the call graph generation logic, a call graph will be generated for each of the root nodes passed.
static void	main(java.lang.String[] args) Provides a command line interface for an end user to drive the pattern engine for the purpose of building one or more call graphs.
private static void	syntax(java.lang.String msg, int rc) Emit a syntax statement and optional error message to stderr, then exit the process with the specified return code.
static void	updateGraphs(java.lang.String[] rootNodes, int debug) Update the ambiguous external programs and the explicit list of external programs provided as argument, by re-checking if the ambiguous call-sites can be disambiguated from the hints.
private static void	walkTargets(java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex> walker, java.lang.String profile) Walk the targets specified by the given iterator, in batches, until the iterator no longer provides any new targets.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final ConversionStatus LOG

Logger.

Constructor Detail

CallGraphGenerator

public CallGraphGenerator()

Method Detail

updateGraphs

public static void updateGraphs(java.lang.String[] rootNodes,
                                int debug)
                         throws ConfigurationException,
                                AstException

Update the ambiguous external programs and the explicit list of external programs provided as argument, by re-checking if the ambiguous call-sites can be disambiguated from the hints.

Parameters:

rootNodes - List of Progress AST filenames to use as root nodes or null to use the projects defined root node list (see RootNodeList).

debug - Debug level.

Throws:

ConfigurationException

AstException

generateGraphs

public static void generateGraphs(java.lang.String[] rootNodes,
                                  int debug)
                           throws ConfigurationException,
                                  AstException,
                                  java.io.IOException

Implements the core of the call graph generation logic, a call graph will be generated for each of the root nodes passed. For a root node named filename.p.ast, the resulting call graph will be named filename.p.ast.graph.

Parameters:

rootNodes - List of Progress AST filenames to use as root nodes or null to use the projects defined root node list (see RootNodeList).

debug - Debug level.

Throws:

ConfigurationException

AstException

java.io.IOException

walkTargets

private static void walkTargets(java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex> walker,
                                java.lang.String profile)
                         throws AstException,
                                ConfigurationException

Walk the targets specified by the given iterator, in batches, until the iterator no longer provides any new targets.

Parameters:

walker - The target provider.

profile - The profile to be applied against the targets.

Throws:

AstException

ConfigurationException

syntax

private static void syntax(java.lang.String msg,
                           int rc)

Emit a syntax statement and optional error message to stderr, then exit the process with the specified return code. This method is called from main(java.lang.String[]) when the user passes command line parameters which are not viable.

Parameters:

msg - Optional error message; may be null.

rc - Process return code used with System.exit().

main

public static void main(java.lang.String[] args)

Provides a command line interface for an end user to drive the pattern engine for the purpose of building one or more call graphs.

Syntax:

   java CallGraphGenerator [-Dn] [-u] [root_nodes...]  
 

Where:

• -g saves the graph in GraphML format
• -Dn sets the pattern engine debug level where n is the numeric setting of the level (default is 1):
  • none (0)
  • status (1)
  • debug (2)
  • trace (3)
• -u sets the callgraph processing in update mode, where only the ambiguous nodes and their newly-resolved targets are processed. The targets specified in the root_nodes list are ensured to be updated and must already exist in the callgraph.
• [root_nodes...] is one or more root node filenames to process (which must be valid relative or absolute names based on the current directory)

Debug level is set to status (1) by default.

If no root nodes are listed on the command line, then the project's root node list will be used (RootNodeList).

Parameters:

args - List of command line arguments.