Add the ability to use Tracy plots directly from Lua via UnsyncedCtrl Spring.LuaTracyPlotConfig and Spring.LuaTracyPlot

rts/Lua/LuaIntro.cpp

@@ -212,6 +212,9 @@ bool CLuaIntro::LoadUnsyncedCtrlFunctions(lua_State* L)
 
 	REGISTER_SCOPED_LUA_CFUNC(LuaUnsyncedCtrl, SetLogSectionFilterLevel);
 
+	REGISTER_SCOPED_LUA_CFUNC(LuaUnsyncedCtrl, LuaTracyPlotConfig);
+	REGISTER_SCOPED_LUA_CFUNC(LuaUnsyncedCtrl, LuaTracyPlot);
+
 	return true;
 }
 

rts/Lua/LuaMenu.cpp

@@ -252,6 +252,10 @@ bool CLuaMenu::LoadUnsyncedCtrlFunctions(lua_State* L)
 	REGISTER_SCOPED_LUA_CFUNC(LuaUnsyncedCtrl, SDLSetTextInputRect);
 	REGISTER_SCOPED_LUA_CFUNC(LuaUnsyncedCtrl, SDLStartTextInput);
 	REGISTER_SCOPED_LUA_CFUNC(LuaUnsyncedCtrl, SDLStopTextInput);
+
+	REGISTER_SCOPED_LUA_CFUNC(LuaUnsyncedCtrl, LuaTracyPlotConfig);
+	REGISTER_SCOPED_LUA_CFUNC(LuaUnsyncedCtrl, LuaTracyPlot);
+
 	return true;
 }
 

rts/Lua/LuaUnsyncedCtrl.cpp

@@ -111,6 +111,8 @@
 #undef CreateDirectory
 #undef Yield
 
+#include <tracy/Tracy.hpp>
+#include <common/TracyQueue.hpp>
 
 /******************************************************************************
  * Callouts to set state
@@ -325,6 +327,9 @@ bool LuaUnsyncedCtrl::PushEntries(lua_State* L)
 
 	REGISTER_LUA_CFUNC(Yield);
 
+	REGISTER_LUA_CFUNC(LuaTracyPlotConfig);
+	REGISTER_LUA_CFUNC(LuaTracyPlot);
+
 	return true;
 }
 
@@ -4864,3 +4869,67 @@ int LuaUnsyncedCtrl::Yield(lua_State* L)
 	lua_pushboolean(L, true); //hint Lua should keep calling Yield
 	return 1;
 }
+
+/* Tracy seems to want unique, unchanging strings to be passed to
+ * its API, so we need to immanentize the ephemeral Lua strings
+ * and store them.
+ *
+ * NB: strings here are never cleaned up, but the use case assumes
+ * that they live a long time and there's just a handful of them. */
+std::set <std::string, std::less<>> tracyLuaPlots;
+
+/*** Configure custom appearence for a Tracy plot for use in debugging or profiling
+ *
+ * @function Spring.LuaTracyPlotConfig
+ * @string plotName which should be customized 
+ * @string[opt] plotFormatType "Number"|"Percentage"|"Memory", default "Number"
+ * @bool[opt] step stepwise chart, default true is stepwise
+ * @bool[opt] fill color fill, default false is no fill
+ * @number[opt] color unit32 number as BGR color, default white
+ * @treturn nil
+ */
+
+int LuaUnsyncedCtrl::LuaTracyPlotConfig(lua_State* L)
+{
+	const auto plotName             = luaL_checkstring(L, 1);
+	const auto plotFormatTypeString = luaL_optstring(L, 2, "");
+	const auto step                 = luaL_optboolean(L, 3, true); // stepwise default
+	const auto fill                 = luaL_optboolean(L, 4, false); // no fill default
+	const uint32_t color            = luaL_optint(L, 5, 0xFFFFFF); // white default
+
+	tracy::PlotFormatType plotFormatType;
+	switch (plotFormatTypeString[0]) {
+		case 'p': case 'P': plotFormatType = tracy::PlotFormatType::Percentage; break;
+		case 'm': case 'M': plotFormatType = tracy::PlotFormatType::Memory;     break;
+		default:            plotFormatType = tracy::PlotFormatType::Number;     break;
+	}
+
+	auto plot = tracyLuaPlots.find(plotName);
+	if (plot == tracyLuaPlots.end())
+		plot = tracyLuaPlots.emplace(plotName).first;
+
+	TracyPlotConfig(plot->c_str(), plotFormatType, step, fill, color);
+	return 0;
+}
+
+
+/*** Update a Tracy Plot with a value
+ *
+ * @function Spring.LuaTracyPlot
+ * @string plotName which LuaPlot should be updated
+ * @number plotvalue the number to show on the Tracy plot
+ * @treturn nil
+ */
+int LuaUnsyncedCtrl::LuaTracyPlot(lua_State* L)
+{
+	const auto plotName  = luaL_checkstring(L, 1);
+	const auto plotValue = luaL_checkfloat(L, 2);
+
+	auto plot = tracyLuaPlots.find(plotName);
+	if (plot == tracyLuaPlots.end())
+		plot = tracyLuaPlots.emplace(plotName).first;
+
+	TracyPlot(plot->c_str(), plotValue);
+	return 0;
+}
+

rts/Lua/LuaUnsyncedCtrl.h

@@ -203,6 +203,9 @@ class LuaUnsyncedCtrl {
 		static int SetWindowMaximized(lua_State* L);
 
 		static int Yield(lua_State* L);
+
+		static int LuaTracyPlotConfig(lua_State* L);
+		static int LuaTracyPlot(lua_State* L);
 };
 
 #endif /* LUA_UNSYNCED_CTRL_H */