GTK global hotkeys for Windows

Author: domnpp

src/hotkey/api_hotkey.h

@@ -1,3 +1,30 @@
+/*
+ *  api_hotkey.h
+ *  Audacious
+ *
+ *  Copyright (C) 2005-2020  Audacious team
+ *
+ *  XMMS - Cross-platform multimedia player
+ *  Copyright (C) 1998-2003  Peter Alm, Mikael Alm, Olle Hallnas,
+ *                           Thomas Nilsson and 4Front Technologies
+ *  Copyright (C) 1999-2003  Haavard Kvaalen
+ *
+ *  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; under version 3 of the License.
+ *
+ *  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>.
+ *
+ *  The Audacious team does not consider modular code linking to
+ *  Audacious or using our public API to be a derived work.
+*/
+
 #ifndef _X_HOTKEY_H_INCLUDED
 #define _X_HOTKEY_H_INCLUDED
 
@@ -32,6 +59,7 @@ class Hotkey
     static void add_hotkey(HotkeyConfiguration ** pphotkey, OS_KeySym keysym,
                            int mask, int type, EVENT event);
     static void key_to_string(int key, char ** out_keytext);
+    static char* create_human_readable_keytext(const char* const keytext, int key, int mask);
 };
 
 #ifndef _WIN32

src/hotkey/grab.h

@@ -1,3 +1,30 @@
+/*
+ *  grab.h
+ *  Audacious
+ *
+ *  Copyright (C) 2005-2020  Audacious team
+ *
+ *  XMMS - Cross-platform multimedia player
+ *  Copyright (C) 1998-2003  Peter Alm, Mikael Alm, Olle Hallnas,
+ *                           Thomas Nilsson and 4Front Technologies
+ *  Copyright (C) 1999-2003  Haavard Kvaalen
+ *
+ *  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; under version 3 of the License.
+ *
+ *  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>.
+ *
+ *  The Audacious team does not consider modular code linking to
+ *  Audacious or using our public API to be a derived work.
+*/
+
 #ifndef _GRAB_H_INCLUDED_
 #define _GRAB_H_INCLUDED_
 

src/hotkey/gui.cc

@@ -2,8 +2,8 @@
  *  This file is part of audacious-hotkey plugin for audacious
  *
  *  Copyright (c) 2007 - 2008  Sascha Hlusiak <[email protected]>
- *  Name: gui.c
- *  Description: gui.c
+ *  Name: gui.cc
+ *  Description: gui.cc
  *
  *  Part of this code is from itouch-ctrl plugin.
  *  Authors of itouch-ctrl are listed below:
@@ -90,7 +90,6 @@ static const char * event_desc[EVENT_MAX] = {
 static gboolean on_entry_key_press_event(GtkWidget * widget,
                                          GdkEventKey * event, void * user_data)
 {
-    AUDDBG("lHotkeyFlow:Entry");
     KeyControls * controls = (KeyControls *)user_data;
 
     if (event->keyval == GDK_Tab)
@@ -99,6 +98,10 @@ static gboolean on_entry_key_press_event(GtkWidget * widget,
         return false;
     if (event->keyval == GDK_Return && ((event->state & ~GDK_LOCK_MASK) == 0))
         return false;
+#ifdef _WIN32
+    if (event->keyval == GDK_Meta_L || event->keyval == GDK_Meta_R)
+        return false;
+#endif
     if (event->keyval == GDK_ISO_Left_Tab)
     {
         Hotkey::set_keytext(controls->keytext, controls->hotkey.key,
@@ -126,7 +129,7 @@ static gboolean on_entry_key_press_event(GtkWidget * widget,
 
     Hotkey::set_keytext(controls->keytext, is_mod ? 0 : event->hardware_keycode,
                         mod, TYPE_KEY);
-    AUDDBG("lHotkeyFlow:Leave");
+    // Returning TRUE indicates that the event has been handled, and that it should not propagate further.
     return true;
 }
 
@@ -299,11 +302,7 @@ void * make_config_widget()
     load_config();
 
     plugin_cfg = get_config();
-
-    // NOTE d: implement in WIN
-#ifndef _WIN32
     ungrab_keys();
-#endif
 
     main_vbox = gtk_vbox_new(false, 4);
 
@@ -503,12 +502,7 @@ void add_callback(GtkWidget * widget, void * data)
 void destroy_callback()
 {
     KeyControls * controls = first_controls;
-
-    // NOTE d: implement in WIN
-#ifndef _WIN32
     grab_keys();
-#endif
-
     while (controls)
     {
         KeyControls * old;

src/hotkey/gui.h

@@ -1,3 +1,30 @@
+/*
+ *  gui.h
+ *  Audacious
+ *
+ *  Copyright (C) 2005-2020  Audacious team
+ *
+ *  XMMS - Cross-platform multimedia player
+ *  Copyright (C) 1998-2003  Peter Alm, Mikael Alm, Olle Hallnas,
+ *                           Thomas Nilsson and 4Front Technologies
+ *  Copyright (C) 1999-2003  Haavard Kvaalen
+ *
+ *  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; under version 3 of the License.
+ *
+ *  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>.
+ *
+ *  The Audacious team does not consider modular code linking to
+ *  Audacious or using our public API to be a derived work.
+*/
+
 #ifndef _GUI_H_INCLUDED_
 #define _GUI_H_INCLUDED_
 

src/hotkey/hotkey_api_common.cc

@@ -1,4 +1,29 @@
-
+/*
+ *  hotkey_api_common.cc
+ *  Audacious
+ *
+ *  Copyright (C) 2005-2020  Audacious team
+ *
+ *  XMMS - Cross-platform multimedia player
+ *  Copyright (C) 1998-2003  Peter Alm, Mikael Alm, Olle Hallnas,
+ *                           Thomas Nilsson and 4Front Technologies
+ *  Copyright (C) 1999-2003  Haavard Kvaalen
+ *
+ *  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; under version 3 of the License.
+ *
+ *  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>.
+ *
+ *  The Audacious team does not consider modular code linking to
+ *  Audacious or using our public API to be a derived work.
+*/
 
 #include "api_hotkey.h"
 #include <X11/X.h>
@@ -38,10 +63,6 @@ template int Hotkey::calculate_mod<GdkEventButton>(GdkEventButton * event);
 
 std::pair<int, int> Hotkey::get_is_mod(GdkEventKey * event)
 {
-#ifdef _WIN32
-    AUDDBG("lHotkeyFlow:Win call: get_is_mod.%s",
-           gdk_keyval_name(event->keyval));
-#endif
     int mod = 0;
     int is_mod = 0;
 
@@ -83,14 +104,7 @@ void Hotkey::set_keytext(GtkWidget * entry, int key, int mask, int type)
     }
     else
     {
-        static const char * modifier_string[] = {
-            "Control", "Shift", "Alt", "Mod2", "Mod3", "Super", "Mod5"};
-        static const unsigned int modifiers[] = {
-            HK_CONTROL_MASK, HK_SHIFT_MASK, HK_MOD1_ALT_MASK, HK_MOD2_MASK,
-            HK_MOD3_MASK,    HK_MOD4_MASK,  HK_MOD5_MASK};
-        const char * strings[9];
         char * keytext = nullptr;
-        int i, j;
         if (type == TYPE_KEY)
         {
             Hotkey::key_to_string(key, &keytext);
@@ -99,17 +113,7 @@ void Hotkey::set_keytext(GtkWidget * entry, int key, int mask, int type)
         {
             keytext = g_strdup_printf("Button%d", key);
         }
-
-        for (i = 0, j = 0; j < 7; j++)
-        {
-            if (mask & modifiers[j])
-                strings[i++] = modifier_string[j];
-        }
-        if (key != 0)
-            strings[i++] = keytext;
-        strings[i] = nullptr;
-
-        text = g_strjoinv(" + ", (char **)strings);
+        text = Hotkey::create_human_readable_keytext(keytext, key, mask);
         g_free(keytext);
     }
 

src/hotkey/plugin.cc

@@ -2,8 +2,8 @@
  *  This file is part of audacious-hotkey plugin for audacious
  *
  *  Copyright (c) 2007 - 2008  Sascha Hlusiak <[email protected]>
- *  Name: plugin.c
- *  Description: plugin.c
+ *  Name: plugin.cc
+ *  Description: plugin.cc
  *
  *  Part of this code is from itouch-ctrl plugin.
  *  Authors of itouch-ctrl are listed below:
@@ -46,12 +46,13 @@
 #include "api_hotkey.h"
 #include "grab.h"
 #include "gui.h"
-#include "plugin.h"
 
 #ifdef BUILT_FROM_CMAKE
 #include "../../audacious-plugins_simpleAF/src/thirdparty/d_custom_logger.hpp"
 #endif
 
+extern bool system_up_and_running;
+
 class GlobalHotkeys : public GeneralPlugin
 {
 public:
@@ -66,28 +67,24 @@ class GlobalHotkeys : public GeneralPlugin
     void cleanup() override;
 };
 
-EXPORT GlobalHotkeys aud_plugin_instance;
-
-#ifndef _WIN32
 /* global vars */
-static
-#else
-PluginConfig plugin_cfg;
-#endif
-
-    const char GlobalHotkeys::about[] = N_(
-        "Global Hotkey Plugin\n"
-        "Control the player with global key combinations or multimedia "
-        "keys.\n\n"
-        "Copyright (C) 2007-2008 Sascha Hlusiak <[email protected]>\n\n"
-        "Contributors include:\n"
-        "Copyright (C) 2006-2007 Vladimir Paskov <[email protected]>\n"
-        "Copyright (C) 2000-2002 Ville Syrjälä <[email protected]>,\n"
-        " Bryn Davies <[email protected]>,\n"
-        " Jonathan A. Davis <[email protected]>,\n"
-        " Jeremy Tan <[email protected]>");
-
-PluginConfig * get_config() { return &plugin_cfg; }
+EXPORT GlobalHotkeys aud_plugin_instance;
+PluginConfig plugin_cfg_gtk_global_hk;
+
+const char GlobalHotkeys::about[] =
+    N_("Global Hotkey Plugin\n"
+       "Control the player with global key combinations or multimedia "
+       "keys.\n\n"
+       "Copyright (C) 2007-2008 Sascha Hlusiak <[email protected]>\n\n"
+       "Contributors include:\n"
+       "Copyright (C) 2020 Domen Mori <[email protected]>\n"
+       "Copyright (C) 2006-2007 Vladimir Paskov <[email protected]>\n"
+       "Copyright (C) 2000-2002 Ville Syrjälä <[email protected]>,\n"
+       " Bryn Davies <[email protected]>,\n"
+       " Jonathan A. Davis <[email protected]>,\n"
+       " Jeremy Tan <[email protected]>");
+
+PluginConfig * get_config() { return &plugin_cfg_gtk_global_hk; }
 
 /*
  * plugin activated
@@ -104,8 +101,9 @@ bool GlobalHotkeys::init()
     }
 #ifdef _WIN32
     win_init();
-#endif
+#else
     setup_filter();
+#endif
     load_config();
     grab_keys();
     return true;
@@ -296,10 +294,9 @@ gboolean handle_keyevent(EVENT event)
 
 void load_defaults()
 {
-    AUDDBG("lHotkeyFlow:Entry, loading defaults.");
     HotkeyConfiguration * hotkey;
 
-    hotkey = &(plugin_cfg.first);
+    hotkey = &(plugin_cfg_gtk_global_hk.first);
 
     Hotkey::add_hotkey(&hotkey, OS_KEY_AudioPrev, 0, TYPE_KEY,
                        EVENT_PREV_TRACK);
@@ -329,7 +326,7 @@ void load_config()
     HotkeyConfiguration * hotkey;
     int i, max;
 
-    hotkey = &(plugin_cfg.first);
+    hotkey = &(plugin_cfg_gtk_global_hk.first);
     hotkey->next = nullptr;
     hotkey->key = 0;
     hotkey->mask = 0;
@@ -378,7 +375,7 @@ void save_config()
     int max;
     HotkeyConfiguration * hotkey;
 
-    hotkey = &(plugin_cfg.first);
+    hotkey = &(plugin_cfg_gtk_global_hk.first);
     max = 0;
     while (hotkey)
     {
@@ -411,14 +408,17 @@ void save_config()
 
 void GlobalHotkeys::cleanup()
 {
+#ifdef _WIN32
+    system_up_and_running = false;
+#endif
 #ifdef BUILT_FROM_CMAKE
+    AUDWARN("Cleanup of globalHotkeys");
     audlog::unsubscribe(&DCustomLogger::go);
 #endif
-
     HotkeyConfiguration * hotkey;
     ungrab_keys();
     release_filter();
-    hotkey = &(plugin_cfg.first);
+    hotkey = &(plugin_cfg_gtk_global_hk.first);
     hotkey = hotkey->next;
     while (hotkey)
     {
@@ -427,8 +427,8 @@ void GlobalHotkeys::cleanup()
         hotkey = hotkey->next;
         g_free(old);
     }
-    plugin_cfg.first.next = nullptr;
-    plugin_cfg.first.key = 0;
-    plugin_cfg.first.event = (EVENT)0;
-    plugin_cfg.first.mask = 0;
+    plugin_cfg_gtk_global_hk.first.next = nullptr;
+    plugin_cfg_gtk_global_hk.first.key = 0;
+    plugin_cfg_gtk_global_hk.first.event = (EVENT)0;
+    plugin_cfg_gtk_global_hk.first.mask = 0;
 }