Merge branch 'master' into release-2.6.1

Author: itoshkov

HackPackage/src/main/java/Hack/Controller/HackController.java

@@ -37,7 +37,7 @@
 
 /**
  * A Controller for HackSimulators. Executes scripts written in a special scripting language
- * that controlls the features of the simulators.
+ * that controls the features of the simulators.
  * Constructed with a GUI that enables the execution control of the script.
  */
 public class HackController
@@ -56,7 +56,7 @@ public class HackController
     /**
      * The speed function for fast forward mode.
      */
-    public static final int[] FASTFORWARD_SPEED_FUNCTION = {500, 1000, 2000, 4000, 15000};
+    private static final int[] FASTFORWARD_SPEED_FUNCTION = {500, 1000, 2000, 4000, 15000};
 
     // ANIMATION MODES:
 
@@ -127,6 +127,10 @@ public class HackController
     // A helper string with spaces
     private static final String SPACES = "                                        ";
     private static final String DIRECTORY = "directory";
+    private static final String SPEED = "speed";
+    private static final String ANIMATION_MODE = "animation_mode";
+    private static final String NUMERIC_FORMAT = "numeric_format";
+    private final Preferences preferences;
 
     // The controller's GUI
     protected ControllerGUI gui;
@@ -229,6 +233,7 @@ public class HackController
      * The script will be executed and the final result will be printed.
      */
     public HackController(HackSimulator simulator, String scriptFileName) {
+        this.preferences = Preferences.userNodeForPackage(simulator.getClass());
         File file = new File(scriptFileName);
         if (!file.exists())
             displayMessage(scriptFileName + " doesn't exist", true);
@@ -241,10 +246,8 @@ public HackController(HackSimulator simulator, String scriptFileName) {
         try {
             loadNewScript(file, false);
             saveWorkingDir(file);
-        } catch (ScriptException se) {
+        } catch (ScriptException | ControllerException se) {
             displayMessage(se.getMessage(), true);
-        } catch (ControllerException ce) {
-            displayMessage(ce.getMessage(), true);
         }
 
         fastForwardRunning = true;
@@ -260,6 +263,7 @@ public HackController(HackSimulator simulator, String scriptFileName) {
     public HackController(ControllerGUI gui, HackSimulator simulator, String defaultScriptName)
      throws ScriptException, ControllerException {
 
+        this.preferences = Preferences.userNodeForPackage(simulator.getClass());
         this.gui = gui;
         this.simulator = simulator;
         singleStepTask = new SingleStepTask();
@@ -276,26 +280,27 @@ public HackController(ControllerGUI gui, HackSimulator simulator, String default
         for (int i = 0; i < NUMBER_OF_SPEED_UNITS; i++)
             delays[i] = (int)(MAX_MS - SPEED_FUNCTION[i] * (float)(MAX_MS - MIN_MS));
 
-        currentSpeedUnit = INITIAL_SPEED_UNIT;
-        animationMode = simulator.getInitialAnimationMode();
+        currentSpeedUnit = preferences.getInt(SPEED, INITIAL_SPEED_UNIT);
+        animationMode = preferences.getInt(ANIMATION_MODE, simulator.getInitialAnimationMode());
         simulator.setAnimationMode(animationMode);
-        simulator.setAnimationSpeed(INITIAL_SPEED_UNIT);
-        simulator.setNumericFormat(simulator.getInitialNumericFormat());
+        simulator.setAnimationSpeed(currentSpeedUnit);
+        final int numericFormat = preferences.getInt(NUMERIC_FORMAT, simulator.getInitialNumericFormat());
+        simulator.setNumericFormat(numericFormat);
         timer = new Timer(delays[currentSpeedUnit - 1], this);
 
         // adds the simulator component to the controller component
         gui.setSimulator(simulator.getGUI());
         gui.setTitle(simulator.getName() + getVersionString());
 
         // load and set working dir
-        File file = loadWorkingDir();
+        File file = new File(preferences.get(DIRECTORY, "."));
         simulator.setWorkingDir(file);
         gui.setWorkingDir(file);
 
         gui.addControllerListener(this);
         gui.setSpeed(currentSpeedUnit);
         gui.setAnimationMode(animationMode);
-        gui.setNumericFormat(simulator.getInitialNumericFormat());
+        gui.setNumericFormat(numericFormat);
         gui.setAdditionalDisplay(simulator.getInitialAdditionalDisplay());
         gui.setVariables(simulator.getVariables());
 
@@ -443,14 +448,8 @@ else if (breakpoint.isReached()) {
             if (breakpointReached)
                 tempBreakpoints.clear();
 
-        } catch (ControllerException ce) {
+        } catch (ControllerException | ProgramException | CommandException | VariableException ce) {
             stopWithError(ce);
-        } catch (ProgramException pe) {
-            stopWithError(pe);
-        } catch (CommandException ce) {
-            stopWithError(ce);
-        } catch (VariableException ve) {
-            stopWithError(ve);
         }
 
         singleStepLocked = false;
@@ -736,7 +735,7 @@ private void outputAndCompare(String line) throws ControllerException {
     }
 
     // loads the given script file and restarts the GUI.
-    protected void loadNewScript(File file, boolean displayMessage)
+    private void loadNewScript(File file, boolean displayMessage)
      throws ControllerException, ScriptException {
         currentScriptFile = file;
         script = new Script(file.getPath());
@@ -793,6 +792,8 @@ private void setSpeed(int newSpeedUnit) {
         currentSpeedUnit = newSpeedUnit;
         timer.setDelay(delays[currentSpeedUnit - 1]);
         simulator.setAnimationSpeed(newSpeedUnit);
+        preferences.putInt(SPEED, newSpeedUnit);
+        savePreferences();
     }
 
     // Sets the animation mode with the given one.
@@ -806,12 +807,16 @@ private void setAnimationMode(int newAnimationMode) {
 
         gui.setAnimationMode(newAnimationMode);
         animationMode = newAnimationMode;
+        preferences.putInt(ANIMATION_MODE, newAnimationMode);
+        savePreferences();
     }
 
     // Sets the numeric format with the given code.
     private void setNumericFormat(int formatCode) {
         simulator.setNumericFormat(formatCode);
         gui.setNumericFormat(formatCode);
+        preferences.putInt(NUMERIC_FORMAT, formatCode);
+        savePreferences();
     }
 
     // Sets the additional display with the given code.
@@ -865,15 +870,8 @@ private void displayMessage(String message, boolean error) {
         }
     }
 
-    // Returns the working dir that is saved in the data file, or "" if data file doesn't exist.
-    protected File loadWorkingDir() {
-        final Preferences preferences = Preferences.userNodeForPackage(simulator.getClass());
-        final String dir = preferences.get(DIRECTORY, ".");
-        return new File(dir);
-    }
-
     // Saves the given working dir into the data file and gui's.
-    protected void saveWorkingDir(File file) {
+    private void saveWorkingDir(File file) {
         final File parent = file.getParentFile();
 
         if (gui != null)
@@ -883,8 +881,11 @@ protected void saveWorkingDir(File file) {
 
         final File dir = file.isDirectory() ? file : parent;
 
-        final Preferences preferences = Preferences.userNodeForPackage(simulator.getClass());
         preferences.put(DIRECTORY, dir.toString());
+        savePreferences();
+    }
+
+    private void savePreferences() {
         try {
             preferences.sync();
         } catch (BackingStoreException ignored) {
@@ -904,8 +905,7 @@ protected void reloadDefaultScript() {
             try {
                 loadNewScript(defaultScriptFile, false);
                 rewind();
-            } catch (ScriptException ignored) {
-            } catch (ControllerException ignored) {
+            } catch (ScriptException | ControllerException ignored) {
             }
         }
     }
@@ -1061,10 +1061,7 @@ public void actionPerformed(ControllerEvent event) {
                     doUnknownAction(event.getAction(), event.getData());
                     break;
             }
-        } catch (ScriptException e) {
-            displayMessage(e.getMessage(), true);
-            stopMode();
-        } catch (ControllerException e) {
+        } catch (ScriptException | ControllerException e) {
             displayMessage(e.getMessage(), true);
             stopMode();
         }
@@ -1077,7 +1074,7 @@ protected void doUnknownAction(byte action, Object data) throws ControllerExcept
     }
 
     // Performs the single step task
-    class SingleStepTask implements Runnable {
+    private class SingleStepTask implements Runnable {
 
         public void run() {
             singleStep();
@@ -1100,7 +1097,7 @@ public void run() {
     }
 
     // Performs the fast forward task
-    class FastForwardTask implements Runnable {
+    private class FastForwardTask implements Runnable {
         public synchronized void run() {
             try {
                 System.runFinalization();
@@ -1132,7 +1129,7 @@ public synchronized void run() {
     }
 
     // Sets the animation mode
-    class SetAnimationModeTask implements Runnable {
+    private class SetAnimationModeTask implements Runnable {
 
         private int animationMode;
 
@@ -1146,7 +1143,7 @@ public void run() {
     }
 
     // Sets the numeric format
-    class SetNumericFormatTask implements Runnable {
+    private class SetNumericFormatTask implements Runnable {
 
         private int numericFormat;
 

InstallDir/VMEmulator.sh

@@ -1,3 +1,11 @@
-#!/bin/sh
-cd `dirname $0`
-java -jar ../VMEmulator/target/VMEmulator-*.jar $@
+#!/bin/bash
+cd $(dirname $0)
+if [[ $# -eq 0 ]]; then
+    java -jar ../VMEmulator/target/VMEmulator-*.jar
+elif [[ $# -eq 1 ]]; then
+    [ -z "$N2T_VM_USE_BUILTINS" ] && export N2T_VM_USE_BUILTINS="yes"
+    java -jar ../VMEmulator/target/VMEmulator-*.jar "$1"
+else
+    echo "The program expects 0 or 1 arguments!"
+    exit 1
+fi

SimulatorsPackage/src/main/java/Hack/VMEmulator/BuiltInFunctionsRunner.java

@@ -19,8 +19,10 @@
 
 import Hack.Controller.ProgramException;
 import Hack.Utilities.Definitions;
+
 import java.io.File;
-import java.lang.reflect.*;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
 
 /**
  * A class that runs built-in VM code as a coroutine so that
@@ -89,7 +91,9 @@ public BuiltInFunctionsRunner(CPU cpu, File builtInDir) {
 		builtInToProgram = new BuiltInToProgramRequest();
 		programToBuiltIn = new ProgramToBuiltInRequest();
 		synchronized (this) {
-			new Thread(this).start();
+			final Thread thread = new Thread(this, "built-in-functions");
+			thread.setDaemon(true);
+			thread.start();
 			continueOtherThread(); // Let the built-in code runner init itself
 								   // The notify part of this call does nothing
 		}

SimulatorsPackage/src/main/java/Hack/VMEmulator/VMEmulator.java

@@ -451,28 +451,30 @@ public void doCommand(String[] command)
             hideHighlights();
 
         // execute the appropriate command
-        if (command[0].equals(COMMAND_VMSTEP)) {
-            if (command.length != 1)
-                throw new CommandException("Illegal number of arguments to command", command);
-
-            cpu.executeInstruction();
-        }
-        else if (command[0].equals(COMMAND_SETVAR)) {
-            if (command.length != 3)
-                throw new CommandException("Illegal number of arguments to command", command);
-            setValue(command[1], command[2]);
-        }
-        else if (command[0].equals(COMMAND_ROMLOAD)) {
-            if (command.length != 1 && command.length != 2)
-                throw new CommandException("Illegal number of arguments to command", command);
-
-            String fileName = workingDir + (command.length == 1 ? "" : "/" + command[1]);
-
-            cpu.getProgram().loadProgram(fileName);
-            cpu.boot();
+        switch (command[0]) {
+            case COMMAND_VMSTEP:
+                if (command.length != 1)
+                    throw new CommandException("Illegal number of arguments to command", command);
+
+                cpu.executeInstruction();
+                break;
+            case COMMAND_SETVAR:
+                if (command.length != 3)
+                    throw new CommandException("Illegal number of arguments to command", command);
+                setValue(command[1], command[2]);
+                break;
+            case COMMAND_ROMLOAD:
+                if (command.length != 1 && command.length != 2)
+                    throw new CommandException("Illegal number of arguments to command", command);
+
+                String fileName = workingDir + (command.length == 1 ? "" : "/" + command[1]);
+
+                cpu.getProgram().loadProgram(fileName);
+                cpu.boot();
+                break;
+            default:
+                throw new CommandException("Unknown simulator command", command);
         }
-        else
-            throw new CommandException("Unknown simulator command", command);
     }
 
     // Hides all highlights in GUIs.
@@ -635,7 +637,7 @@ public Breakpoint genStepOverBreakpoint() {
     }
 
     /**
-     * Called when an error occured in a computer part.
+     * Called when an error occurred in a computer part.
      * The event contains the source object and the error message.
      */
     public void computerPartErrorOccured(ComputerPartErrorEvent event) {