python running concurrently and builds are lightening-fast!

Author: kazimuth

release/PythonMode.zip

@@ -17,28 +17,28 @@
  */
 
 public class Communicator {
-	private PythonEditor editor;
+	private PythonRunner runner;
 	private Process sketchProcess;
 
 	private StreamRedirectThread outThread;
 	private MessageReceiverThread errThread;
 
 	private PrintWriter toSketch;
 
-	public Communicator (Process sketchProcess, PythonEditor editor){
+	public Communicator (Process sketchProcess, PythonRunner runner){
 		this.sketchProcess = sketchProcess;
-		this.editor = editor;
+		this.runner = runner;
 
 		outThread = new StreamRedirectThread("JVM Stdout Reader", sketchProcess.getInputStream(), System.out);
-		errThread = new MessageReceiverThread(sketchProcess.getErrorStream(), editor);
+		errThread = new MessageReceiverThread(sketchProcess.getErrorStream(), runner);
 
 		toSketch = new PrintWriter(sketchProcess.getOutputStream());
 
 		outThread.start();
 		errThread.start();
 	}
 
-	public void close(){
+	public void destroy(){
 		errThread.running = false;
 		errThread = null;
 		outThread = null;
@@ -54,6 +54,7 @@ public void close(){
 	 */
 	public void sendClose(){
 		toSketch.println("__STOP__"); //hard-coded, what the hell
+		System.out.println("__STOP__");
 		toSketch.flush();
 	}
 
@@ -68,19 +69,20 @@ public void sendSketch(String[] args){
 
 
 		toSketch.println(out.toString());
-		
+		System.out.println(out.toString());
+		toSketch.flush();
 	}
 
 	//private class to handle doing things when the sketch process sends us a message via system.err
 	private class MessageReceiverThread extends Thread{
-		PythonEditor editor;
+		PythonRunner runner;
 		BufferedReader messageReader;
 
 		public boolean running;
 
-		public MessageReceiverThread(InputStream messageStream, PythonEditor editor){
+		public MessageReceiverThread(InputStream messageStream, PythonRunner runner){
 			this.messageReader = new BufferedReader(new InputStreamReader(messageStream));
-			this.editor = editor;
+			this.runner = runner;
 			this.running = true;
 		}
 
@@ -90,19 +92,13 @@ public void run() {
 
 				// continually read messages
 				while ((currentLine = messageReader.readLine()) != null && running) {
-					if (currentLine.indexOf(PApplet.EXTERNAL_STOP) == 0) {
+					if (currentLine.indexOf("__STOPPED__") != -1) {
 						// sketch telling us it stopped
-						editor.internalCloseRunner();
-						return;
-					}else if (currentLine.indexOf(PApplet.EXTERNAL_MOVE) == 0) {
-						//sketch telling us it moved
-						String nums = currentLine.substring(currentLine.indexOf(' ') + 1).trim();
-						int space = nums.indexOf(' ');
-						int left = Integer.parseInt(nums.substring(0, space));
-						int top = Integer.parseInt(nums.substring(space + 1));
-						editor.setSketchLocation(new Point(left, top));
+						runner.parallelStopped();
 						return;
-					}else{
+					}else if(currentLine.indexOf("__STARTED__") != -1){
+						runner.parallelStarted();
+					} else{
 						System.err.println(currentLine);
 					}
 				}

src/info/sansgills/mode/python/Communicator.java

@@ -34,6 +34,8 @@ public class PythonEditor extends Editor {
 	protected PythonEditor(final Base base, String path, EditorState state, final Mode mode) {
 		super(base, path, state, mode);
 
+		runner = new PythonRunner(this);
+		
 		listener = new PythonKeyListener(this, textarea); //black magic
 		pyMode = (PythonMode) mode; //convenience
 	}
@@ -132,7 +134,6 @@ public void handleExportApplication() {
 
 	//Note that I'm doing the build here instead of in PythonMode, because of simplicity
 	public void handleRun() {
-		final PythonEditor self = this; //there must be a more elegant way to do this.
 		new Thread(new Runnable(){
 			public void run(){
 				toolbar.activate(PythonToolbar.RUN);			//pretty lights
@@ -143,14 +144,12 @@ public void run(){
 				} catch (Exception e){
 					statusError(e);								//do something pretty?
 				}
-				runner = new PythonRunner(build, self);			//create runtime (can't use 'this', this is a runnable)
-				runner.launch(false);							//launch runtime; present = false
+				runner.launch(build, false);							//launch runtime; present = false
 			}
 		}).start();
 	}
 
 	public void handlePresent() {
-		final PythonEditor self = this;
 		new Thread(new Runnable() {
 			public void run() {
 				toolbar.activate(PythonToolbar.RUN);
@@ -161,19 +160,15 @@ public void run() {
 				} catch (Exception e){
 					statusError(e);
 				}
-				runner = new PythonRunner(build, self);
-				runner.launch(true);							//present = true
+				runner.launch(build, true);							//present = true
 			}
 		}).start();
 	}
 
 	public void handleStop() { //copied wholesale from Java Mode
 		toolbar.activate(PythonToolbar.STOP);
 		try {
-	      if (runner != null) {
-	        runner.close();  // kills the window
-	        runner = null;
-	      }
+	      runner.internalClose();
 	    } catch (Exception e) {
 	      statusError(e);
 	    }

src/info/sansgills/mode/python/PythonEditor.java

@@ -27,50 +27,83 @@ public class PythonRunner {
 	// Threads to redirect output / error streams from process to us
 	Communicator communicator;
 
-	public PythonRunner(PythonBuild build, PythonEditor editor) {
-		this.build = build;
+	boolean active;
+	
+	public PythonRunner(PythonEditor editor) {
 		this.editor = editor;
+		active = false;
+		
+		//make sure our partner process is dead
+		Runtime.getRuntime().addShutdownHook(new Thread(new Runnable() {
+			public void run() {
+				if (communicator != null) {
+					communicator.destroy();
+				}
+				if(sketchProcess != null) {
+					sketchProcess.destroy();
+				}
+			}
+		}));
 	}
-
+	
 	/*
 	 * Run the code.
 	 */
-	public void launch(boolean present) {
-		exec(buildArgs(present));
+	public void launch(PythonBuild build, boolean present) {
+		this.build = build;
+		ensureParallel();
+		communicator.sendSketch(buildSketchArgs(present));
+	}
+
+	/*
+	 * Kill the code.
+	 */
+	public void internalClose() {
+		//Closed from editor button
+		ensureParallel();
+		System.out.println("Closing...");
+		communicator.sendClose();
 	}
 
 	/*
-	 * Construct the command-line command to start the sketch with
-	 * 
-	 * TODO add proper machine detection & whatnot from Java Mode
-	 * 
+	 * Make sure we've got a process to run the code.
 	 */
-	private String[] buildArgs(boolean present){
-		ArrayList<String> args = new ArrayList<String>();
-		
-		// Manage java
-		appendJavaArgs(args);
-		
-		// Manage Python Mode
-		args.add("-cp");
-		args.add(build.getClassPath());
-
-		args.add("info.sansgills.mode.python.wrapper.ProcessingJythonWrapper"); // main class
-		
-		args.add(build.getResultFile());	//path to script
-		
-		appendSketchArgs(args, present);
-				
-		String[] out = args.toArray(new String[0]);
-				
-		return out;
+	private void ensureParallel(){
+		if(sketchProcess == null){
+			if(build == null){
+				System.err.println("need a build");
+				return;
+			}
+			sketchProcess = PApplet.exec(buildJavaArgs());
+			communicator = new Communicator(sketchProcess, this);
+		}
 	}
-
+	
+	
+	public void parallelStopped() {
+		//Closed from sketch window
+		if(active){
+			active = false;
+			System.out.println("Closed");
+		}else{
+			System.err.println("something is wrong");
+		}
+	}
+	public void parallelStarted(){
+		if(!active){
+			active = true;
+		}else{
+			System.err.println("something is very wrong");
+		}
+	}
+	
 	/*
-	 * Create the proper args to run the jvm with
+	 * Command to start the companion process
 	 */
-	private void appendJavaArgs(ArrayList<String> args) {
+	private String[] buildJavaArgs() {
+		ArrayList<String> args = new ArrayList<String>();
 
+		// Manage java
 		// special handling for base command for OS X- from Java Mode
 		if (!Base.isMacOS()) {
 			args.add("java");
@@ -97,7 +130,7 @@ private void appendJavaArgs(ArrayList<String> args) {
 				}
 			}
 		}
-		
+
 		// Memory
 		if (Preferences.getBoolean("run.options.memory")) {
 			args.add("-Xms" + Preferences.get("run.options.memory.initial") + "m");
@@ -108,69 +141,48 @@ private void appendJavaArgs(ArrayList<String> args) {
 		if (Base.isMacOS()) {
 			args.add("-Xdock:name=" + build.getClassName());
 		}
-		
+
 		// Path to the libraryies we use
 		// TODO what's the difference between classpath and library path?
-		args.add("-Djava.library.path=" 
-				+ build.getJavaLibraryPath()
-				+ File.pathSeparator 
-				+ System.getProperty("java.library.path"));
+		args.add("-Djava.library.path=" + build.getJavaLibraryPath()
+				+ File.pathSeparator + System.getProperty("java.library.path"));
+		
+		// Manage Python Mode
+		args.add("-cp");
+		args.add(build.getClassPath());
+
+		args.add("info.sansgills.mode.python.wrapper.ProcessingJythonWrapper"); // main class
+		
+		//we parallel
+		args.add("--parallel");
+
+		return args.toArray(new String[0]);
 
 	}
 
 	/*
-	 * Sketch-specific stuff
+	 * Arguments for individual sketches
 	 */
-	private void appendSketchArgs(ArrayList<String> args, boolean present){
-		// place the sketch
-		// TODO handle multiple displays
-		Point windowLocation = editor.getSketchLocation();
-		if (windowLocation != null) {
-			// saved location - sketch run more than once
-			args.add(PApplet.ARGS_LOCATION 
-					+ "=" 
-					+ windowLocation.x + "," + windowLocation.y);
-		} else {
-			// tell PApplet where the editor is and let it sort itself out
-			Point editorLocation = editor.getLocation();
-			args.add(PApplet.ARGS_EDITOR_LOCATION 
-					+ "=" 
-					+ editorLocation.x + "," + editorLocation.y);
-		}
+	private String[] buildSketchArgs(boolean present) {
+		ArrayList<String> args = new ArrayList<String>();
+
+		args.add("--script="+build.getResultFile()); // path to script
+
+		// tell PApplet where the editor is and let it sort itself out
+		Point editorLocation = editor.getLocation();
+		args.add(PApplet.ARGS_EDITOR_LOCATION + "=" + editorLocation.x + ","
+				+ editorLocation.y);
 
 		if (present) {
 			args.add(PApplet.ARGS_FULL_SCREEN);
-			args.add(PApplet.ARGS_STOP_COLOR + "=" + Preferences.get("run.present.stop.color"));
-			args.add(PApplet.ARGS_BGCOLOR + "=" + Preferences.get("run.present.bgcolor"));
+			args.add(PApplet.ARGS_STOP_COLOR + "="
+					+ Preferences.get("run.present.stop.color"));
+			args.add(PApplet.ARGS_BGCOLOR + "="
+					+ Preferences.get("run.present.bgcolor"));
 		}
-		
-		
-		args.add(PApplet.ARGS_EXTERNAL);
-		args.add(build.getClassName()); // sketch name
-	}
-	
-	/*
-	 * Start the process & a thread to track it
-	 */
-	private void exec(final String[] args){
-		new Thread(new Runnable(){
-			public void run(){
-				sketchProcess = PApplet.exec(args);
-				communicator = new Communicator(sketchProcess, editor);
-				try{
-					int result = sketchProcess.waitFor();
-				}catch(InterruptedException e){
-					System.out.println("error:");
-					e.printStackTrace();
-				}
-			}
-		}).start();
-	}
-	
-	/*
-	 * Kill the code.
-	 */
-	public void close() {
-		communicator.sendClose();
+
+		args.add(build.getClassName()); // sketch name MUST BE LAST
+
+		return args.toArray(new String[0]);
 	}
 }