net.covers1624.coffeegrinder.debug

Interface Debugger

public interface Debugger

An abstract interface for extended debugging.

Created by covers1624 on 15/9/25.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Debugger.Internal

Field Summary

Fields

Modifier and Type	Field and Description
static @Nullable Debugger	DEBUGGER A static instance of the debugger, if available.

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildControlFlowGraphDot(ControlFlowNode cfNode) Generate a GraphViz Dot graph string for the given ControlFlowNode graph.
java.lang.String	buildVariableLivenessGraphDot(VariableLivenessGraph vlGraph) Generate a GraphViz Dot graph string for the given VariableLivenessGraph.
void	startDebugger(java.lang.String ipAndPort, ClassResolver resolver) Start an interactive http based web debugger.
static void	tryIfPresent(net.covers1624.quack.util.SneakyUtils.ThrowingConsumer<Debugger,java.lang.Throwable> action) Try to run the given action, if the debugger is available, fire the action with it.
void	writeControlFlowGraph(ControlFlowNode cfNode, java.nio.file.Path dest) Generate a GraphViz png for the given ControlFlowNode graph.
void	writeVariableLivenessGraph(VariableLivenessGraph vlGraph, java.nio.file.Path dest) Generate a GraphViz png for the given VariableLivenessGraph.

Field Detail

DEBUGGER

@Nullable
static final @Nullable Debugger DEBUGGER

A static instance of the debugger, if available.

Method Detail

writeControlFlowGraph

void writeControlFlowGraph(ControlFlowNode cfNode,
                           java.nio.file.Path dest)
                    throws java.io.IOException

Generate a GraphViz png for the given ControlFlowNode graph.

Parameters:

cfNode - The node to generate the graph for.

dest - The file to write to.

Throws:

java.io.IOException - Any IO exception whilst generating or writing the graph.

buildControlFlowGraphDot

java.lang.String buildControlFlowGraphDot(ControlFlowNode cfNode)

Generate a GraphViz Dot graph string for the given ControlFlowNode graph.

Parameters:

cfNode - The node to generate the graph for.

Returns:

The Dot graph string.

writeVariableLivenessGraph

void writeVariableLivenessGraph(VariableLivenessGraph vlGraph,
                                java.nio.file.Path dest)
                         throws java.io.IOException

Generate a GraphViz png for the given VariableLivenessGraph.

Parameters:

vlGraph - The variable liveness graph.

dest - The file to write to.

Throws:

java.io.IOException - Any IO exception whilst generating or writing the graph.

buildVariableLivenessGraphDot

java.lang.String buildVariableLivenessGraphDot(VariableLivenessGraph vlGraph)

Generate a GraphViz Dot graph string for the given VariableLivenessGraph.

Parameters:

vlGraph - The variable liveness graph.

Returns:

The Dot graph string.

startDebugger

void startDebugger(java.lang.String ipAndPort,
                   ClassResolver resolver)

Start an interactive http based web debugger.

Parameters:

ipAndPort - The ip and port to bind to.

resolver - The ClassResolver to use for target, library, and jdk information.

tryIfPresent

static void tryIfPresent(net.covers1624.quack.util.SneakyUtils.ThrowingConsumer<Debugger,java.lang.Throwable> action)

Try to run the given action, if the debugger is available, fire the action with it. Otherwise, log the attempt and do nothing.

Parameters:

action - The action.