processing.mode.java.runner

Class Runner

java.lang.Object

processing.mode.java.runner.Runner

All Implemented Interfaces:

MessageConsumer

public class Runner
extends Object
implements MessageConsumer

Runs a compiled sketch. As of release 0136, all sketches are run externally to the environment so that a debugging interface can be used. This opens up future options for a decent debugger, but in the meantime fixes several problems with output and error streams, messages getting lost on Mac OS X, the run/stop buttons not working, libraries not shutting down, exceptions not coming through, exceptions being printed twice, having to force quit if you make a bad while() loop, and so on.

Field Summary

Fields

Modifier and Type	Field and Description
protected JavaBuild	build
protected boolean	cancelled
protected Object	cancelLock
protected JavaEditor	editor
protected Thread	errThread
protected SketchException	exception
protected RunnerListener	listener
protected Thread	outThread
protected Process	process
protected PrintStream	sketchErr
protected PrintStream	sketchOut
protected com.sun.jdi.VirtualMachine	vm
protected boolean	vmReturnedError

Constructor Summary

Constructors

Constructor and Description
Runner(JavaBuild build, RunnerListener listener)

Method Summary

Modifier and Type	Method and Description
void	close()
com.sun.jdi.VirtualMachine	debug(String[] args) Simple non-blocking launch of the virtual machine.
void	exceptionEvent(com.sun.jdi.event.ExceptionEvent event)
protected com.sun.jdi.connect.Connector	findConnector(String connectorName)
protected SketchException	findException(String message, com.sun.jdi.ObjectReference or, com.sun.jdi.ThreadReference thread) Move through a list of stack frames, searching for references to code found in the current sketch.
protected void	generateTrace() Generate the trace.
protected StringList	getMachineParams()
protected StringList	getSketchParams(boolean present, String[] args)
static boolean	handleCommonErrors(String exceptionClass, String message, RunnerListener listener, PrintStream err) Provide more useful explanations of common error messages, perhaps with a short message in the status area, and (if necessary) a longer message in the console.
com.sun.jdi.VirtualMachine	launch(String[] args)
protected void	launchJava(String[] args)
boolean	launchVirtualMachine(boolean present, String[] args)
void	message(String s)
com.sun.jdi.VirtualMachine	present(String[] args)
protected void	redirectStreams(com.sun.jdi.VirtualMachine vm) Redirect a VMs output and error streams to System.out and System.err
protected void	reportException(String message, com.sun.jdi.ObjectReference or, com.sun.jdi.ThreadReference thread)
com.sun.jdi.VirtualMachine	vm() Additional access to the virtual machine.
boolean	vmReturnedError() Whether the last invocation of launchJava() was successful or not

Methods inherited from class java.lang.Object

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

Field Detail

listener

protected RunnerListener listener

vm

protected volatile com.sun.jdi.VirtualMachine vm

vmReturnedError

protected boolean vmReturnedError

errThread

protected Thread errThread

outThread

protected Thread outThread

exception

protected SketchException exception

editor

protected JavaEditor editor

build

protected JavaBuild build

process

protected Process process

sketchErr

protected PrintStream sketchErr

sketchOut

protected PrintStream sketchOut

cancelled

protected volatile boolean cancelled

cancelLock

protected final Object cancelLock

Constructor Detail

Runner

public Runner(JavaBuild build,
              RunnerListener listener)
       throws SketchException

Throws:

SketchException

Method Detail

launch

public com.sun.jdi.VirtualMachine launch(String[] args)

present

public com.sun.jdi.VirtualMachine present(String[] args)

vmReturnedError

public boolean vmReturnedError()

Whether the last invocation of launchJava() was successful or not

debug

public com.sun.jdi.VirtualMachine debug(String[] args)

Simple non-blocking launch of the virtual machine. VM starts suspended.

Returns:

debuggee VM or null on failure

redirectStreams

protected void redirectStreams(com.sun.jdi.VirtualMachine vm)

Redirect a VMs output and error streams to System.out and System.err

vm

public com.sun.jdi.VirtualMachine vm()

Additional access to the virtual machine. TODO: may not be needed

Returns:

debugge VM or null if not running

launchVirtualMachine

public boolean launchVirtualMachine(boolean present,
                                    String[] args)

getMachineParams

protected StringList getMachineParams()

getSketchParams

protected StringList getSketchParams(boolean present,
                                     String[] args)

launchJava

protected void launchJava(String[] args)

generateTrace

protected void generateTrace()

Generate the trace. Enable events, start thread to display events, start threads to forward remote error and output streams, resume the remote VM, wait for the final event, and shutdown.

findConnector

protected com.sun.jdi.connect.Connector findConnector(String connectorName)

exceptionEvent

public void exceptionEvent(com.sun.jdi.event.ExceptionEvent event)

handleCommonErrors

public static boolean handleCommonErrors(String exceptionClass,
                                         String message,
                                         RunnerListener listener,
                                         PrintStream err)

Provide more useful explanations of common error messages, perhaps with a short message in the status area, and (if necessary) a longer message in the console.

Parameters:

exceptionClass - Class name causing the error (with full package name)

message - The message from the exception

listener - The Editor or command line interface that's listening for errors

Returns:

true if the error was purtified, false otherwise

reportException

protected void reportException(String message,
                               com.sun.jdi.ObjectReference or,
                               com.sun.jdi.ThreadReference thread)

findException

protected SketchException findException(String message,
                                        com.sun.jdi.ObjectReference or,
                                        com.sun.jdi.ThreadReference thread)

Move through a list of stack frames, searching for references to code found in the current sketch. Return with a RunnerException that contains the location of the error, or if nothing is found, just return with a RunnerException that wraps the error message itself.

close

public void close()

message

public void message(String s)

Specified by:

message in interface MessageConsumer