DI the swing debug plugin.

Change-Id: I4d4867681150dcc6dbb7063fe0bdd2bdd55c029d
Reviewed-on: http://gerrit.dmdirc.com/3222
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Chris Smith <chris@dmdirc.com>

src/com/dmdirc/addons/swingdebug/SwingDebugManager.java

@@ -0,0 +1,156 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.addons.swingdebug;
+
+import com.dmdirc.ClientModule.GlobalConfig;
+import com.dmdirc.FrameContainer;
+import com.dmdirc.addons.ui_swing.DMDircEventQueue;
+import com.dmdirc.addons.ui_swing.MainFrame;
+import com.dmdirc.addons.ui_swing.SwingController;
+import com.dmdirc.addons.ui_swing.components.CheckBoxMenuItem;
+import com.dmdirc.interfaces.FrameCloseListener;
+import com.dmdirc.interfaces.config.AggregateConfigProvider;
+import com.dmdirc.plugins.PluginDomain;
+import com.dmdirc.ui.WindowManager;
+import com.dmdirc.util.URLBuilder;
+
+import java.awt.Toolkit;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+
+import javax.inject.Inject;
+import javax.swing.JCheckBoxMenuItem;
+import javax.swing.JMenu;
+
+public class SwingDebugManager implements ActionListener, FrameCloseListener {
+
+    /** This plugin's settings domain. */
+    private final String domain;
+    /** The config to read settings with. */
+    private final AggregateConfigProvider globalConfig;
+    /** Swing controller. */
+    private final SwingController controller;
+    /** Window Management. */
+    private final WindowManager windowManager;
+    /** Swing main frame. */
+    private final MainFrame mainFrame;
+    /** Debug menu. */
+    private JMenu debugMenu;
+    /** Debug EDT menu item. */
+    private JCheckBoxMenuItem debugEDT;
+    /** Debug EDT menu item. */
+    private JCheckBoxMenuItem showSysOut;
+    /** Debug EDT menu item. */
+    private JCheckBoxMenuItem showSysErr;
+    /** System out window. */
+    private SystemStreamContainer sysoutFrame;
+    /** System error window. */
+    private SystemStreamContainer syserrFrame;
+    /** URL Builder to use for frame containers. */
+    private final URLBuilder urlBuilder;
+
+    @Inject
+    public SwingDebugManager(
+            @PluginDomain(SwingDebugPlugin.class) final String domain,
+            @GlobalConfig final AggregateConfigProvider globalConfig,
+            final MainFrame mainFrame,
+            final SwingController controller,
+            final WindowManager windowManager,
+            final URLBuilder urlBuilder) {
+        this.domain = domain;
+        this.globalConfig = globalConfig;
+        this.controller = controller;
+        this.windowManager = windowManager;
+        this.urlBuilder = urlBuilder;
+        this.mainFrame = mainFrame;
+    }
+
+    public void load() {
+        debugMenu = new JMenu("Debug");
+        debugEDT = new CheckBoxMenuItem("Check EDT task length");
+        showSysOut = new CheckBoxMenuItem("Show System.out Console");
+        showSysErr = new CheckBoxMenuItem("Show System.err Console");
+        debugEDT.addActionListener(this);
+        showSysErr.addActionListener(this);
+        showSysOut.addActionListener(this);
+        mainFrame.getJMenuBar().add(debugMenu);
+        debugMenu.add(debugEDT);
+        debugMenu.add(showSysOut);
+        debugMenu.add(showSysErr);
+    }
+
+    public void unload() {
+        mainFrame.getJMenuBar().remove(debugMenu);
+        debugMenu = null;
+        debugEDT = null;
+        showSysOut = null;
+        showSysErr = null;
+    }
+
+    @Override
+    public void actionPerformed(final ActionEvent e) {
+        if (e.getSource() == debugEDT) {
+            if (debugEDT.getState()) {
+                Toolkit.getDefaultToolkit().getSystemEventQueue().
+                        push(new TracingEventQueue(domain, globalConfig, controller));
+            } else {
+                Toolkit.getDefaultToolkit().getSystemEventQueue().
+                        push(new DMDircEventQueue(controller));
+            }
+        }
+        if (e.getSource() == showSysOut) {
+            if (showSysOut.isSelected()) {
+                sysoutFrame = new SystemStreamContainer(SystemStreamType.Out, globalConfig,
+                        urlBuilder);
+                sysoutFrame.addCloseListener(this);
+                windowManager.addWindow(sysoutFrame);
+            } else {
+                sysoutFrame.close();
+            }
+        }
+
+        if (e.getSource() == showSysErr) {
+            if (showSysErr.isSelected()) {
+                syserrFrame = new SystemStreamContainer(SystemStreamType.Error, globalConfig,
+                        urlBuilder);
+                syserrFrame.addCloseListener(this);
+                windowManager.addWindow(syserrFrame);
+            } else {
+                syserrFrame.close();
+            }
+        }
+    }
+
+    @Override
+    public void windowClosing(final FrameContainer window) {
+        if (window == syserrFrame) {
+            showSysErr.setSelected(false);
+            syserrFrame.removeCloseListener(this);
+        }
+        if (window == sysoutFrame) {
+            showSysOut.setSelected(false);
+            sysoutFrame.removeCloseListener(this);
+        }
+    }
+
+}

src/com/dmdirc/addons/swingdebug/SwingDebugModule.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.addons.swingdebug;
+
+import com.dmdirc.addons.ui_swing.injection.SwingModule;
+import com.dmdirc.plugins.PluginDomain;
+import com.dmdirc.plugins.PluginInfo;
+
+import dagger.Module;
+import dagger.Provides;
+
+@Module(injects = SwingDebugManager.class, addsTo = SwingModule.class)
+public class SwingDebugModule {
+
+    private final PluginInfo pluginInfo;
+
+    public SwingDebugModule(final PluginInfo pluginInfo) {
+        this.pluginInfo = pluginInfo;
+    }
+
+    @Provides
+    @PluginDomain(SwingDebugPlugin.class)
+    public String getSettignsDomain() {
+        return pluginInfo.getDomain();
+    }
+
+}

src/com/dmdirc/addons/swingdebug/SwingDebugPlugin.java

@@ -22,130 +22,34 @@
 
 package com.dmdirc.addons.swingdebug;
 
-import com.dmdirc.addons.ui_swing.DMDircEventQueue;
-import com.dmdirc.addons.ui_swing.SwingController;
-import com.dmdirc.addons.ui_swing.components.CheckBoxMenuItem;
-import com.dmdirc.interfaces.config.IdentityController;
+import com.dmdirc.plugins.PluginInfo;
 import com.dmdirc.plugins.implementations.BasePlugin;
-import com.dmdirc.ui.WindowManager;
-import com.dmdirc.util.URLBuilder;
 
-import java.awt.Toolkit;
-import java.awt.event.ActionEvent;
-import java.awt.event.ActionListener;
-
-import javax.swing.JCheckBoxMenuItem;
-import javax.swing.JMenu;
+import dagger.ObjectGraph;
 
 /**
  * Swing debug plugin. Provides long running EDT task violation detection and a console for
  * System.out and System.err.
  */
-public class SwingDebugPlugin extends BasePlugin implements ActionListener {
+public class SwingDebugPlugin extends BasePlugin {
 
-    /** The controller to read/write settings with. */
-    private final IdentityController identityController;
-    /** Swing controller. */
-    private final SwingController controller;
-    /** Window Management. */
-    private final WindowManager windowManager;
-    /** Debug menu. */
-    private JMenu debugMenu;
-    /** Debug EDT menu item. */
-    private JCheckBoxMenuItem debugEDT;
-    /** Debug EDT menu item. */
-    private JCheckBoxMenuItem showSysOut;
-    /** Debug EDT menu item. */
-    private JCheckBoxMenuItem showSysErr;
-    /** System out window. */
-    private SystemStreamContainer sysoutFrame;
-    /** System error window. */
-    private SystemStreamContainer syserrFrame;
-    /** URL Builder to use for frame containers. */
-    private final URLBuilder urlBuilder;
+    private SwingDebugManager manager;
 
-    public SwingDebugPlugin(
-            final IdentityController identityController,
-            final SwingController controller,
-            final WindowManager windowManager,
-            final URLBuilder urlBuilder) {
-        this.identityController = identityController;
-        this.controller = controller;
-        this.windowManager = windowManager;
-        this.urlBuilder = urlBuilder;
+    @Override
+    public void load(final PluginInfo pluginInfo, final ObjectGraph graph) {
+        super.load(pluginInfo, graph);
+        setObjectGraph(graph.plus(new SwingDebugModule(pluginInfo)));
+        manager = getObjectGraph().get(SwingDebugManager.class);
     }
 
-    /** {@inheritDoc} */
     @Override
     public void onLoad() {
-        debugMenu = new JMenu("Debug");
-        debugEDT = new CheckBoxMenuItem("Check EDT task length");
-        showSysOut = new CheckBoxMenuItem("Show System.out Console");
-        showSysErr = new CheckBoxMenuItem("Show System.err Console");
-        debugEDT.addActionListener(this);
-        showSysErr.addActionListener(this);
-        showSysOut.addActionListener(this);
-        controller.getMainFrame().getJMenuBar().add(debugMenu);
-        debugMenu.add(debugEDT);
-        debugMenu.add(showSysOut);
-        debugMenu.add(showSysErr);
+        manager.load();
     }
 
-    /** {@inheritDoc} */
     @Override
     public void onUnload() {
-        controller.getMainFrame().getJMenuBar().remove(debugMenu);
-    }
-
-    /**
-     * {@inheritDoc}
-     *
-     * @param e Action event
-     */
-    @Override
-    public void actionPerformed(final ActionEvent e) {
-        if (e.getSource() == debugEDT) {
-            if (debugEDT.getState()) {
-                Toolkit.getDefaultToolkit().getSystemEventQueue().
-                        push(new TracingEventQueue(this, identityController, controller));
-            } else {
-                Toolkit.getDefaultToolkit().getSystemEventQueue().
-                        push(new DMDircEventQueue(controller));
-            }
-        }
-        if (e.getSource() == showSysOut) {
-            if (showSysOut.isSelected()) {
-                sysoutFrame = new SystemStreamContainer(SystemStreamType.Out,
-                        controller.getGlobalConfig(), this, urlBuilder);
-                windowManager.addWindow(sysoutFrame);
-            } else {
-                sysoutFrame.close();
-            }
-        }
-
-        if (e.getSource() == showSysErr) {
-            if (showSysErr.isSelected()) {
-                syserrFrame = new SystemStreamContainer(SystemStreamType.Error,
-                        controller.getGlobalConfig(), this, urlBuilder);
-                windowManager.addWindow(syserrFrame);
-            } else {
-                syserrFrame.close();
-            }
-        }
-    }
-
-    /**
-     * Notifies this plugin the specified container is closing.
-     *
-     * @param container Container that is closing
-     */
-    void windowClosing(final SystemStreamContainer container) {
-        if (container == sysoutFrame) {
-            showSysOut.setSelected(false);
-        }
-        if (container == syserrFrame) {
-            showSysErr.setSelected(false);
-        }
+        manager.unload();
     }
 
 }

src/com/dmdirc/addons/swingdebug/SystemStreamContainer.java

@@ -38,25 +38,20 @@ public class SystemStreamContainer extends FrameContainer {
 
     /** Stream reader thread. */
     private SystemStreamRedirectThread thread;
-    /** Parent plugin. */
-    private SwingDebugPlugin plugin;
 
     /**
      * Creates a new system stream container wrapping the specified stream.
      *
      * @param stream     Stream to wrap
      * @param config     Config to wrap
-     * @param plugin     Parent plugin
      * @param urlBuilder The URL builder to use when finding icons.
      */
     public SystemStreamContainer(
             final SystemStreamType stream,
             final AggregateConfigProvider config,
-            final SwingDebugPlugin plugin,
             final URLBuilder urlBuilder) {
         super("dmdirc", stream.toString(), stream.toString(), config, urlBuilder,
                 Arrays.asList(WindowComponent.TEXTAREA.getIdentifier()));
-        this.plugin = plugin;
         try {
             thread = new SystemStreamRedirectThread(stream, getDocument());
             thread.start();
@@ -64,19 +59,16 @@ public class SystemStreamContainer extends FrameContainer {
         }
     }
 
-    /** {@inheritDoc} */
     @Override
     public Connection getConnection() {
         return getParent() == null ? null : getParent().getConnection();
     }
 
-    /** {@inheritDoc} */
     @Override
     public void close() {
         super.close();
 
         thread.cancel();
-        plugin.windowClosing(this);
     }
 
 }

src/com/dmdirc/addons/swingdebug/TracingEventQueue.java

@@ -28,9 +28,8 @@ package com.dmdirc.addons.swingdebug;
 
 import com.dmdirc.addons.ui_swing.DMDircEventQueue;
 import com.dmdirc.addons.ui_swing.SwingController;
+import com.dmdirc.interfaces.config.AggregateConfigProvider;
 import com.dmdirc.interfaces.config.ConfigChangeListener;
-import com.dmdirc.interfaces.config.IdentityController;
-import com.dmdirc.plugins.Plugin;
 
 import java.awt.AWTEvent;
 import java.io.IOException;
@@ -50,8 +49,7 @@ import javax.management.ObjectName;
  * Event queue extention to monitor long running tasks on the EDT. Original code found at
  * http://today.java.net/lpt/a/433 modified to work as a DMDirc plugin.
  */
-public class TracingEventQueue extends DMDircEventQueue implements
-        Runnable, ConfigChangeListener {
+public class TracingEventQueue extends DMDircEventQueue implements Runnable, ConfigChangeListener {
 
     /** Threshold before event is considered long running. */
     private long thresholdDelay;
@@ -61,33 +59,29 @@ public class TracingEventQueue extends DMDircEventQueue implements
     private ThreadMXBean threadBean;
     /** boolean to end thread. */
     private boolean running = false;
-    /** Parent plugin. */
-    private final Plugin parentPlugin;
-    /** The controller to read/write settings with. */
-    private final IdentityController identityController;
+    /** The controller to read settings from. */
+    private final AggregateConfigProvider config;
+    /** This plugin's settings domain. */
+    private final String domain;
     /** Tracing thread. */
     private Thread tracingThread;
 
     /**
      * Instantiates a new tracing thread.
      *
-     * @param parentPlugin       Parent plugin
-     * @param identityController The controller to read/write settings with.
-     * @param controller         Swing controller
+     * @param domain     This plugin's settings domain
+     * @param config     Config to read settings from
+     * @param controller Swing controller
      */
-    public TracingEventQueue(
-            final Plugin parentPlugin,
-            final IdentityController identityController,
+    public TracingEventQueue(final String domain, final AggregateConfigProvider config,
             final SwingController controller) {
         super(controller);
-        this.parentPlugin = parentPlugin;
-        this.identityController = identityController;
+        this.domain = domain;
+        this.config = config;
 
         eventTimeMap = Collections.synchronizedMap(new HashMap<AWTEvent, Long>());
-        identityController.getGlobalConfiguration().addChangeListener(
-                parentPlugin.getDomain(), "debugEDT", this);
-        identityController.getGlobalConfiguration().addChangeListener(
-                parentPlugin.getDomain(), "slowedttaskthreshold", this);
+        config.addChangeListener(domain, "debugEDT", this);
+        config.addChangeListener(domain, "slowedttaskthreshold", this);
         checkTracing();
 
         try {
@@ -161,7 +155,7 @@ public class TracingEventQueue extends DMDircEventQueue implements
                             threadId, Integer.MAX_VALUE);
                     if (threadInfo != null
                             && threadInfo.getThreadName().startsWith(
-                            "AWT-EventQueue")) {
+                                    "AWT-EventQueue")) {
                         System.out.println(threadInfo.getThreadName() + " / "
                                 + threadInfo.getThreadState());
                         final StackTraceElement[] stack = threadInfo.getStackTrace();
@@ -226,10 +220,8 @@ public class TracingEventQueue extends DMDircEventQueue implements
     }
 
     private void checkTracing() {
-        final boolean tracing = identityController.getGlobalConfiguration()
-                .getOptionBool(parentPlugin.getDomain(), "debugEDT");
-        thresholdDelay = identityController.getGlobalConfiguration()
-                .getOptionInt(parentPlugin.getDomain(), "slowedttaskthreshold");
+        final boolean tracing = config.getOptionBool(domain, "debugEDT");
+        thresholdDelay = config.getOptionInt(domain, "slowedttaskthreshold");
         if (tracing) {
             running = true;
             tracingThread = new Thread(this);