Add plugin to flash taskbar on windows

Depends-On: Iabc748b6d190b218f771c62a9e713259f81dcc9e
Depends-On: Ief644141e53c63aea5f1e7a405d1623fca5fbd10
Change-Id: Ia4e2bf42b18f88b2138a03a2484e903bfe67df15
Reviewed-on: http://gerrit.dmdirc.com/1867
Automatic-Compile: DMDirc Local Commits <dmdirc@googlemail.com>
Reviewed-by: Chris Smith <chris@dmdirc.com>

src/com/dmdirc/addons/windowflashing/FlashWindow.java

@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) 2006-2011 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * 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.windowflashing;
+
+import com.dmdirc.FrameContainer;
+import com.dmdirc.commandparser.CommandArguments;
+import com.dmdirc.commandparser.CommandInfo;
+import com.dmdirc.commandparser.CommandType;
+import com.dmdirc.commandparser.commands.Command;
+import com.dmdirc.commandparser.commands.context.CommandContext;
+
+/**
+ * Command to flash an inactive window under Windows.
+ */
+public class FlashWindow extends Command implements CommandInfo {
+    
+    private final WindowFlashing plugin;
+
+    /**
+     * Creates a new flash window command.
+     *
+     * @param plugin Parent plugin to trigger window flashing
+     */
+    public FlashWindow(final WindowFlashing plugin) {
+        super();
+        this.plugin = plugin;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void execute(final FrameContainer<?> origin,
+            final CommandArguments args, final CommandContext context) {
+        plugin.flashWindow();
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getName() {
+        return "flashwindow";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public boolean showInHelp() {
+        return true;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getHelp() {
+        return "flashwindow - Flashes the window until activated";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public CommandType getType() {
+        return CommandType.TYPE_GLOBAL;
+    }
+
+}

src/com/dmdirc/addons/windowflashing/WindowFlashing.java

@@ -0,0 +1,112 @@
+/*
+ * Copyright (c) 2006-2011 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * 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.windowflashing;
+
+import com.dmdirc.addons.ui_swing.MainFrame;
+import com.dmdirc.addons.ui_swing.SwingController;
+import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.plugins.Plugin;
+import com.dmdirc.plugins.PluginManager;
+
+import com.sun.jna.Native;
+import com.sun.jna.NativeLibrary;
+import com.sun.jna.Pointer;
+import com.sun.jna.platform.win32.User32;
+import com.sun.jna.platform.win32.WinDef.HWND;
+import com.sun.jna.platform.win32.WinUser.FLASHWINFO;
+
+/**
+ * Native notification plugin to make DMDirc support windows task bar flashing.
+ */
+public class WindowFlashing extends Plugin {
+
+    /** Stops the window flashing. */
+    private static final int FLASHW_STOP = 0; //NOPMD
+    /** Flashes the window caption. */
+    private static final int FLASHW_CAPTION = 1; //NOPMD
+    /** Flashes the window's taskbar entry. */
+    private static final int FLASHW_TRAY = 2; //NOPMD
+    /** Flash both the window's caption and taskbar entry. */
+    private static final int FLASHW_ALL = 3;
+    /** Flash until FLASHW_STOP is set. */
+    private static final int FLASHW_TIMER = 4; //NOPMD
+    /** Flash until the window gains focus. */
+    private static final int FLASHW_TIMERNOFG = 12;
+    /** Library instance. */
+    private User32 user32;
+    /** Flash info object. */
+    private FLASHWINFO flashInfo;
+    /** Swing main frame. */
+    private MainFrame mainFrame;
+    /** Flash window command. */
+    private FlashWindow flashCommand;
+
+    /**
+     * Flashes an inactive window under windows.
+     */
+    public void flashWindow() {
+        user32.FlashWindowEx(flashInfo);
+    }
+
+    /**
+     * Flashes an inactive window under windows, used as a showNotifications
+     * exported command
+     *
+     * @param title Unused
+     * @param message Unused
+     */
+    public void flashNotification(final String title, final String message) {
+        flashWindow();
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void onLoad() {
+        flashCommand = new FlashWindow(this);
+        CommandManager.registerCommand(flashCommand);
+        mainFrame = ((SwingController) PluginManager
+                .getPluginManager().getPluginInfoByName("ui_swing")
+                .getPlugin()).getMainFrame();
+        user32 = (User32) Native.loadLibrary("user32", User32.class);
+        final HWND hwnd = new HWND();
+        final Pointer pointer = Native.getWindowPointer(mainFrame);
+        hwnd.setPointer(pointer);
+        flashInfo = new FLASHWINFO();
+        flashInfo.dwFlags = FLASHW_ALL | FLASHW_TIMERNOFG;
+        flashInfo.dwTimeout = 0;
+        flashInfo.uCount = Integer.MAX_VALUE;
+        flashInfo.hWnd = hwnd;
+        flashInfo.cbSize = flashInfo.size();
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void onUnload() {
+        CommandManager.unregisterCommand(flashCommand);
+        flashCommand = null;
+        mainFrame = null;
+        user32 = null;
+        flashInfo = null;
+        NativeLibrary.getInstance("user32").dispose();
+    }
+}

src/com/dmdirc/addons/windowflashing/plugin.config

@@ -0,0 +1,32 @@
+# This is a DMDirc configuration file.
+
+# This section indicates which sections below take key/value
+# pairs, rather than a simple list. It should be placed above
+# any sections that take key/values.
+keysections:
+  metadata
+  updates
+  version
+  requires
+
+metadata:
+  author=Greg <greg@dmdirc.com>
+  mainclass=com.dmdirc.addons.windowflashing.WindowFlashing
+  description=Window flashing
+  name=windowflashing
+  nicename=Window Flashing
+
+version:
+  friendly=0.1
+
+updates:
+  id=64
+
+requires:
+  os=.*windows.*
+
+provides:
+  windowflash command
+
+exports:
+  flashNotification in com.dmdirc.addons.windowflashing.WindowFlashing as showNotification