Integrate RmlUi

.gitmodules

@@ -30,3 +30,9 @@
 [submodule "rts/lib/cereal"]
 	path = rts/lib/cereal
 	url = https://github.com/USCiLab/cereal.git
+[submodule "rts/lib/RmlUi"]
+	path = rts/lib/RmlUi
+	url = https://github.com/mikke89/RmlUi.git
+[submodule "rts/lib/lunasvg"]
+	path = rts/lib/lunasvg
+	url = https://github.com/sammycage/lunasvg.git

CMakeLists.txt

@@ -70,6 +70,9 @@ else()
 	set(JAVA_COMPILE_FLAG_CONDITIONAL "-g:lines,source")
 endif()
 
+# By default, the libraries that don't explicily specify SHARED/STATIC are build statically.
+# See https://cmake.org/cmake/help/latest/variable/BUILD_SHARED_LIBS.html
+option(BUILD_SHARED_LIBS "Build shared (dynamic) libraries" OFF)
 
 # Tell windows to pass arguments around in @response files
 # (32k arg limit workaround)

cont/LuaUI/main.lua

@@ -13,7 +13,8 @@
 
 Spring.SendCommands({"ctrlpanel " .. LUAUI_DIRNAME .. "ctrlpanel.txt"})
 
-VFS.Include(LUAUI_DIRNAME .. 'utils.lua', utilFile)
+VFS.Include(LUAUI_DIRNAME .. "rml_setup.lua",  nil, VFS.ZIP)
+VFS.Include(LUAUI_DIRNAME .. 'utils.lua', nil, VFS.ZIP)
 
 include("setupdefs.lua")
 include("savetable.lua")

cont/LuaUI/rml_setup.lua

@@ -0,0 +1,27 @@
+--  file:    rml.lua
+--  brief:   RmlUi Setup
+--  author:  lov + ChrisFloofyKitsune
+--
+--  Copyright (C) 2024.
+--  Licensed under the terms of the GNU GPL, v2 or later.
+
+if (RmlGuard or not RmlUi) then
+	return
+end
+RmlGuard = true
+
+-- Load fonts
+RmlUi.LoadFontFace("Fonts/FreeMonoBold.ttf", true)
+
+-- Mouse Cursor Aliases
+--[[
+	These let standard CSS cursor names be used when doing styling.
+	If a cursor set via RCSS does not have an alias, it is unchanged.
+	CSS cursor list: https://developer.mozilla.org/en-US/docs/Web/CSS/cursor
+	RmlUi documentation: https://mikke89.github.io/RmlUiDoc/pages/rcss/user_interface.html#cursor
+]]
+
+-- when "cursor: normal" is set via RCSS, "cursornormal" will be sent to the engine
+RmlUi.SetMouseCursorAlias("default", 'cursornormal')
+-- for command cursors, use the command name
+-- RmlUi.SetMouseCursorAlias("pointer", 'Move')

cont/LuaUI/system.lua

@@ -35,6 +35,7 @@ if (System == nil) then
     CMD = CMD,
     CMDTYPE = CMDTYPE,
     LOG = LOG,
+    RmlUi = RmlUi,
 
     UnitDefs        = UnitDefs,
     UnitDefNames    = UnitDefNames,

rts/CMakeLists.txt

@@ -139,6 +139,7 @@ add_subdirectory(Lua)
 add_subdirectory(ExternalAI)
 add_subdirectory(Rendering)
 add_subdirectory(aGui)
+add_subdirectory(Rml)
 add_subdirectory(Menu)
 add_subdirectory(Map)
 add_subdirectory(Net)
@@ -152,6 +153,8 @@ make_global_var(engineSources
 		${sources_engine_Map}
 		${sources_engine_Rendering}
 		${sources_engine_aGui}
+		${sources_engine_Rml}
+		${sources_engine_RmlSolLua}
 		${sources_engine_Menu}
 		${sources_engine_System}
 		${sources_engine_ExternalAI}

rts/Game/Game.cpp

@@ -2,6 +2,8 @@
 
 #include "Rendering/GL/myGL.h"
 
+#include <Rml/Backends/RmlUi_Backend.h>
+#include <RmlUi/Core.h>
 #include "Game.h"
 #include "Camera.h"
 #include "CameraHandler.h"
@@ -296,6 +298,7 @@ CGame::~CGame()
 	ENTER_SYNCED_CODE();
 	LOG("[Game::%s][1]", __func__);
 
+	RmlGui::Shutdown();
 	helper->Kill();
 	KillLua(true);
 	KillMisc();
@@ -828,6 +831,8 @@ void CGame::LoadInterface()
 		GameSetupDrawer::Disable();
 		GameSetupDrawer::Enable();
 	}
+
+	RmlGui::Initialize();
 }
 
 void CGame::LoadLua(bool dryRun, bool onlyUnsynced)
@@ -1105,6 +1110,9 @@ int CGame::KeyPressed(int keyCode, int scanCode, bool isRepeat)
 
 	lastActionList = keyBindings.GetActionList(curKeyCodeChain, curScanCodeChain);
 
+	if (RmlGui::ProcessKeyPressed(keyCode, scanCode, isRepeat))
+		return 0;
+
 	if (gameTextInput.ConsumePressedKey(keyCode, scanCode, lastActionList))
 		return 0;
 
@@ -1145,6 +1153,9 @@ int CGame::KeyPressed(int keyCode, int scanCode, bool isRepeat)
 int CGame::KeyReleased(int keyCode, int scanCode)
 {
 	RECOIL_DETAILED_TRACY_ZONE;
+	if (RmlGui::ProcessKeyReleased(keyCode, scanCode))
+		return 0;
+
 	if (gameTextInput.ConsumeReleasedKey(keyCode, scanCode))
 		return 0;
 
@@ -1180,6 +1191,9 @@ int CGame::KeyMapChanged()
 int CGame::TextInput(const std::string& utf8Text)
 {
 	RECOIL_DETAILED_TRACY_ZONE;
+	if (RmlGui::ProcessTextInput(utf8Text))
+		return 0;
+
 	if (eventHandler.TextInput(utf8Text))
 		return 0;
 
@@ -1473,6 +1487,7 @@ bool CGame::Draw() {
 	if (UpdateUnsynced(currentTimePreUpdate))
 		return false;
 
+	RmlGui::Update();
 	const spring_time currentTimePreDraw = spring_gettime();
 
 	SCOPED_SPECIAL_TIMER("Draw");
@@ -1560,6 +1575,7 @@ bool CGame::Draw() {
 		DrawInputReceivers();
 		DrawInputText();
 		DrawInterfaceWidgets();
+		RmlGui::RenderFrame();
 		mouse->DrawCursor();
 
 		eventHandler.DrawScreenPost();

rts/Game/UI/GuiHandler.cpp

@@ -2,6 +2,7 @@
 
 #include "GuiHandler.h"
 
+#include <Rml/Backends/RmlUi_Backend.h>
 #include "CommandColors.h"
 #include "KeyBindings.h"
 #include "KeyCodes.h"
@@ -174,6 +175,7 @@ bool CGuiHandler::EnableLuaUI(bool enableCommand)
 		}
 	}
 
+	RmlGui::Reload();
 	CLuaUI::ReloadHandler();
 
 	if (luaUI != nullptr) {

rts/Game/UI/InputReceiver.cpp

@@ -4,6 +4,7 @@
 #include "InputReceiver.h"
 #include "Lua/LuaInputReceiver.h"
 #include "Rendering/GL/myGL.h"
+#include "Rml/Backends/RmlUi_Backend.h"
 #include "System/Rectangle.h"
 
 #include "System/Misc/TracyDefs.h"
@@ -75,7 +76,11 @@ void CInputReceiver::DrawReceivers()
 CInputReceiver* CInputReceiver::GetReceiverAt(int x, int y)
 {
 	RECOIL_DETAILED_TRACY_ZONE;
-	// always ask Lua first
+	// check RmlUI first
+	if (RmlGui::IsMouseInteractingWith())
+		return RmlGui::GetInputReceiver();
+
+	// check lua second
 	if (luaInputReceiver != nullptr && luaInputReceiver->IsAbove(x, y))
 		return luaInputReceiver;
 

rts/Game/UI/MouseHandler.cpp

@@ -39,6 +39,7 @@
 #include "System/StringUtil.h"
 #include "System/Input/KeyInput.h"
 #include "System/Input/MouseInput.h"
+#include "Rml/Backends/RmlUi_Backend.h"
 
 #include "System/Misc/TracyDefs.h"
 
@@ -281,6 +282,13 @@ void CMouseHandler::MouseMove(int x, int y, int dx, int dy)
 	if (game != nullptr && !game->IsGameOver())
 		playerHandler.Player(gu->myPlayerNum)->currentStats.mousePixels += movedPixels;
 
+	/* Only want to give a mouse event to RmlUI if the mouse isn't currently performing a drag.
+	 * Otherwise box selections get stuck when the mouse goes over an Rml element.
+	 * Flags that ButtonPressed() checks are not set when clicking on Rml element. */
+	if (!ButtonPressed() && RmlGui::ProcessMouseMove(x, lasty, dx, dy, activeButtonIdx)) {
+		return;
+	}
+
 	if (activeReceiver != nullptr)
 		activeReceiver->MouseMove(x, lasty, dx, dy, activeButtonIdx);
 
@@ -309,7 +317,12 @@ void CMouseHandler::MousePress(int x, int y, int button)
 	if (game != nullptr && !game->IsGameOver())
 		playerHandler.Player(gu->myPlayerNum)->currentStats.mouseClicks++;
 
-	ButtonPressEvt& bp = buttons[activeButtonIdx = button];
+	if (RmlGui::ProcessMousePress(x, y, button)) {
+		return;
+	}
+
+	activeButtonIdx = button;
+	ButtonPressEvt& bp = buttons[activeButtonIdx];
 	bp.chorded  = (buttons[SDL_BUTTON_LEFT].pressed || buttons[SDL_BUTTON_RIGHT].pressed);
 	bp.pressed  = true;
 	bp.time     = gu->gameTime;
@@ -319,6 +332,8 @@ void CMouseHandler::MousePress(int x, int y, int button)
 	bp.dir      = (dir = GetCursorCameraDir(x, y));
 	bp.movement = 0;
 
+	pressedBitMask |= 1 << button;
+
 	if (activeReceiver != nullptr && activeReceiver->MousePress(x, y, button))
 		return;
 
@@ -379,6 +394,10 @@ bool CMouseHandler::GetSelectionBoxVertices(float3& bl, float3& br, float3& tl,
 	if (activeReceiver != nullptr)
 		return false;
 
+	if (RmlGui::IsMouseInteractingWith()) {
+		return false;
+	}
+
 	if (gu->fpsMode)
 		return false;
 
@@ -477,12 +496,17 @@ void CMouseHandler::MouseRelease(int x, int y, int button)
 	dir = GetCursorCameraDir(x, y);
 
 	buttons[button].pressed = false;
+	pressedBitMask &= ~(1 << button);
 
 	if (inMapDrawer != nullptr && inMapDrawer->IsDrawMode()) {
 		inMapDrawer->MouseRelease(x, y, button);
 		return;
 	}
 
+	if (RmlGui::ProcessMouseRelease(x, y, button)) {
+		return;
+	}
+
 	if (activeReceiver != nullptr) {
 		activeReceiver->MouseRelease(x, y, button);
 
@@ -557,10 +581,18 @@ void CMouseHandler::MouseRelease(int x, int y, int button)
 	}
 }
 
+bool CMouseHandler::ButtonPressed()
+{
+	return pressedBitMask > 0;
+}
 
 void CMouseHandler::MouseWheel(float delta)
 {
 	RECOIL_DETAILED_TRACY_ZONE;
+	if (RmlGui::ProcessMouseWheel(delta)) {
+		return;
+	}
+
 	if (eventHandler.MouseWheel(delta > 0.0f, delta))
 		return;
 
@@ -691,6 +723,13 @@ std::string CMouseHandler::GetCurrentTooltip() const
 void CMouseHandler::Update()
 {
 	RECOIL_DETAILED_TRACY_ZONE;
+	// Rml is very polite about asking for changes to the cursor
+	// so let's make sure it's not ignored!
+	if (RmlGui::IsMouseInteractingWith())
+		// if the cursor string is empty, then Rml is cedeing control of it
+		if (auto& rmlCursor = RmlGui::GetMouseCursor(); !rmlCursor.empty())
+			queuedCursorName = rmlCursor;
+
 	SetCursor(queuedCursorName);
 
 	if (!hideCursor) {

rts/Game/UI/MouseHandler.h

@@ -87,6 +87,8 @@ class CMouseHandler
 
 	bool GetSelectionBoxVertices(float3& bl, float3& br, float3& tl, float3& tr) const;
 
+	bool ButtonPressed();
+
 private:
 	int2 GetViewMouseCenter() const;
 	void SetCursor(const std::string& cmdName, const bool forceRebind = false);
@@ -116,6 +118,7 @@ class CMouseHandler
 	bool wasLocked = false;
 	bool offscreen = false;
 	bool mmbScroll = false;
+	uint32_t pressedBitMask = 0;
 
 private:
 	bool hideCursor = true;

rts/Lua/LuaHandle.cpp

@@ -23,6 +23,7 @@
 #include "Game/UI/KeySet.h"
 #include "Game/UI/MiniMap.h"
 #include "Rendering/GlobalRendering.h"
+#include "Rml/Backends/RmlUi_Backend.h"
 #include "Sim/Misc/GlobalSynced.h"
 #include "Sim/Misc/TeamHandler.h"
 #include "Sim/Projectiles/Projectile.h"
@@ -174,6 +175,10 @@ void CLuaHandle::KillLua(bool inFreeHandler)
 	if (inFreeHandler)
 		Shutdown();
 
+	if(rmlui) {
+		RmlGui::RemoveLua();
+	}
+
 	// 3. delete the lua_State
 	//
 	// must be done here: if called from a ctor, we want the
@@ -3921,6 +3926,10 @@ int CLuaHandle::CallOutUpdateCallIn(lua_State* L)
 	return 0;
 }
 
+void CLuaHandle::InitializeRmlUi()
+{
+	rmlui = RmlGui::InitializeLua(L);
+}
 
 /******************************************************************************/
 /******************************************************************************/

rts/Lua/LuaHandle.h

@@ -318,7 +318,9 @@ class CLuaHandle : public CEventClient
 		void RunDrawCallIn(const LuaHashString& hs);
 
 		void DrawObjectsLua(std::initializer_list<bool> bools, const char* func);
+		void InitializeRmlUi();
 	protected:
+		bool rmlui = false;
 		bool userMode = false;
 		bool killMe = false; // set for handles that fail to RunCallIn
 

rts/Lua/LuaUI.cpp

@@ -163,6 +163,7 @@ CLuaUI::CLuaUI()
 		KillLua();
 		return;
 	}
+	InitializeRmlUi();
 
 	lua_settop(L, 0);
 	if (!LoadCode(L, std::move(code), file)) {