Debugger (Processing Java Mode 3.3.5 API)

java.lang.Object
- processing.mode.java.Debugger

```
public class Debugger
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static interface`	`Debugger.VMEventListener` Interface for VM callbacks.
`protected static class`	`Debugger.VMEventReader` Reader Thread for VM Events.

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<LineBreakpoint>`	`breakpoints`
`protected Set<com.sun.jdi.ReferenceType>`	`classes`
`protected List<ClassLoadListener>`	`classLoadListeners`
`protected com.sun.jdi.ThreadReference`	`currentThread`
`protected JavaEditor`	`editor`
`protected com.sun.jdi.ReferenceType`	`mainClass`
`protected String`	`mainClassName`
`protected boolean`	`paused`
`protected com.sun.jdi.request.StepRequest`	`requestedStep`
`protected Runner`	`runtime`
`protected Map<LineID,LineID>`	`runtimeLineChanges`
`protected Set<String>`	`runtimeTabsTracked`
`protected String`	`srcPath`
`protected boolean`	`started`
`protected Debugger.VMEventListener`	`vmEventListener`

Constructor Summary

Constructors
Constructor and Description

Debugger(JavaEditor editor)

Constructors
Constructor and Description
`Debugger(JavaEditor editor)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addClassLoadListener(ClassLoadListener listener)` Add a class load listener.
`void`	`continueDebug()` Resume paused debugging session.
`protected String`	`currentLocation(com.sun.jdi.ThreadReference t)` Get a description of the current location in a suspended thread.
`protected List<VariableNode>`	`getArrayFields(com.sun.jdi.ArrayReference array)` Get the fields of an array for insertion into a `JTree`.
`Set<com.sun.jdi.ReferenceType>`	`getClasses()` Get the main and nested `ReferenceType`s for the sketch.
`JavaEditor`	`getEditor()`
`List<VariableNode>`	`getFields(com.sun.jdi.Value value, int maxDepth, boolean includeInherited)` Recursively get the fields of a `Value` for insertion into a `JTree`.
`protected List<VariableNode>`	`getFields(com.sun.jdi.Value value, int depth, int maxDepth, boolean includeInherited)` Recursively get the fields of a `Value` for insertion into a `JTree`.
`protected List<VariableNode>`	`getLocals(com.sun.jdi.ThreadReference t, int depth)` Compile a list of current locals usable for insertion into a `JTree`.
`com.sun.jdi.ReferenceType`	`getMainClass()` Retrieve the main class of the debuggee VM.
`protected String`	`getSourceLine(String filePath, int lineNo, int radius)` Read a line from the given file in the builds src folder. 1-based i.e. first line has line no. 1
`protected List<DefaultMutableTreeNode>`	`getStackTrace(com.sun.jdi.ThreadReference t)` Get the current call stack trace usable for insertion into a `JTree`.
`protected List<VariableNode>`	`getThisFields(com.sun.jdi.ThreadReference t, int depth, boolean includeInherited)` Compile a list of fields in the current this object usable for insertion into a `JTree`.
`protected boolean`	`hasBreakpoint(LineID line)` Check if there's a breakpoint on a particular line.
`boolean`	`isBusy()` Check whether the debugger is currently busy. i.e. running (not suspended).
`boolean`	`isPaused()` Check whether the debugger is paused. i.e. it is currently suspended at a breakpoint or step.
`boolean`	`isStarted()` Check whether a debugging session is running. i.e. the debugger is connected to a debuggee VM, VMStartEvent has been received and main class is loaded.
`LineID`	`javaToSketchLine(LineID javaLine)` Translate a line (index) from java space to sketch space.
`protected boolean`	`locationIsVisible(com.sun.jdi.Location l)` Check whether a location corresponds to a code line in the editor.
`protected LineID`	`locationToLineID(com.sun.jdi.Location l)` Translate a java source location to a sketch line id.
`protected String`	`locationToString(com.sun.jdi.Location loc)` Get a string describing a location.
`protected LineID`	`originalToRuntimeLine(LineID line)` Get the runtime-changed line id for an original sketch line.
`protected void`	`printLocalVariables(com.sun.jdi.ThreadReference t)` Print local variables on a suspended thread.
`protected void`	`printSourceLocation(com.sun.jdi.Location l)` Print source code snippet.
`protected void`	`printSourceLocation(com.sun.jdi.ThreadReference t)` Print source code snippet of current location in a suspended thread.
`protected void`	`printStackTrace(com.sun.jdi.ThreadReference t)` Print call stack trace of a thread.
`protected void`	`printThis(com.sun.jdi.ThreadReference t)` Print visible fields of current "this" object on a suspended thread.
`protected void`	`printThread(com.sun.jdi.ThreadReference t)` Print info about a thread.
`void`	`printThreads()` Print info about all current threads.
`protected void`	`printType(com.sun.jdi.ReferenceType rt)` Print info about a ReferenceType.
`void`	`removeClassLoadListener(ClassLoadListener listener)` Remove a class load listener.
`protected void`	`resumeOtherThreads(com.sun.jdi.ThreadReference t)` Resume all other threads except the one given as parameter.
`protected LineID`	`runtimeToOriginalLine(LineID line)` Get the original line id for a sketch line that was changed at runtime.
`LineID`	`sketchToJavaLine(LineID sketchLine)` Translate a line (index) from sketch space to java space.
`void`	`startDebug()` Start a debugging session.
`protected void`	`startTrackingLineChanges()` Start tracking all line changes (due to edits) in the current tab.
`protected void`	`step(int stepDepth)` Step through source code lines.
`void`	`stepInto()` Step into current statement.
`void`	`stepOut()` Step out of current statement.
`protected void`	`stepOutIntoViewOrContinue()` Step out if this results in a visible location, otherwise continue.
`void`	`stepOver()` Step over current statement.
`void`	`stopDebug()` End debugging session.
`protected void`	`stopTrackingLineChanges()` Stop tracking line changes in all tabs.
`protected String`	`thisName(com.sun.jdi.ThreadReference t)` Get the class name of the current this object in a suspended thread.
`protected String`	`threadStatusToString(int status)` Convert a status code returned by `ThreadReference.status()` to a human readable form.
`protected void`	`updateVariableInspector(com.sun.jdi.ThreadReference t)` Update variable inspector window.
`com.sun.jdi.VirtualMachine`	`vm()`
`void`	`vmEvent(com.sun.jdi.event.EventSet es)` Callback for VM events.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - editor
```
protected JavaEditor editor
```
  - runtime
```
protected Runner runtime
```
  - started
```
protected boolean started
```
  - paused
```
protected boolean paused
```
  - currentThread
```
protected com.sun.jdi.ThreadReference currentThread
```
  - mainClassName
```
protected String mainClassName
```
  - mainClass
```
protected com.sun.jdi.ReferenceType mainClass
```
  - classes
```
protected Set<com.sun.jdi.ReferenceType> classes
```
  - classLoadListeners
```
protected List<ClassLoadListener> classLoadListeners
```
  - srcPath
```
protected String srcPath
```
  - breakpoints
```
protected List<LineBreakpoint> breakpoints
```
  - requestedStep
```
protected com.sun.jdi.request.StepRequest requestedStep
```
  - runtimeLineChanges
```
protected Map<LineID,LineID> runtimeLineChanges
```
  - runtimeTabsTracked
```
protected Set<String> runtimeTabsTracked
```
  - vmEventListener
```
protected Debugger.VMEventListener vmEventListener
```
- Constructor Detail
  - Debugger
```
public Debugger(JavaEditor editor)
```
- Method Detail
  - vm
```
public com.sun.jdi.VirtualMachine vm()
```
  - getEditor
```
public JavaEditor getEditor()
```
  - getMainClass
```
public com.sun.jdi.ReferenceType getMainClass()
```
    Retrieve the main class of the debuggee VM.
    
    Returns:
    
    the main classes ReferenceType or null if the debugger is not started.
  - getClasses
```
public Set<com.sun.jdi.ReferenceType> getClasses()
```
    Get the main and nested ReferenceTypes for the sketch.
    
    Returns:
    
    a list of main and nested ReferenceTypes, empty list if nothing found (e.g. not yet loaded)
  - addClassLoadListener
```
public void addClassLoadListener(ClassLoadListener listener)
```
    Add a class load listener. Will be notified when a class is loaded in the debuggee VM.
    
    Parameters:
    
    listener - the ClassLoadListener
  - removeClassLoadListener
```
public void removeClassLoadListener(ClassLoadListener listener)
```
    Remove a class load listener. Cease to be notified when classes are loaded in the debuggee VM.
    
    Parameters:
    
    listener - ClassLoadListener
  - startDebug
```
public void startDebug()
```
    Start a debugging session. Builds the sketch and launches a VM to run it. VM starts suspended. Should produce a VMStartEvent.
  - stopDebug
```
public void stopDebug()
```
    End debugging session. Stops and disconnects VM. Should produce VMDisconnectEvent.
  - continueDebug
```
public void continueDebug()
```
    Resume paused debugging session. Resumes VM.
  - step
```
protected void step(int stepDepth)
```
    Step through source code lines.
    
    Parameters:
    
    stepDepth - the step depth (StepRequest.STEP_OVER, StepRequest.STEP_INTO or StepRequest.STEP_OUT)
  - stepOver
```
public void stepOver()
```
    Step over current statement.
  - stepInto
```
public void stepInto()
```
    Step into current statement.
  - stepOut
```
public void stepOut()
```
    Step out of current statement.
  - hasBreakpoint
```
protected boolean hasBreakpoint(LineID line)
```
    Check if there's a breakpoint on a particular line.
    
    Parameters:
    
    line - the line id
    
    Returns:
    
    true if a breakpoint is set on the given line, otherwise false
  - vmEvent
```
public void vmEvent(com.sun.jdi.event.EventSet es)
```
    Callback for VM events. Will be called from another thread. (Debugger.VMEventReader)
    
    Parameters:
    
    es - Incoming set of events from VM
  - locationIsVisible
```
protected boolean locationIsVisible(com.sun.jdi.Location l)
```
    Check whether a location corresponds to a code line in the editor.
    
    Parameters:
    
    l - the location
    
    Returns:
    
    true if the location corresponds to a line in the editor
  - stepOutIntoViewOrContinue
```
protected void stepOutIntoViewOrContinue()
```
    Step out if this results in a visible location, otherwise continue.
  - isStarted
```
public boolean isStarted()
```
    Check whether a debugging session is running. i.e. the debugger is connected to a debuggee VM, VMStartEvent has been received and main class is loaded.
    
    Returns:
    
    true if the debugger is started.
  - isPaused
```
public boolean isPaused()
```
    Check whether the debugger is paused. i.e. it is currently suspended at a breakpoint or step.
    
    Returns:
    
    true if the debugger is paused, false otherwise or if not started (isStarted())
  - isBusy
```
public boolean isBusy()
```
    Check whether the debugger is currently busy. i.e. running (not suspended).
    
    Returns:
    
    true if the debugger is currently running and not suspended.
  - printStackTrace
```
protected void printStackTrace(com.sun.jdi.ThreadReference t)
```
    Print call stack trace of a thread. Only works on suspended threads.
    
    Parameters:
    
    t - suspended thread to print stack trace of
  - resumeOtherThreads
```
protected void resumeOtherThreads(com.sun.jdi.ThreadReference t)
```
    Resume all other threads except the one given as parameter. Useful e.g. to just keep the thread suspended a breakpoint occurred in.
    
    Parameters:
    
    t - the thread not to resume
  - printThreads
```
public void printThreads()
```
    Print info about all current threads. Includes name, status, isSuspended, isAtBreakpoint.
  - printThread
```
protected void printThread(com.sun.jdi.ThreadReference t)
```
    Print info about a thread. Includes name, status, isSuspended, isAtBreakpoint.
    
    Parameters:
    
    t - the thread to print info about
  - threadStatusToString
```
protected String threadStatusToString(int status)
```
    Convert a status code returned by ThreadReference.status() to a human readable form.
    
    Parameters:
    
    status - ThreadReference.THREAD_STATUS_MONITOR, ThreadReference.THREAD_STATUS_NOT_STARTED, ThreadReference.THREAD_STATUS_RUNNING, ThreadReference.THREAD_STATUS_SLEEPING, ThreadReference.THREAD_STATUS_UNKNOWN, ThreadReference.THREAD_STATUS_WAIT or ThreadReference.THREAD_STATUS_ZOMBIE
    
    Returns:
    
    String containing readable status code.
  - printLocalVariables
```
protected void printLocalVariables(com.sun.jdi.ThreadReference t)
```
    Print local variables on a suspended thread. Takes the topmost stack frame and lists all local variables and their values.
    
    Parameters:
    
    t - suspended thread
  - updateVariableInspector
```
protected void updateVariableInspector(com.sun.jdi.ThreadReference t)
```
    Update variable inspector window. Displays local variables and this fields.
    
    Parameters:
    
    t - suspended thread to retrieve locals and this
  - thisName
```
protected String thisName(com.sun.jdi.ThreadReference t)
```
    Get the class name of the current this object in a suspended thread.
    
    Parameters:
    
    t - a suspended thread
    
    Returns:
    
    the class name of this
  - currentLocation
```
protected String currentLocation(com.sun.jdi.ThreadReference t)
```
    Get a description of the current location in a suspended thread. Format: class.method:translated_line_number
    
    Parameters:
    
    t - a suspended thread
    
    Returns:
    
    descriptive string for the given location
  - locationToString
```
protected String locationToString(com.sun.jdi.Location loc)
```
    Get a string describing a location. Format: class.method:translated_line_number
    
    Parameters:
    
    loc - a location
    
    Returns:
    
    descriptive string for the given location
  - getLocals
```
protected List<VariableNode> getLocals(com.sun.jdi.ThreadReference t,
                                       int depth)
```
    Compile a list of current locals usable for insertion into a JTree. Recursively resolves object references.
    
    Parameters:
    
    t - the suspended thread to get locals for
    
    depth - how deep to resolve nested object references. 0 will not resolve nested objects.
    
    Returns:
    
    the list of current locals
  - getThisFields
```
protected List<VariableNode> getThisFields(com.sun.jdi.ThreadReference t,
                                           int depth,
                                           boolean includeInherited)
```
    Compile a list of fields in the current this object usable for insertion into a JTree. Recursively resolves object references.
    
    Parameters:
    
    t - the suspended thread to get locals for
    
    depth - how deep to resolve nested object references. 0 will not resolve nested objects.
    
    Returns:
    
    the list of fields in the current this object
  - getFields
```
protected List<VariableNode> getFields(com.sun.jdi.Value value,
                                       int depth,
                                       int maxDepth,
                                       boolean includeInherited)
```
    Recursively get the fields of a Value for insertion into a JTree.
    
    Parameters:
    
    value - must be an instance of ObjectReference
    
    depth - the current depth
    
    maxDepth - the depth to stop at (inclusive)
    
    Returns:
    
    list of child fields of the given value
  - getFields
```
public List<VariableNode> getFields(com.sun.jdi.Value value,
                                    int maxDepth,
                                    boolean includeInherited)
```
    Recursively get the fields of a Value for insertion into a JTree.
    
    Parameters:
    
    value - must be an instance of ObjectReference
    
    maxDepth - max recursion depth. 0 will give only direct children
    
    Returns:
    
    list of child fields of the given value
  - getArrayFields
```
protected List<VariableNode> getArrayFields(com.sun.jdi.ArrayReference array)
```
    Get the fields of an array for insertion into a JTree.
    
    Parameters:
    
    array - the array reference
    
    Returns:
    
    list of array fields
  - getStackTrace
```
protected List<DefaultMutableTreeNode> getStackTrace(com.sun.jdi.ThreadReference t)
```
    Get the current call stack trace usable for insertion into a JTree.
    
    Parameters:
    
    t - the suspended thread to retrieve the call stack from
    
    Returns:
    
    call stack as list of DefaultMutableTreeNodes
  - printThis
```
protected void printThis(com.sun.jdi.ThreadReference t)
```
    Print visible fields of current "this" object on a suspended thread. Prints type, name and value.
    
    Parameters:
    
    t - suspended thread
  - printSourceLocation
```
protected void printSourceLocation(com.sun.jdi.ThreadReference t)
```
    Print source code snippet of current location in a suspended thread.
    
    Parameters:
    
    t - suspended thread
  - printSourceLocation
```
protected void printSourceLocation(com.sun.jdi.Location l)
```
    Print source code snippet.
    
    Parameters:
    
    l - Location object to print source code for
  - getSourceLine
```
protected String getSourceLine(String filePath,
                               int lineNo,
                               int radius)
```
    Read a line from the given file in the builds src folder. 1-based i.e. first line has line no. 1
    
    Parameters:
    
    filePath -
    
    lineNo -
    
    Returns:
    
    the requested source line
  - printType
```
protected void printType(com.sun.jdi.ReferenceType rt)
```
    Print info about a ReferenceType. Prints class name, source file name, lists methods.
    
    Parameters:
    
    rt - the reference type to print out
  - locationToLineID
```
protected LineID locationToLineID(com.sun.jdi.Location l)
```
    Translate a java source location to a sketch line id.
    
    Parameters:
    
    l - the location to translate
    
    Returns:
    
    the corresponding line id, or null if not found
  - javaToSketchLine
```
public LineID javaToSketchLine(LineID javaLine)
```
    Translate a line (index) from java space to sketch space.
    
    Parameters:
    
    javaLine - the java line id
    
    Returns:
    
    the corresponding sketch line id or null if failed to translate
  - originalToRuntimeLine
```
protected LineID originalToRuntimeLine(LineID line)
```
    Get the runtime-changed line id for an original sketch line. Used to translate line numbers from the VM (which runs on the original line numbers) to their current (possibly changed) counterparts.
    
    Parameters:
    
    line - the original line id (at compile time)
    
    Returns:
    
    the changed version or the line given as parameter if not found
  - runtimeToOriginalLine
```
protected LineID runtimeToOriginalLine(LineID line)
```
    Get the original line id for a sketch line that was changed at runtime. Used to translate line numbers from the UI at runtime (which can differ from the ones the VM runs on) to their original counterparts.
    
    Parameters:
    
    line - the (possibly) changed runtime line
    
    Returns:
    
    the original line or the line given as parameter if not found
  - sketchToJavaLine
```
public LineID sketchToJavaLine(LineID sketchLine)
```
    Translate a line (index) from sketch space to java space.
    
    Parameters:
    
    sketchLine - the sketch line id
    
    Returns:
    
    the corresponding java line id or null if failed to translate
  - startTrackingLineChanges
```
protected void startTrackingLineChanges()
```
    Start tracking all line changes (due to edits) in the current tab.
  - stopTrackingLineChanges
```
protected void stopTrackingLineChanges()
```
    Stop tracking line changes in all tabs.

Class Debugger

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

editor

runtime

started

paused

currentThread

mainClassName

mainClass

classes

classLoadListeners

srcPath

breakpoints

requestedStep

runtimeLineChanges

runtimeTabsTracked

vmEventListener

Constructor Detail

Debugger

Method Detail

vm

getEditor

getMainClass

getClasses

addClassLoadListener

removeClassLoadListener

startDebug

stopDebug

continueDebug

step

stepOver

stepInto

stepOut

hasBreakpoint

vmEvent

locationIsVisible

stepOutIntoViewOrContinue

isStarted

isPaused

isBusy

printStackTrace

resumeOtherThreads

printThreads

printThread

threadStatusToString

printLocalVariables

updateVariableInspector

thisName

currentLocation

locationToString

getLocals

getThisFields

getFields

getFields

getArrayFields

getStackTrace

printThis

printSourceLocation

printSourceLocation

getSourceLine

printType

locationToLineID

javaToSketchLine

originalToRuntimeLine

runtimeToOriginalLine

sketchToJavaLine

startTrackingLineChanges

stopTrackingLineChanges