com.oracle.graal.pointsto.reports

Class ReportUtils

java.lang.Object

com.oracle.graal.pointsto.reports.ReportUtils

public class ReportUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHILD
static String	CONNECTING_INDENT
static String	EMPTY_INDENT
static String	LAST_CHILD
static Comparator<ResolvedJavaMethod>	methodComparator

Constructor Summary

Constructors

Constructor and Description
ReportUtils()

Method Summary

Modifier and Type	Method and Description
static String	extractImageName(String imageName)
static void	formatParsingContext(StackTraceElement[] parsingContext, String indent, StringBuilder msg)
static Path	getCWDRelativePath(Path path) Returns a path relative to the current working directory if possible.
static String	getTimeStampString()
static String	parsingContext(AnalysisMethod method)
static String	parsingContext(AnalysisMethod method, int bci, String indent, boolean includeTarget)
static String	parsingContext(AnalysisMethod method, String indent)
static String	parsingContext(jdk.vm.ci.code.BytecodePosition context)
static void	report(String description, Path file, boolean append, Consumer<OutputStream> reporter) Print a report in the file given by file parameter.
static void	report(String description, Path file, Consumer<PrintWriter> reporter)
static Path	report(String description, Path file, Consumer<PrintWriter> reporter, boolean enablePrint) Print a report in the file given by file parameter.
static Path	report(String description, String path, String name, String extension, Consumer<PrintWriter> reporter)
static Path	report(String description, String path, String name, String extension, Consumer<PrintWriter> reporter, boolean enablePrint)
static Path	report(String description, String path, String name, String extension, Consumer<PrintWriter> reporter, boolean enablePrint, String timeStamp) Print a report in the format: path/name_timeStamp.extension.
static File	reportFile(String path, String name, String extension)
static StackTraceElement	rootMethodSentinel(String reason)
static String	timeStampedFileName(String name, String extension)
static String	timeStampedFileName(String name, String extension, String timeStamp)
static StackTraceElement	truncatedStackTraceSentinel(AnalysisMethod method)
static String	typePropagationTrace(PointsToAnalysis bb, TypeFlow<?> flow, AnalysisType type)
static String	typePropagationTrace(PointsToAnalysis bb, TypeFlow<?> flow, AnalysisType type, String indent)

Methods inherited from class java.lang.Object

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

Field Detail

CONNECTING_INDENT

public static final String CONNECTING_INDENT

See Also:

Constant Field Values

EMPTY_INDENT

public static final String EMPTY_INDENT

See Also:

Constant Field Values

CHILD

public static final String CHILD

See Also:

Constant Field Values

LAST_CHILD

public static final String LAST_CHILD

See Also:

Constant Field Values

methodComparator

public static final Comparator<ResolvedJavaMethod> methodComparator

Constructor Detail

ReportUtils

public ReportUtils()

Method Detail

report

public static Path report(String description,
                          String path,
                          String name,
                          String extension,
                          Consumer<PrintWriter> reporter)

report

public static Path report(String description,
                          String path,
                          String name,
                          String extension,
                          Consumer<PrintWriter> reporter,
                          boolean enablePrint)

report

public static Path report(String description,
                          String path,
                          String name,
                          String extension,
                          Consumer<PrintWriter> reporter,
                          boolean enablePrint,
                          String timeStamp)

Print a report in the format: path/name_timeStamp.extension. The path is relative to the working directory.

Parameters:

description - the description of the report

path - the path (relative to the working directory if the argument represents a relative path)

name - the name of the report

extension - the extension of the report

reporter - a consumer that writes to a PrintWriter

timeStamp - from ReportUtils.getTimeStampString()

timeStampedFileName

public static String timeStampedFileName(String name,
                                         String extension)

timeStampedFileName

public static String timeStampedFileName(String name,
                                         String extension,
                                         String timeStamp)

getTimeStampString

public static String getTimeStampString()

reportFile

public static File reportFile(String path,
                              String name,
                              String extension)

report

public static void report(String description,
                          Path file,
                          Consumer<PrintWriter> reporter)

report

public static Path report(String description,
                          Path file,
                          Consumer<PrintWriter> reporter,
                          boolean enablePrint)

Print a report in the file given by file parameter. If the file is relative it's resolved to the working directory.

Parameters:

description - the description of the report

file - the path (relative to the working directory if the argument represents a relative path) to file to store a report into.

reporter - a consumer that writes to a PrintWriter

enablePrint - of a notice to stdout

getCWDRelativePath

public static Path getCWDRelativePath(Path path)

Returns a path relative to the current working directory if possible.

extractImageName

public static String extractImageName(String imageName)

report

public static void report(String description,
                          Path file,
                          boolean append,
                          Consumer<OutputStream> reporter)

Print a report in the file given by file parameter. If the file is relative it's resolved to the working directory.

Parameters:

description - the description of the report

file - the path (relative to the working directory if the argument represents a relative path) to file to store a report into.

reporter - a consumer that writes to a FileOutputStream

append - flag to append onto file

parsingContext

public static String parsingContext(AnalysisMethod method)

parsingContext

public static String parsingContext(AnalysisMethod method,
                                    String indent)

parsingContext

public static String parsingContext(jdk.vm.ci.code.BytecodePosition context)

parsingContext

public static String parsingContext(AnalysisMethod method,
                                    int bci,
                                    String indent,
                                    boolean includeTarget)

formatParsingContext

public static void formatParsingContext(StackTraceElement[] parsingContext,
                                        String indent,
                                        StringBuilder msg)

truncatedStackTraceSentinel

public static StackTraceElement truncatedStackTraceSentinel(AnalysisMethod method)

rootMethodSentinel

public static StackTraceElement rootMethodSentinel(String reason)

typePropagationTrace

public static String typePropagationTrace(PointsToAnalysis bb,
                                          TypeFlow<?> flow,
                                          AnalysisType type)

typePropagationTrace

public static String typePropagationTrace(PointsToAnalysis bb,
                                          TypeFlow<?> flow,
                                          AnalysisType type,
                                          String indent)