Expose key modifier state to C++/Lua

library/Core.cpp

@@ -1091,6 +1091,7 @@ bool Core::Init()
     screen_window = new Windows::top_level_window();
     screen_window->addChild(new Windows::dfhack_dummy(5,10));
     started = true;
+    modstate = 0;
 
     cerr << "Starting the TCP listener.\n";
     server = new ServerMain();
@@ -1579,7 +1580,7 @@ int UnicodeAwareSym(const SDL::KeyboardEvent& ke)
 //MEMO: return false if event is consumed
 int Core::DFH_SDL_Event(SDL::Event* ev)
 {
-    static bool alt = 0;
+    //static bool alt = 0;
 
     // do NOT process events before we are ready.
     if(!started) return true;
@@ -1589,31 +1590,27 @@ int Core::DFH_SDL_Event(SDL::Event* ev)
     {
         auto ke = (SDL::KeyboardEvent *)ev;
 
-        if (ke->ksym.sym == SDL::K_LALT || ke->ksym.sym == SDL::K_RALT)
+        if (ke->ksym.sym == SDL::K_LSHIFT || ke->ksym.sym == SDL::K_RSHIFT)
-        {
+            modstate = (ev->type == SDL::ET_KEYDOWN) ? modstate | MOD_SHIFT : modstate & ~MOD_SHIFT;
-            alt = (ev->type == SDL::ET_KEYDOWN);
+        else if (ke->ksym.sym == SDL::K_LCTRL || ke->ksym.sym == SDL::K_RCTRL)
-        }
+            modstate = (ev->type == SDL::ET_KEYDOWN) ? modstate | MOD_CTRL : modstate & ~MOD_CTRL;
-        else
+        else if (ke->ksym.sym == SDL::K_LALT || ke->ksym.sym == SDL::K_RALT)
-        if(ke->state == SDL::BTN_PRESSED && !hotkey_states[ke->ksym.sym])
+            modstate = (ev->type == SDL::ET_KEYDOWN) ? modstate | MOD_ALT : modstate & ~MOD_ALT;
+        else if(ke->state == SDL::BTN_PRESSED && !hotkey_states[ke->ksym.sym])
         {
             hotkey_states[ke->ksym.sym] = true;
 
-            int mod = 0;
-            if (ke->ksym.mod & SDL::KMOD_SHIFT) mod |= 1;
-            if (ke->ksym.mod & SDL::KMOD_CTRL) mod |= 2;
-            if (alt) mod |= 4;
-
             // Use unicode so Windows gives the correct value for the
             // user's Input Language
             if((ke->ksym.unicode & 0xff80) == 0)
             {
                 int key = UnicodeAwareSym(*ke);
-                SelectHotkey(key, mod);
+                SelectHotkey(key, modstate);
             }
             else
             {
                 // Pretend non-ascii characters don't happen:
-                SelectHotkey(ke->ksym.sym, mod);
+                SelectHotkey(ke->ksym.sym, modstate);
             }
         }
         else if(ke->state == SDL::BTN_RELEASED)

library/LuaApi.cpp

@@ -2008,10 +2008,12 @@ static void *checkaddr(lua_State *L, int idx, bool allow_null = false)
 
 static uint32_t getImageBase() { return Core::getInstance().p->getBase(); }
 static int getRebaseDelta() { return Core::getInstance().vinfo->getRebaseDelta(); }
+static int8_t getModstate() { return Core::getInstance().getModstate(); }
 
 static const LuaWrapper::FunctionReg dfhack_internal_module[] = {
     WRAP(getImageBase),
     WRAP(getRebaseDelta),
+    WRAP(getModstate),
     { NULL, NULL }
 };
 
@@ -2351,6 +2353,22 @@ static int internal_runCommand(lua_State *L)
     return 1;
 }
 
+static int internal_getModifiers(lua_State *L)
+{
+    int8_t modstate = Core::getInstance().getModstate();
+    lua_newtable(L);
+    lua_pushstring(L, "shift");
+    lua_pushboolean(L, modstate & MOD_SHIFT);
+    lua_settable(L, -3);
+    lua_pushstring(L, "ctrl");
+    lua_pushboolean(L, modstate & MOD_CTRL);
+    lua_settable(L, -3);
+    lua_pushstring(L, "alt");
+    lua_pushboolean(L, modstate & MOD_ALT);
+    lua_settable(L, -3);
+    return 1;
+}
+
 static const luaL_Reg dfhack_internal_funcs[] = {
     { "getAddress", internal_getAddress },
     { "setAddress", internal_setAddress },
@@ -2365,6 +2383,7 @@ static const luaL_Reg dfhack_internal_funcs[] = {
     { "diffscan", internal_diffscan },
     { "getDir", internal_getDir },
     { "runCommand", internal_runCommand },
+    { "getModifiers", internal_getModifiers },
     { NULL, NULL }
 };
 

library/include/Core.h

@@ -36,6 +36,10 @@ distribution.
 
 #include "RemoteClient.h"
 
+#define MOD_SHIFT 1
+#define MOD_CTRL 2
+#define MOD_ALT 4
+
 struct WINDOW;
 
 namespace tthread
@@ -142,6 +146,7 @@ namespace DFHack
         bool ClearKeyBindings(std::string keyspec);
         bool AddKeyBinding(std::string keyspec, std::string cmdline);
         std::vector<std::string> ListKeyBindings(std::string keyspec);
+        int8_t getModstate() { return modstate; }
 
         std::string getHackPath();
 
@@ -216,6 +221,7 @@ namespace DFHack
             std::string cmdline;
             std::string focus;
         };
+        int8_t modstate;
 
         std::map<int, std::vector<KeyBinding> > key_bindings;
         std::map<int, bool> hotkey_states;