introduced wrapper class for executing swing code in event dispatcher thread.

not used by all parts of the code yet

tools/cooja/java/se/sics/cooja/GUI.java

@@ -24,7 +24,7 @@
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
- * $Id: GUI.java,v 1.89 2008/10/29 13:31:02 fros4943 Exp $
+ * $Id: GUI.java,v 1.90 2008/11/04 14:32:32 fros4943 Exp $
  */
 
 package se.sics.cooja;
@@ -34,6 +34,7 @@ import java.awt.Dialog.ModalityType;
 import java.awt.event.*;
 import java.beans.PropertyVetoException;
 import java.io.*;
+import java.lang.reflect.InvocationTargetException;
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.net.URLClassLoader;
@@ -258,6 +259,16 @@ public class GUI extends Observable {
       setExternalToolsSetting("PATH_CONTIKI", specifiedContikiPath);
     }
 
+    /* Debugging - Break on repaints outside EDT */
+    /*RepaintManager.setCurrentManager(new RepaintManager() {
+      public void addDirtyRegion(JComponent comp, int a, int b, int c, int d) {
+        if(!java.awt.EventQueue.isDispatchThread()) {
+          throw new RuntimeException("Repainting outside EDT");
+        }
+        super.addDirtyRegion(comp, a, b, c, d);
+      }
+    });*/
+
     // Register default project directories
     String defaultProjectDirs = getExternalToolsSetting(
         "DEFAULT_PROJECTDIRS", null);
@@ -849,7 +860,6 @@ public class GUI extends Observable {
     } catch (IllegalAccessException e) {
       logger.warn("LookAndFeel: " + e);
     }
-
   }
 
   /**
@@ -1613,7 +1623,9 @@ public class GUI extends Observable {
    * @param plugin
    *          Internal frame to add
    */
-  public void showPlugin(VisPlugin plugin) {
+  public void showPlugin(final VisPlugin plugin) {
+    new RunnableInEDT<Boolean>() {
+      public Boolean work() {
         int nrFrames = myDesktopPane.getAllFrames().length;
         myDesktopPane.add(plugin);
 
@@ -1643,6 +1655,10 @@ public class GUI extends Observable {
 
         // Mote plugin to front
         myDesktopPane.moveToFront(plugin);
+
+        return true;
+      }
+    }.invokeAndWait();
   }
 
   /**
@@ -1680,29 +1696,26 @@ public class GUI extends Observable {
    *          If plugin is the last one, ask user if we should remove current
    *          simulation also?
    */
-  public void removePlugin(Plugin plugin, boolean askUser) {
+  public void removePlugin(final Plugin plugin, final boolean askUser) {
-    // Clear any allocated resources and remove plugin
+    new RunnableInEDT<Boolean>() {
+      public Boolean work() {
+        /* Free resources */
         plugin.closePlugin();
         startedPlugins.remove(plugin);
 
-    // Dispose plugin if it has visualizer
+        /* Dispose visualized components */
         if (plugin instanceof VisPlugin) {
           ((VisPlugin) plugin).dispose();
         }
 
+        /* (OPTIONAL) Remove simulation if all plugins are closed */
         if (getSimulation() != null && askUser && startedPlugins.isEmpty()) {
-      String s1 = "Remove";
+          doRemoveSimulation(true);
-      String s2 = "Cancel";
-      Object[] options = { s1, s2 };
-      int n = JOptionPane.showOptionDialog(frame,
-          "You have an active simulation.\nDo you want to remove it?",
-          "Remove current simulation?", JOptionPane.YES_NO_OPTION,
-          JOptionPane.QUESTION_MESSAGE, null, options, s1);
-      if (n != JOptionPane.YES_OPTION) {
-        return;
         }
-      doRemoveSimulation(false);
+
+        return true;
       }
+    }.invokeAndWait();
   }
 
   /**
@@ -1718,8 +1731,8 @@ public class GUI extends Observable {
    *          Mote passed as argument to mote plugins
    * @return Start plugin if any
    */
-  public Plugin startPlugin(Class<? extends Plugin> pluginClass, GUI gui,
+  public Plugin startPlugin(final Class<? extends Plugin> pluginClass,
-      Simulation simulation, Mote mote) {
+      final GUI gui, final Simulation simulation, final Mote mote) {
 
     // Check that plugin class is registered
     if (!pluginClasses.contains(pluginClass)) {
@@ -1740,8 +1753,10 @@ public class GUI extends Observable {
     }
 
     // Construct plugin depending on plugin type
-    Plugin newPlugin = null;
+    Plugin newPlugin = new RunnableInEDT<Plugin>() {
+      public Plugin work() {
         int pluginType = pluginClass.getAnnotation(PluginType.class).value();
+        Plugin plugin = null;
 
         try {
           if (pluginType == PluginType.MOTE_PLUGIN) {
@@ -1750,12 +1765,12 @@ public class GUI extends Observable {
               return null;
             }
 
-        newPlugin = pluginClass.getConstructor(
+            plugin = pluginClass.getConstructor(
                 new Class[] { Mote.class, Simulation.class, GUI.class })
                 .newInstance(mote, simulation, gui);
 
             // Tag plugin with mote
-        newPlugin.tagWithObject(mote);
+            plugin.tagWithObject(mote);
           } else if (pluginType == PluginType.SIM_PLUGIN
               || pluginType == PluginType.SIM_STANDARD_PLUGIN) {
             if (simulation == null) {
@@ -1763,7 +1778,7 @@ public class GUI extends Observable {
               return null;
             }
 
-        newPlugin = pluginClass.getConstructor(
+            plugin = pluginClass.getConstructor(
                 new Class[] { Simulation.class, GUI.class }).newInstance(
                 simulation, gui);
           } else if (pluginType == PluginType.COOJA_PLUGIN
@@ -1773,8 +1788,7 @@ public class GUI extends Observable {
               return null;
             }
 
-        newPlugin = pluginClass.getConstructor(new Class[] { GUI.class })
+            plugin = pluginClass.getConstructor(new Class[] { GUI.class }).newInstance(gui);
-            .newInstance(gui);
           }
         } catch (Exception e) {
           logger.fatal("Exception thrown when starting plugin: " + e);
@@ -1782,6 +1796,10 @@ public class GUI extends Observable {
           return null;
         }
 
+        return plugin;
+      }
+    }.invokeAndWait();
+
     if (newPlugin == null) {
       return null;
     }
@@ -1871,14 +1889,14 @@ public class GUI extends Observable {
    *          Should this plugin be added to the dedicated plugins menubar?
    * @return True if this plugin was registered ok, false otherwise
    */
-  private boolean registerPlugin(Class<? extends Plugin> newPluginClass,
+  private boolean registerPlugin(final Class<? extends Plugin> newPluginClass,
       boolean addToMenu) {
 
     // Get description annotation (if any)
-    String description = getDescriptionOf(newPluginClass);
+    final String description = getDescriptionOf(newPluginClass);
 
     // Get plugin type annotation (required)
-    int pluginType;
+    final int pluginType;
     if (newPluginClass.isAnnotationPresent(PluginType.class)) {
       pluginType = newPluginClass.getAnnotation(PluginType.class).value();
     } else {
@@ -1892,23 +1910,22 @@ public class GUI extends Observable {
             Simulation.class, GUI.class });
       } else if (pluginType == PluginType.SIM_PLUGIN
           || pluginType == PluginType.SIM_STANDARD_PLUGIN) {
-        newPluginClass
+        newPluginClass.getConstructor(new Class[] { Simulation.class, GUI.class });
-            .getConstructor(new Class[] { Simulation.class, GUI.class });
       } else if (pluginType == PluginType.COOJA_PLUGIN
           || pluginType == PluginType.COOJA_STANDARD_PLUGIN) {
         newPluginClass.getConstructor(new Class[] { GUI.class });
       } else {
-        logger.fatal("Could not find valid plugin type annotation in class "
+        logger.fatal("Could not find valid plugin type annotation in class " + newPluginClass);
-            + newPluginClass);
         return false;
       }
     } catch (NoSuchMethodException e) {
-      logger.fatal("Could not find valid constructor in class "
+      logger.fatal("Could not find valid constructor in class " + newPluginClass + ": " + e);
-          + newPluginClass + ": " + e);
       return false;
     }
 
     if (addToMenu && menuPlugins != null) {
+      new RunnableInEDT<Boolean>() {
+        public Boolean work() {
           // Create 'start plugin'-menu item
           JMenuItem menuItem = new JMenuItem(description);
           menuItem.setActionCommand("start plugin");
@@ -1923,6 +1940,9 @@ public class GUI extends Observable {
             menuItem.setToolTipText("Mote plugin");
             menuMotePluginClasses.add(newPluginClass);
           }
+          return true;
+        }
+      }.invokeAndWait();
     }
 
     pluginClasses.add(newPluginClass);
@@ -2043,11 +2063,17 @@ public class GUI extends Observable {
    *
    * @param askForConfirmation
    *          Should we ask for confirmation if a simulation is already active?
+   * @return True if no simulation exists when method returns
    */
-  public void doRemoveSimulation(boolean askForConfirmation) {
+  public boolean doRemoveSimulation(boolean askForConfirmation) {
+
+    if (mySimulation == null) {
+      return true;
+    }
 
-    if (mySimulation != null) {
     if (askForConfirmation) {
+      boolean ok = new RunnableInEDT<Boolean>() {
+        public Boolean work() {
           String s1 = "Remove";
           String s2 = "Cancel";
           Object[] options = { s1, s2 };
@@ -2056,14 +2082,20 @@ public class GUI extends Observable {
               "Remove current simulation?", JOptionPane.YES_NO_OPTION,
               JOptionPane.QUESTION_MESSAGE, null, options, s1);
           if (n != JOptionPane.YES_OPTION) {
-          return;
+            return false;
+          }
+          return true;
+        }
+      }.invokeAndWait();
+
+      if (!ok) {
+        return false;
       }
     }
 
     // Close all started non-GUI plugins
     for (Object startedPlugin : startedPlugins.toArray()) {
-        int pluginType = startedPlugin.getClass().getAnnotation(
+      int pluginType = startedPlugin.getClass().getAnnotation(PluginType.class).value();
-            PluginType.class).value();
       if (pluginType != PluginType.COOJA_PLUGIN
           && pluginType != PluginType.COOJA_STANDARD_PLUGIN) {
         removePlugin((Plugin) startedPlugin, false);
@@ -2076,8 +2108,7 @@ public class GUI extends Observable {
     mySimulation = null;
 
     // Unregister temporary plugin classes
-      Enumeration<Class<? extends Plugin>> pluginClasses = pluginClassesTemporary
+    Enumeration<Class<? extends Plugin>> pluginClasses = pluginClassesTemporary.elements();
-          .elements();
     while (pluginClasses.hasMoreElements()) {
       unregisterPlugin(pluginClasses.nextElement());
     }
@@ -2089,7 +2120,8 @@ public class GUI extends Observable {
 
     setChanged();
     notifyObservers();
-    }
+
+    return true;
   }
 
   /**
@@ -2104,43 +2136,29 @@ public class GUI extends Observable {
       return;
     }
 
-    /*if (CoreComm.hasLibraryBeenLoaded()) {
+    /* Remove current simulation */
-      JOptionPane.showMessageDialog(GUI.getTopParentContainer(),
+    if (!doRemoveSimulation(true)) {
-          "Shared libraries has already been loaded.\nYou need to restart the simulator!",
-          "Can't load simulation", JOptionPane.ERROR_MESSAGE);
-      return;
-    }*/
-
-    if (askForConfirmation && mySimulation != null) {
-      String s1 = "Remove";
-      String s2 = "Cancel";
-      Object[] options = { s1, s2 };
-      int n = JOptionPane.showOptionDialog(GUI.getTopParentContainer(),
-          "You have an active simulation.\nDo you want to remove it?",
-          "Remove current simulation?", JOptionPane.YES_NO_OPTION,
-          JOptionPane.QUESTION_MESSAGE, null, options, s1);
-      if (n != JOptionPane.YES_OPTION) {
       return;
     }
-    }
 
-    doRemoveSimulation(false);
+    /* Use provided configuration, or open File Chooser */
-
-    // Check already selected file, or select file using filechooser
     if (configFile != null && !configFile.isDirectory()) {
       if (!configFile.exists() || !configFile.canRead()) {
         logger.fatal("No read access to file");
         return;
       }
     } else {
+      final File suggestedFile = configFile;
+      configFile = new RunnableInEDT<File>() {
+        public File work() {
           JFileChooser fc = new JFileChooser();
 
           fc.setFileFilter(GUI.SAVED_SIMULATIONS_FILES);
 
-      if (configFile != null && configFile.isDirectory()) {
+          if (suggestedFile != null && suggestedFile.isDirectory()) {
-        fc.setCurrentDirectory(configFile);
+            fc.setCurrentDirectory(suggestedFile);
           } else {
-        // Suggest file using history
+            /* Suggest file using file history */
             Vector<File> history = getFileHistory();
             if (history != null && history.size() > 0) {
               File suggestedFile = getFileHistory().firstElement();
@@ -2149,22 +2167,28 @@ public class GUI extends Observable {
           }
 
           int returnVal = fc.showOpenDialog(GUI.getTopParentContainer());
-      if (returnVal == JFileChooser.APPROVE_OPTION) {
+          if (returnVal != JFileChooser.APPROVE_OPTION) {
-        configFile = fc.getSelectedFile();
-
-        // Try adding extension if not founds
-        if (!configFile.exists()) {
-          configFile = new File(configFile.getParent(), configFile.getName()
-              + SAVED_SIMULATIONS_FILES);
-        }
-
-        if (!configFile.exists() || !configFile.canRead()) {
-          logger.fatal("No read access to file");
-          return;
-        }
-
-      } else {
             logger.info("Load command cancelled by user...");
+            return null;
+          }
+
+          File file = fc.getSelectedFile();
+
+          if (!file.exists()) {
+            /* Try default file extension */
+            file = new File(file.getParent(), file.getName() + SAVED_SIMULATIONS_FILES);
+          }
+
+          if (!file.exists() || !file.canRead()) {
+            logger.fatal("No read access to file");
+            return null;
+          }
+
+          return file;
+        }
+      }.invokeAndWait();
+
+      if (configFile == null) {
         return;
       }
     }
@@ -2172,6 +2196,12 @@ public class GUI extends Observable {
     final JDialog progressDialog;
 
     if (quick) {
+      final Thread loadThread = Thread.currentThread();
+
+      progressDialog = new RunnableInEDT<JDialog>() {
+        public JDialog work() {
+          final JDialog progressDialog;
+
           if (GUI.getTopParentContainer() instanceof Window) {
             progressDialog = new JDialog((Window) GUI.getTopParentContainer(), "Loading", ModalityType.APPLICATION_MODAL);
           } else if (GUI.getTopParentContainer() instanceof Frame) {
@@ -2183,9 +2213,6 @@ public class GUI extends Observable {
             progressDialog = new JDialog((Frame) null, "Loading", ModalityType.APPLICATION_MODAL);
           }
 
-      final Thread loadThread = Thread.currentThread();
-      SwingUtilities.invokeLater(new Runnable() {
-        public void run() {
           JPanel progressPanel = new JPanel(new BorderLayout());
           JProgressBar progressBar;
           JButton button;
@@ -2197,11 +2224,11 @@ public class GUI extends Observable {
 
           button.addActionListener(new ActionListener() {
             public void actionPerformed(ActionEvent e) {
-              if (loadThread != null && loadThread.isAlive()) {
+              if (loadThread.isAlive()) {
                 loadThread.interrupt();
                 doRemoveSimulation(false);
               }
-              if (progressDialog != null && progressDialog.isDisplayable()) {
+              if (progressDialog.isDisplayable()) {
                 progressDialog.dispose();
               }
             }
@@ -2219,9 +2246,16 @@ public class GUI extends Observable {
           progressDialog.getRootPane().setDefaultButton(button);
           progressDialog.setLocationRelativeTo(GUI.getTopParentContainer());
           progressDialog.setDefaultCloseOperation(JDialog.DO_NOTHING_ON_CLOSE);
+
+          java.awt.EventQueue.invokeLater(new Runnable() {
+            public void run() {
               progressDialog.setVisible(true);
             }
           });
+
+          return progressDialog;
+        }
+      }.invokeAndWait();
     } else {
       progressDialog = null;
     }
@@ -2426,21 +2460,12 @@ public class GUI extends Observable {
    *          Should we ask for confirmation if a simulation is already active?
    */
   public void doCreateSimulation(boolean askForConfirmation) {
-    if (askForConfirmation && mySimulation != null) {
+    /* Remove current simulation */
-      String s1 = "Remove";
+    if (!doRemoveSimulation(askForConfirmation)) {
-      String s2 = "Cancel";
-      Object[] options = { s1, s2 };
-      int n = JOptionPane.showOptionDialog(GUI.getTopParentContainer(),
-          "You have an active simulation.\nDo you want to remove it?",
-          "Remove current simulation?", JOptionPane.YES_NO_OPTION,
-          JOptionPane.QUESTION_MESSAGE, null, options, s1);
-      if (n != JOptionPane.YES_OPTION) {
       return;
     }
-    }
 
     // Create new simulation
-    doRemoveSimulation(false);
     Simulation newSim = new Simulation(this);
     boolean createdOK = CreateSimDialog.showDialog(GUI.getTopParentContainer(), newSim);
     if (createdOK) {
@@ -3256,7 +3281,7 @@ public class GUI extends Observable {
       }
 
       /* Create old to new identifier mappings */
-      Enumeration existingIdentifiers = moteTypeIDMappings.keys();
+      Enumeration<Object> existingIdentifiers = moteTypeIDMappings.keys();
       while (existingIdentifiers.hasMoreElements()) {
         String existingIdentifier = (String) existingIdentifiers.nextElement();
         Collection<MoteType> existingMoteTypes = null;
@@ -3449,7 +3474,7 @@ public class GUI extends Observable {
   public boolean setPluginsConfigXML(Collection<Element> configXML,
       Simulation simulation, boolean visAvailable) {
 
-    for (Element pluginElement : configXML.toArray(new Element[0])) {
+    for (final Element pluginElement : configXML.toArray(new Element[0])) {
       if (pluginElement.getName().equals("plugin")) {
 
         // Read plugin class
@@ -3463,8 +3488,7 @@ public class GUI extends Observable {
 
         // Parse plugin mote argument (if any)
         Mote mote = null;
-        for (Element pluginSubElement : (List<Element>) pluginElement
+        for (Element pluginSubElement : (List<Element>) pluginElement.getChildren()) {
-            .getChildren()) {
           if (pluginSubElement.getName().equals("mote_arg")) {
             int moteNr = Integer.parseInt(pluginSubElement.getText());
             if (moteNr >= 0 && moteNr < simulation.getMotesCount()) {
@@ -3485,8 +3509,7 @@ public class GUI extends Observable {
 
 
         // Apply plugin specific configuration
-        for (Element pluginSubElement : (List<Element>) pluginElement
+        for (Element pluginSubElement : (List<Element>) pluginElement.getChildren()) {
-            .getChildren()) {
           if (pluginSubElement.getName().equals("plugin_config")) {
             startedPlugin.setConfigXML(pluginSubElement.getChildren(), visAvailable);
           }
@@ -3494,12 +3517,13 @@ public class GUI extends Observable {
 
         // If plugin is visualizer plugin, parse visualization arguments
         if (startedPlugin instanceof VisPlugin) {
+          final VisPlugin startedVisPlugin = (VisPlugin) startedPlugin;
+          new RunnableInEDT<Boolean>() {
+            public Boolean work() {
               Dimension size = new Dimension(100, 100);
               Point location = new Point(100, 100);
-          VisPlugin startedVisPlugin = (VisPlugin) startedPlugin;
 
-          for (Element pluginSubElement : (List<Element>) pluginElement
+              for (Element pluginSubElement : (List<Element>) pluginElement.getChildren()) {
-              .getChildren()) {
 
                 if (pluginSubElement.getName().equals("width") && size != null) {
                   size.width = Integer.parseInt(pluginSubElement.getText());
@@ -3519,17 +3543,12 @@ public class GUI extends Observable {
                   startedVisPlugin.setLocation(location);
                 } else if (pluginSubElement.getName().equals("minimized")) {
                   try {
-                startedVisPlugin.setIcon(Boolean.parseBoolean(pluginSubElement
+                    startedVisPlugin.setIcon(Boolean.parseBoolean(pluginSubElement.getText()));
-                    .getText()));
                   } catch (PropertyVetoException e) {
                     // Ignoring
                   }
                 }
               }
-        }
-
-      }
-    }
 
               // For all started visplugins, check if they have a zorder property
               try {
@@ -3546,6 +3565,15 @@ public class GUI extends Observable {
 
               return true;
             }
+          }.invokeAndWait();
+
+        }
+
+      }
+    }
+
+    return true;
+  }
 
   public class ParseProjectsException extends Exception {
     public ParseProjectsException(String message) {
@@ -3577,10 +3605,14 @@ public class GUI extends Observable {
    * @param exception
    *          Exception causing window to be shown
    * @param retryAvailable
-   *          If true, a retry option is available
+   *          If true, a retry option is presented
+   * @return Retry failed operation
    */
-  public static boolean showErrorDialog(Component parentComponent,
+  public static boolean showErrorDialog(final Component parentComponent,
-      final String title, Throwable exception, boolean retryAvailable) {
+      final String title, final Throwable exception, final boolean retryAvailable) {
+
+    return new RunnableInEDT<Boolean>() {
+      public Boolean work() {
 
     MessageList compilationOutput = null;
     MessageList stackTrace = null;
@@ -3756,6 +3788,54 @@ public class GUI extends Observable {
       return true;
     }
     return false;
+
+      }
+    }.invokeAndWait();
+
+
+  }
+
+  /**
+   * Runs work method in event dispatcher thread.
+   * Worker method returns a value.
+   *
+   * @author Fredrik Österlind
+   */
+  public static abstract class RunnableInEDT<T> {
+    private T val;
+
+    /**
+     * Work method to be implemented.
+     *
+     * @return Return value
+     */
+    public abstract T work();
+
+    /**
+     * Runs worker method in event dispatcher thread.
+     *
+     * @see #work()
+     * @return Worker method return value
+     */
+    public T invokeAndWait() {
+      if(java.awt.EventQueue.isDispatchThread()) {
+        return RunnableInEDT.this.work();
+      }
+
+      try {
+        java.awt.EventQueue.invokeAndWait(new Runnable() {
+          public void run() {
+            val = RunnableInEDT.this.work();
+          }
+        });
+      } catch (InterruptedException e) {
+        e.printStackTrace();
+      } catch (InvocationTargetException e) {
+        e.printStackTrace();
+      }
+
+      return val;
+    }
   }
 
   /**