added simple events

Author: fracpete

src/main/java/com/github/fracpete/jshell/JShellPanel.java

@@ -20,6 +20,9 @@
 
 package com.github.fracpete.jshell;
 
+import com.github.fracpete.jshell.event.JShellEvent;
+import com.github.fracpete.jshell.event.JShellEvent.EventType;
+import com.github.fracpete.jshell.event.JShellListener;
 import com.github.fracpete.processoutput4j.core.StreamingProcessOutputType;
 import com.github.fracpete.processoutput4j.core.StreamingProcessOwner;
 import com.github.fracpete.processoutput4j.output.StreamingProcessOutput;
@@ -50,7 +53,9 @@
 import java.io.File;
 import java.nio.file.Files;
 import java.util.ArrayList;
+import java.util.HashSet;
 import java.util.List;
+import java.util.Set;
 
 /**
  * Panel for performing scripting via jshell. Requires Java 9.
@@ -102,6 +107,9 @@ public class JShellPanel
   /** executes the script. */
   protected transient StreamingProcessOutput m_Execution;
 
+  /** the listeners that listen for changes. */
+  protected Set<JShellListener> m_JShellListeners;
+
   /**
    * Initializes the members.
    */
@@ -113,6 +121,8 @@ protected void initialize() {
     m_FileChooserOutput = new BaseFileChooser();
     m_FileChooserOutput.addChoosableFileFilter(new ExtensionFileFilter("Text file", "txt"));
     m_FileChooserOutput.setAcceptAllFileFilterUsed(true);
+
+    m_JShellListeners = new HashSet<>();
   }
 
   /**
@@ -207,13 +217,22 @@ protected void finishInit() {
     updateButtons();
   }
 
+  /**
+   * Returns whether a script is currently running.
+   *
+   * @return		true if a script is running
+   */
+  public boolean isRunning() {
+    return (m_Execution != null);
+  }
+
   /**
    * Updates the state of the buttons.
    */
   protected void updateButtons() {
     boolean     running;
 
-    running = (m_Execution != null);
+    running = isRunning();
 
     // script
     m_ButtonScriptLoad.setEnabled(!running);
@@ -250,9 +269,11 @@ public void loadScript(File script) {
     try {
       lines = Files.readAllLines(script.toPath());
       m_TextCode.setText(Utils.flatten(lines, "\n"));
+      notifyJShellListeners(new JShellEvent(this, EventType.SCRIPT_LOAD_SUCCESS));
     }
     catch (Exception e) {
       GUIHelper.showErrorMessage(this, "Failed to load script from: " + script, e);
+      notifyJShellListeners(new JShellEvent(this, EventType.SCRIPT_LOAD_FAILURE));
     }
 
     updateButtons();
@@ -272,8 +293,13 @@ public void saveScript() {
 
     script = m_FileChooserScript.getSelectedFile();
     msg    = FileUtils.writeToFileMsg(script.getAbsolutePath(), m_TextCode.getText(), false, null);
-    if (msg != null)
+    if (msg != null) {
       GUIHelper.showErrorMessage(this, "Failed to save script to : " + script + "\n" + msg);
+      notifyJShellListeners(new JShellEvent(this, EventType.SCRIPT_SAVE_FAILURE));
+    }
+    else {
+      notifyJShellListeners(new JShellEvent(this, EventType.SCRIPT_SAVE_SUCCESS));
+    }
 
     updateButtons();
   }
@@ -289,6 +315,7 @@ public void runScript() {
     ProcessBuilder 	builder;
     Runnable		run;
 
+    stopScript();
     clearScriptOutput();
 
     // create tmp file name
@@ -297,6 +324,7 @@ public void runScript() {
     }
     catch (Exception e) {
       GUIHelper.showErrorMessage(this, "Failed to create temporary file for script!\nCannot execute script!", e);
+      notifyJShellListeners(new JShellEvent(this, EventType.SCRIPT_RUN_SETUP_FAILURE));
       return;
     }
 
@@ -310,6 +338,7 @@ public void runScript() {
     if (msg != null) {
       tmpFile.delete();
       GUIHelper.showErrorMessage(this, "Failed to write script to temporary file: " + tmpFile + "\n" + msg);
+      notifyJShellListeners(new JShellEvent(this, EventType.SCRIPT_RUN_SETUP_FAILURE));
       return;
     }
 
@@ -329,16 +358,23 @@ public void runScript() {
       public void run() {
 	try {
 	  m_Execution.monitor(builder);
+	  if (m_Execution.getExitCode() != 0)
+	    notifyJShellListeners(new JShellEvent(JShellPanel.this, EventType.SCRIPT_RUN_FAILURE));
+	  else
+	    notifyJShellListeners(new JShellEvent(JShellPanel.this, EventType.SCRIPT_RUN_SUCCESS));
 	}
 	catch (Exception e) {
 	  GUIHelper.showErrorMessage(JShellPanel.this, "Failed to execute script!", e);
+	  notifyJShellListeners(new JShellEvent(JShellPanel.this, EventType.SCRIPT_RUN_FAILURE));
 	}
+	notifyJShellListeners(new JShellEvent(JShellPanel.this, EventType.SCRIPT_FINISHED));
 	m_Execution = null;
 	tmpFile.delete();
 	updateButtons();
       }
     };
     new Thread(run).start();
+    notifyJShellListeners(new JShellEvent(this, EventType.SCRIPT_RUN));
 
     updateButtons();
   }
@@ -350,6 +386,7 @@ public void stopScript() {
     if (m_Execution != null) {
       m_Execution.destroy();
       m_Execution = null;
+      notifyJShellListeners(new JShellEvent(this, EventType.SCRIPT_STOP));
     }
 
     updateButtons();
@@ -360,6 +397,7 @@ public void stopScript() {
    */
   public void clearScriptOutput() {
     m_TextOutput.setText("");
+    notifyJShellListeners(new JShellEvent(this, EventType.OUTPUT_CLEARED));
     updateButtons();
   }
 
@@ -375,12 +413,35 @@ public void saveScriptOutput() {
       return;
 
     msg = FileUtils.writeToFileMsg(m_FileChooserOutput.getSelectedFile().getAbsolutePath(), m_TextOutput.getText(), false, null);
-    if (msg != null)
+    if (msg != null) {
       GUIHelper.showErrorMessage(this, msg, "Failed saving output");
+      notifyJShellListeners(new JShellEvent(this, EventType.OUTPUT_SAVE_FAILURE));
+    }
+    else {
+      notifyJShellListeners(new JShellEvent(this, EventType.OUTPUT_SAVE_SUCESS));
+    }
 
     updateButtons();
   }
 
+  /**
+   * Returns the current code.
+   *
+   * @return		the code
+   */
+  public String getCode() {
+    return m_TextCode.getText();
+  }
+
+  /**
+   * Returns the current output.
+   *
+   * @return		the output
+   */
+  public String getOutput() {
+    return m_TextOutput.getText();
+  }
+
   /**
    * Returns the jshell executable.
    *
@@ -436,6 +497,34 @@ public void processOutput(String line, boolean stdout) {
       m_TextOutput.setCaretPosition(m_TextOutput.getDocument().getLength());
   }
 
+  /**
+   * Adds the listener to the internal list.
+   *
+   * @param l		the listener to add
+   */
+  public void addJShellListener(JShellListener l) {
+    m_JShellListeners.add(l);
+  }
+
+  /**
+   * Removes the listener to the internal list.
+   *
+   * @param l		the listener to remove
+   */
+  public void removeJShellListener(JShellListener l) {
+    m_JShellListeners.remove(l);
+  }
+
+  /**
+   * Notifies all the listeners with the specified event.
+   *
+   * @param e		the event to send
+   */
+  protected synchronized void notifyJShellListeners(JShellEvent e) {
+    for (JShellListener l: m_JShellListeners)
+      l.jshellEventOccurred(e);
+  }
+
   /**
    * For testing only.
    *
@@ -446,6 +535,7 @@ public static void main(String[] args) {
     JShellPanel	panel;
 
     panel = new JShellPanel();
+    panel.addJShellListener((JShellEvent e) -> System.out.println(e.getType()));
     frame = new BaseFrame("JShell");
     frame.setIconImage(GUIHelper.getIcon("jshell.gif").getImage());
     frame.getContentPane().setLayout(new BorderLayout());

src/main/java/com/github/fracpete/jshell/event/JShellEvent.java

@@ -0,0 +1,83 @@
+/*
+ *   This program is free software: you can redistribute it and/or modify
+ *   it under the terms of the GNU General Public License as published by
+ *   the Free Software Foundation, either version 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   This program is distributed in the hope that it will be useful,
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *   GNU General Public License for more details.
+ *
+ *   You should have received a copy of the GNU General Public License
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/*
+ * JShellEvent.java
+ * Copyright (C) 2018 University of Waikato, Hamilton, NZ
+ */
+
+package com.github.fracpete.jshell.event;
+
+import com.github.fracpete.jshell.JShellPanel;
+
+import java.util.EventObject;
+
+/**
+ * Events sent by the {@link JShellPanel}.
+ *
+ * @author FracPete (fracpete at waikato dot ac dot nz)
+ */
+public class JShellEvent
+  extends EventObject {
+
+  /** the type of event. */
+  public enum EventType {
+    SCRIPT_LOAD_SUCCESS,
+    SCRIPT_LOAD_FAILURE,
+    SCRIPT_SAVE_SUCCESS,
+    SCRIPT_SAVE_FAILURE,
+    SCRIPT_RUN_SETUP_FAILURE,
+    SCRIPT_RUN,
+    SCRIPT_RUN_FAILURE,
+    SCRIPT_RUN_SUCCESS,
+    SCRIPT_STOP,
+    SCRIPT_FINISHED,
+    OUTPUT_CLEARED,
+    OUTPUT_SAVE_SUCESS,
+    OUTPUT_SAVE_FAILURE,
+  }
+
+  /** the event type. */
+  protected EventType m_Type;
+
+  /**
+   * Constructs a prototypical Event.
+   *
+   * @param source the panel on which the Event initially occurred
+   * @throws IllegalArgumentException if source is null
+   */
+  public JShellEvent(JShellPanel source, EventType type) {
+    super(source);
+    m_Type = type;
+  }
+
+  /**
+   * Returns the panel that triggered the event.
+   *
+   * @return the source panel
+   */
+  public JShellPanel getPanel() {
+    return (JShellPanel) getSource();
+  }
+
+  /**
+   * Returns the event type.
+   *
+   * @return the event type
+   */
+  public EventType getType() {
+    return m_Type;
+  }
+}

src/main/java/com/github/fracpete/jshell/event/JShellListener.java

@@ -0,0 +1,36 @@
+/*
+ *   This program is free software: you can redistribute it and/or modify
+ *   it under the terms of the GNU General Public License as published by
+ *   the Free Software Foundation, either version 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   This program is distributed in the hope that it will be useful,
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *   GNU General Public License for more details.
+ *
+ *   You should have received a copy of the GNU General Public License
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/*
+ * JShellListener.java
+ * Copyright (C) 2018 University of Waikato, Hamilton, NZ
+ */
+
+package com.github.fracpete.jshell.event;
+
+/**
+ * Interface for classes that listen to events of the JShellPanel.
+ *
+ * @author FracPete (fracpete at waikato dot ac dot nz)
+ */
+public interface JShellListener {
+
+  /**
+   * Gets triggered with any event in the JShellPanel.
+   *
+   * @param e		the event
+   */
+  public void jshellEventOccurred(JShellEvent e);
+}