Allow "Super" as a hotkey modifier

Author: NicksWorld

.gitignore

@@ -1,6 +1,6 @@
 # linux backup files
 *~
-
+.cache
 # Kdevelop project files
 *.kdev4
 .kdev4

docs/builtins/keybinding.rst

@@ -9,7 +9,7 @@ Like any other command, it can be used at any time from the console, but
 bindings are not remembered between runs of the game unless re-created in
 :file:`dfhack-config/init/dfhack.init`.
 
-Hotkeys can be any combinations of Ctrl/Alt/Shift with any key recognized by SDL.
+Hotkeys can be any combinations of Ctrl/Alt/Super/Shift with any key recognized by SDL.
 You can also represent mouse buttons beyond the first three with ``MOUSE4``
 through ``MOUSE15``.
 
@@ -29,7 +29,7 @@ Usage
 
 The ``<key>`` parameter above has the following case-insensitive syntax::
 
-    [Ctrl-][Alt-][Shift-]KEY[@context[|context...]]
+    [Ctrl-][Alt-][Super-][Shift-]KEY[@context[|context...]]
 
 where the ``KEY`` part can be any recognized key and :kbd:`[`:kbd:`]` denote
 optional parts.

docs/dev/Lua API.rst

@@ -3535,7 +3535,7 @@ and are only documented here for completeness:
 * ``dfhack.internal.getModifiers()``
 
   Returns the state of the keyboard modifier keys in a table of string ->
-  boolean. The keys are ``ctrl``, ``shift``, and ``alt``.
+  boolean. The keys are ``ctrl``, ``shift``, ``super``, and ``alt``.
 
 * ``dfhack.internal.getSuppressDuplicateKeyboardEvents()``
 * ``dfhack.internal.setSuppressDuplicateKeyboardEvents(suppress)``

library/Core.cpp

@@ -2439,6 +2439,8 @@ bool Core::doSdlInputEvent(SDL_Event* ev)
             modstate = (ev->type == SDL_KEYDOWN) ? modstate | DFH_MOD_CTRL : modstate & ~DFH_MOD_CTRL;
         else if (sym == SDLK_LALT || sym == SDLK_RALT)
             modstate = (ev->type == SDL_KEYDOWN) ? modstate | DFH_MOD_ALT : modstate & ~DFH_MOD_ALT;
+        else if (sym == SDLK_LGUI || sym == SDLK_RGUI) // Renamed to LMETA/RMETA in SDL3
+            modstate = (ev->type == SDL_KEYDOWN) ? modstate | DFH_MOD_SUPER : modstate & ~DFH_MOD_SUPER;
         else if (ke.state == SDL_PRESSED && !hotkey_states[sym])
         {
             // the check against hotkey_states[sym] ensures we only process keybindings once per keypress

library/LuaApi.cpp

@@ -4073,6 +4073,9 @@ static int internal_getModifiers(lua_State *L)
     lua_pushstring(L, "alt");
     lua_pushboolean(L, modstate & DFH_MOD_ALT);
     lua_settable(L, -3);
+    lua_pushstring(L, "super");
+    lua_pushboolean(L, modstate & DFH_MOD_SUPER);
+    lua_settable(L, -3);
     return 1;
 }
 

library/include/Core.h

@@ -58,6 +58,7 @@ namespace DFHack
     constexpr auto DFH_MOD_SHIFT = 1;
     constexpr auto DFH_MOD_CTRL = 2;
     constexpr auto DFH_MOD_ALT = 4;
+    constexpr auto DFH_MOD_SUPER = 8;
 
     class Process;
     class Module;

library/modules/Hotkey.cpp

@@ -42,6 +42,7 @@ std::string Hotkey::keyspec_to_string(const KeySpec &spec, bool include_focus) {
     std::string sym;
     if (spec.modifiers & DFH_MOD_CTRL) sym += "Ctrl-";
     if (spec.modifiers & DFH_MOD_ALT) sym += "Alt-";
+    if (spec.modifiers & DFH_MOD_SUPER) sym += "Super-";
     if (spec.modifiers & DFH_MOD_SHIFT) sym += "Shift-";
 
     std::string key_name;
@@ -91,7 +92,10 @@ std::optional<KeySpec> Hotkey::parseKeySpec(std::string spec, std::string* err)
         }
         return found;
     };
-    while (match_modifier("shift-", DFH_MOD_SHIFT) || match_modifier("ctrl-", DFH_MOD_CTRL) || match_modifier("alt-", DFH_MOD_ALT)) {}
+    while (match_modifier("shift-", DFH_MOD_SHIFT)
+            || match_modifier("ctrl-", DFH_MOD_CTRL)
+            || match_modifier("alt-", DFH_MOD_ALT)
+            || match_modifier("super-", DFH_MOD_SUPER)) {}
 
     out.sym = DFSDL::DFSDL_GetKeyFromName(spec.c_str());
     if (out.sym != SDLK_UNKNOWN)