From 1a2794d9615ccda38bffdf6fe04cf16c74031bd4 Mon Sep 17 00:00:00 2001
From: fros4943 <fros4943>
Date: Wed, 17 Dec 2008 11:02:05 +0000
Subject: [PATCH] visplugins are optional, but require cooja to be visualized:

* hybrid plugins (used both when cooja is visualized and in test mode) should not extend VisPlugin
---
 tools/cooja/java/se/sics/cooja/GUI.java       | 15 +++++-
 tools/cooja/java/se/sics/cooja/VisPlugin.java | 53 ++++++++-----------
 2 files changed, 37 insertions(+), 31 deletions(-)

diff --git a/tools/cooja/java/se/sics/cooja/GUI.java b/tools/cooja/java/se/sics/cooja/GUI.java
index 03a8c4bd7..abda82462 100644
--- a/tools/cooja/java/se/sics/cooja/GUI.java
+++ b/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.97 2008/12/16 16:15:36 fros4943 Exp $
+ * $Id: GUI.java,v 1.98 2008/12/17 11:02:05 fros4943 Exp $
  */
 
 package se.sics.cooja;
@@ -112,6 +112,7 @@ import org.jdom.output.Format;
 import org.jdom.output.XMLOutputter;
 
 import se.sics.cooja.MoteType.MoteTypeCreationException;
+import se.sics.cooja.VisPlugin.PluginRequiresVisualizationException;
 import se.sics.cooja.contikimote.ContikiMote;
 import se.sics.cooja.contikimote.ContikiMoteType;
 import se.sics.cooja.contikimote.ContikiMoteTypeDialog;
@@ -1869,6 +1870,18 @@ public class GUI extends Observable {
 
         plugin = pluginClass.getConstructor(new Class[] { GUI.class }).newInstance(gui);
       }
+    } catch (PluginRequiresVisualizationException e) {
+      logger.info("Plugin not started (requires visualization): " + pluginClass.getName());
+      return null;
+    } catch (InvocationTargetException e) {
+      if (e.getCause() != null &&
+          e.getCause().getClass().equals(PluginRequiresVisualizationException.class)) {
+        logger.info("Plugin not started (requires visualization): " + pluginClass.getName());
+      } else {
+        logger.fatal("Exception thrown when starting plugin: " + e);
+        e.printStackTrace();
+      }
+      return null;
     } catch (Exception e) {
       logger.fatal("Exception thrown when starting plugin: " + e);
       e.printStackTrace();
diff --git a/tools/cooja/java/se/sics/cooja/VisPlugin.java b/tools/cooja/java/se/sics/cooja/VisPlugin.java
index 794a1c237..c93dfc35b 100644
--- a/tools/cooja/java/se/sics/cooja/VisPlugin.java
+++ b/tools/cooja/java/se/sics/cooja/VisPlugin.java
@@ -26,7 +26,7 @@
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  *
- * $Id: VisPlugin.java,v 1.7 2008/12/16 15:05:27 fros4943 Exp $
+ * $Id: VisPlugin.java,v 1.8 2008/12/17 11:02:05 fros4943 Exp $
  */
 
 package se.sics.cooja;
@@ -37,56 +37,47 @@ import javax.swing.event.InternalFrameEvent;
 import javax.swing.event.InternalFrameListener;
 import org.jdom.Element;
 
+import se.sics.cooja.plugins.SimControl;
+
 /**
- * Abstract class VisPlugin should be implemented by all plugins with
- * visualizers. By extending JInternalFrame, the visual apperence is decided by
- * the plugin itself.
+ * Visualized plugins can extend VisPlugin for basic visualization functionality.
+ * VisPlugin extends JInternalFrame, the graphical component used by plugins.
+ * VisPlugin implementations may hence directly add buttons to themselves.
  *
- * To add a new plugin to the simulator environment either add it via a project
- * directory or by altering the standard configuration files.
- *
- * For example how to implement a plugin see plugins SimControl or Visualizer2D.
+ * Note that plugins of this type can only be started if COOJA is visualized.
+ * Hence, these plugins will not be started during nightly Contiki tests.
  *
+ * @see SimControl
+ * @see PluginRequiresVisualizationException
  * @author Fredrik Osterlind
  */
 public abstract class VisPlugin extends JInternalFrame implements Plugin {
   private Object tag = null;
 
-  /**
-   * Sets frame title
-   * @param title Frame title
-   */
   public VisPlugin(String title, final GUI gui) {
     super(title, true, true, true, true);
 
-    // Close via gui
+    if (!GUI.isVisualized()) {
+      throw new PluginRequiresVisualizationException();
+    }
+
     setDefaultCloseOperation(DO_NOTHING_ON_CLOSE);
-    // Detect frame events
+
     addInternalFrameListener(new InternalFrameListener() {
       public void internalFrameClosing(InternalFrameEvent e) {
         gui.removePlugin(VisPlugin.this, true);
       }
-      public void internalFrameClosed(InternalFrameEvent e) {
-        // NOP
-      }
-      public void internalFrameOpened(InternalFrameEvent e) {
-        // NOP
-      }
-      public void internalFrameIconified(InternalFrameEvent e) {
-        // NOP
-      }
-      public void internalFrameDeiconified(InternalFrameEvent e) {
-        // NOP
-      }
+      public void internalFrameClosed(InternalFrameEvent e) { }
+      public void internalFrameOpened(InternalFrameEvent e) { }
+      public void internalFrameIconified(InternalFrameEvent e) { }
+      public void internalFrameDeiconified(InternalFrameEvent e) { }
       public void internalFrameActivated(InternalFrameEvent e) {
-        // Signal mote highlight
+        /* Highlight mote in COOJA */
         if (VisPlugin.this.tag != null && tag instanceof Mote) {
           gui.signalMoteHighlight((Mote) tag);
         }
       }
-      public void internalFrameDeactivated(InternalFrameEvent e) {
-        // NOP
-      }
+      public void internalFrameDeactivated(InternalFrameEvent e) { }
     }
     );
   }
@@ -111,4 +102,6 @@ public abstract class VisPlugin extends JInternalFrame implements Plugin {
     return tag;
   }
 
+  public class PluginRequiresVisualizationException extends RuntimeException {
+  }
 }