Add KeyBindingsChanged callin

cont/LuaUI/callins.lua

@@ -23,6 +23,7 @@ CallInsList = {
 	"MiniMapGeometryChanged",
 	"CommandNotify",
 
+	"KeyBindingsChanged",
 	"KeyMapChanged",
 	"KeyPress",
 	"KeyRelease",

cont/LuaUI/widgets.lua

@@ -195,6 +195,7 @@ local callInLists = {
   'AddConsoleLine',
   'ViewResize',
   'DrawScreen',
+  'KeyBindingsChanged',
   'KeyMapChanged',
   'KeyPress',
   'KeyRelease',
@@ -1416,6 +1417,12 @@ end
 --  Keyboard call-ins
 --
 
+function widgetHandler:KeyBindingsChanged()
+  for _,w in ipairs(self.KeyBindingsChangedList) do
+    w:KeyBindingsChanged()
+  end
+end
+
 function widgetHandler:KeyMapChanged()
   for _,w in ipairs(self.KeyMapChangedList) do
     w:KeyMapChanged()

rts/Game/UI/KeyBindings.cpp

@@ -9,6 +9,7 @@
 #include "KeySet.h"
 #include "Sim/Units/UnitDef.h"
 #include "Sim/Units/UnitDefHandler.h"
+#include "System/EventHandler.h"
 #include "System/FileSystem/FileHandler.h"
 #include "System/FileSystem/SimpleParser.h"
 #include "System/Log/ILog.h"
@@ -677,19 +678,17 @@ bool CKeyBindings::UnBind(const std::string& keystr, const std::string& command)
 	KeyMap& bindings = ks.IsKeyCode() ? codeBindings : scanBindings;
 	const auto it = bindings.find(ks);
 
-	if (it == bindings.end())
-		return false;
-
-	ActionList& al = it->second;
-	const bool success = RemoveCommandFromList(al, command);
+	if (it != bindings.end()) {
+		ActionList& al = it->second;
 
-	if (al.empty())
-		bindings.erase(it);
+		if (RemoveCommandFromList(al, command))
+			buildHotkeyMap = true;
 
-	if (success)
-		buildHotkeyMap = true;
+		if (al.empty())
+			bindings.erase(it);
+	}
 
-	return success;
+	return true;
 }
 
 
@@ -709,11 +708,11 @@ bool CKeyBindings::UnBindKeyset(const std::string& keystr)
 
 	const auto it = bindings.find(ks);
 
-	if (it == bindings.end())
-		return false;
+	if (it != bindings.end()) {
+		bindings.erase(it);
+		buildHotkeyMap = true;
+	}
 
-	bindings.erase(it);
-	buildHotkeyMap = true;
 	return true;
 }
 
@@ -756,7 +755,7 @@ bool CKeyBindings::UnBindAction(const std::string& command)
 	if (changed)
 		buildHotkeyMap = true;
 
-	return changed;
+	return true;
 }
 
 
@@ -880,6 +879,9 @@ bool CKeyBindings::ExecuteCommandInternal(const std::string& line)
 
 	const std::string command = StringToLower(words[0]);
 
+	// emit even on a no-op command so clients can tell it ran; keydebug is logging-only, so skip it
+	bool emitEvent = true;
+
 	if (command == "keydebug") {
 		if (words.size() == 1) {
 			// toggle
@@ -888,6 +890,7 @@ bool CKeyBindings::ExecuteCommandInternal(const std::string& line)
 			// set
 			debugEnabled = atoi(words[1].c_str());
 		}
+		emitEvent = false;
 	}
 	else if (command == "keyload") {
 		const std::string& filename = words.size() > 1 ? words[1] : DEFAULT_FILENAME;
@@ -952,15 +955,19 @@ bool CKeyBindings::ExecuteCommandInternal(const std::string& line)
 		return false;
 	}
 
-	return false;
+	return emitEvent;
 }
 
 
 bool CKeyBindings::ExecuteCommand(const std::string& line)
 {
-	const bool ret = ExecuteCommandInternal(line);
+	const bool emitEvent = ExecuteCommandInternal(line);
 	MaybeBuildHotkeyMap();
-	return ret;
+
+	if (emitEvent)
+		eventHandler.KeyBindingsChanged();
+
+	return emitEvent;
 }
 
 
@@ -1001,6 +1008,10 @@ bool CKeyBindings::Load(const std::string& filename)
 {
 	const bool ret = LoadInternal(filename);
 	MaybeBuildHotkeyMap();
+
+	if (ret)
+		eventHandler.KeyBindingsChanged();
+
 	return ret;
 }
 

rts/Lua/LuaHandle.cpp

@@ -3129,6 +3129,31 @@ void CLuaHandle::Pong(uint8_t pingTag, const spring_time pktSendTime, const spri
 	RunCallIn(L, cmdStr, 3, 0);
 }
 
+/*** Called after a keybinding command runs.
+ *
+ * Called when:
+ *
+ * - A keybinding command runs, e.g. `bind k action`. This may fire even when nothing actually changed (e.g. a redundant bind), so treat it as "a binding command ran", not a guarantee that bindings differ. An operation covering multiple keybindings fires a single event at the end, e.g. `keyreload`.
+ * - Any operation that changes how actions are retrieved from input triggers happened, e.g. `fakemeta space`.
+ *
+ * Nothing is passed; call `Spring.GetKeyBindings` to read the current state.
+ *
+ * @function Callins:KeyBindingsChanged
+ */
+void CLuaHandle::KeyBindingsChanged()
+{
+	RECOIL_DETAILED_TRACY_ZONE;
+	LUA_CALL_IN_CHECK(L);
+	luaL_checkstack(L, 2, __func__);
+
+	static const LuaHashString cmdStr(__func__);
+
+	if (!cmdStr.GetGlobalFunc(L))
+		return;
+
+	RunCallIn(L, cmdStr, 0, 0);
+}
+
 
 /*** Called when the keymap changes
  *

rts/Lua/LuaHandle.h

@@ -200,6 +200,7 @@ class CLuaHandle : public CEventClient
 		void UnsyncedHeightMapUpdate(const SRectangle& rect) override;
 		void Update() override;
 
+		void KeyBindingsChanged() override;
 		bool KeyMapChanged() override;
 		bool KeyPress(int keyCode, int scanCode, bool isRepeat) override;
 		bool KeyRelease(int keyCode, int scanCode) override;

rts/System/EventClient.cpp

@@ -61,6 +61,7 @@ void CEventClient::DrawLoadScreen() {}
 void CEventClient::LoadProgress(const std::string& msg, const bool replace_lastline) {}
 
 // from LuaUI
+void CEventClient::KeyBindingsChanged() {}
 bool CEventClient::KeyMapChanged() { return false; }
 bool CEventClient::KeyPress(int keyCode, int scanCode, bool isRepeat) { return false; }
 bool CEventClient::KeyRelease(int keyCode, int scanCode) { return false; }

rts/System/EventClient.h

@@ -287,6 +287,7 @@ class CEventClient
 		virtual void Update();
 		virtual void UnsyncedHeightMapUpdate(const SRectangle& rect);
 
+		virtual void KeyBindingsChanged();
 		virtual bool KeyMapChanged();
 		virtual bool KeyPress(int keyCode, int scanCode, bool isRepeat);
 		virtual bool KeyRelease(int keyCode, int scanCode);

rts/System/EventHandler.cpp

@@ -811,6 +811,12 @@ bool CEventHandler::CommandNotify(const Command& cmd)
 	return ControlReverseIterateDefTrue(listCommandNotify, &CEventClient::CommandNotify, cmd);
 }
 
+void CEventHandler::KeyBindingsChanged()
+{
+	ZoneScoped;
+	ITERATE_EVENTCLIENTLIST_NA(KeyBindingsChanged);
+}
+
 bool CEventHandler::KeyMapChanged()
 {
 	ZoneScoped;

rts/System/EventHandler.h

@@ -223,6 +223,7 @@ class CEventHandler
 		void UnsyncedHeightMapUpdate(const SRectangle& rect);
 		void Update();
 
+		void KeyBindingsChanged();
 		bool KeyMapChanged();
 		bool KeyPress(int keyCode, int scanCode, bool isRepeat);
 		bool KeyRelease(int keyCode, int scanCode);

rts/System/Events.def

@@ -101,6 +101,7 @@
 
 	SETUP_EVENT(Update,         MANAGED_BIT | UNSYNCED_BIT)
 
+	SETUP_EVENT(KeyBindingsChanged,  MANAGED_BIT | UNSYNCED_BIT)
 	SETUP_EVENT(KeyMapChanged,  MANAGED_BIT | UNSYNCED_BIT | CONTROL_BIT)
 	SETUP_EVENT(KeyPress,       MANAGED_BIT | UNSYNCED_BIT | CONTROL_BIT)
 	SETUP_EVENT(KeyRelease,     MANAGED_BIT | UNSYNCED_BIT | CONTROL_BIT)