Add Lua support

3rdParty/Lua/CMakeLists.txt

@@ -0,0 +1,19 @@
+include(functions/FetchContent_MakeAvailableExcludeFromAll)
+
+set(LUA_ENABLE_TESTING OFF)
+set(LUA_BUILD_COMPILER OFF)
+
+include(FetchContent)
+FetchContent_Declare(Lua
+    URL https://github.com/walterschell/Lua/archive/88246d621abf7b6fba9332f49229d507f020e450.tar.gz
+    URL_HASH MD5=03b76927cb5341ffc53bea12c37ddcca
+)
+FetchContent_MakeAvailableExcludeFromAll(Lua)
+
+if(ANDROID AND ("${ANDROID_ABI}" STREQUAL "armeabi-v7a" OR "${ANDROID_ABI}" STREQUAL "x86"))
+  target_compile_definitions(lua_internal INTERFACE -DLUA_USE_C89)
+elseif(NINTENDO_3DS OR VITA OR NINTENDO_SWITCH OR NXDK)
+  target_compile_definitions(lua_static PUBLIC -DLUA_USE_C89)
+elseif(IOS)
+  target_compile_definitions(lua_static PUBLIC -DLUA_USE_IOS)
+endif()

CMake/Dependencies.cmake

@@ -24,6 +24,8 @@ if(SUPPORTS_MPQ)
   endif()
 endif()
 
+add_subdirectory(3rdParty/Lua)
+
 if(SCREEN_READER_INTEGRATION)
   if(WIN32)
     add_subdirectory(3rdParty/tolk)

Source/CMakeLists.txt

@@ -159,6 +159,7 @@ set(libdevilutionx_SRCS
   utils/format_int.cpp
   utils/language.cpp
   utils/logged_fstream.cpp
+  utils/lua.cpp
   utils/paths.cpp
   utils/parse_int.cpp
   utils/pcx_to_clx.cpp
@@ -287,6 +288,8 @@ if(DISCORD_INTEGRATION)
   target_link_libraries(libdevilutionx PRIVATE discord discord_game_sdk)
 endif()
 
+target_link_libraries(libdevilutionx PRIVATE lua_static)
+
 if(SCREEN_READER_INTEGRATION AND WIN32)
   target_compile_definitions(libdevilutionx PRIVATE Tolk)
 endif()

Source/diablo.cpp

@@ -81,6 +81,7 @@
 #include "utils/console.h"
 #include "utils/display.h"
 #include "utils/language.h"
+#include "utils/lua.hpp"
 #include "utils/parse_int.hpp"
 #include "utils/paths.h"
 #include "utils/screen_reader.hpp"
@@ -822,6 +823,7 @@ void RunGameLoop(interface_mode uMsg)
 	nthread_ignore_mutex(false);
 
 	discord_manager::StartGame();
+	LuaEvent("GameStartedEvent");
 #ifdef GPERF_HEAP_FIRST_GAME_ITERATION
 	unsigned run_game_iteration = 0;
 #endif
@@ -1230,6 +1232,7 @@ void DiabloDeinit()
 {
 	FreeItemGFX();
 
+	LuaShutdown();
 	ShutDownScreenReader();
 
 	if (gbSndInited)
@@ -2449,6 +2452,7 @@ int DiabloMain(int argc, char **argv)
 	LoadLanguageArchive();
 
 	ApplicationInit();
+	LuaInitialize();
 	SaveOptions();
 
 	// Finally load game data

Source/utils/lua.cpp

@@ -0,0 +1,88 @@
+#include "utils/lua.hpp"
+
+#include <string_view>
+
+extern "C" {
+#include <lauxlib.h>
+#include <lua.h>
+#include <lualib.h>
+}
+
+#include "engine/assets.hpp"
+#include "plrmsg.h"
+#include "utils/console.h"
+
+namespace devilution {
+
+namespace {
+
+lua_State *LuaState;
+
+int LuaPrint(lua_State *state)
+{
+	if (lua_isstring(LuaState, 1)) {
+		std::string msg = lua_tostring(state, 1);
+		msg += "\n";
+		printInConsole(msg);
+	}
+
+	return 0;
+}
+
+int LuaPlayerMessage(lua_State *state)
+{
+	if (lua_isstring(LuaState, 1)) {
+		std::string_view msg = lua_tostring(state, 1);
+		EventPlrMsg(msg, UiFlags::ColorRed);
+	}
+
+	return 0;
+}
+
+} // namespace
+
+void LuaInitialize()
+{
+	LuaState = luaL_newstate();
+	lua_register(LuaState, "print", LuaPrint);
+	lua_register(LuaState, "PlayerMessage", LuaPlayerMessage);
+	lua_pushstring(LuaState, LUA_VERSION);
+	lua_setglobal(LuaState, "_VERSION");
+
+	AssetRef ref = FindAsset("init.lua");
+	if (!ref.ok())
+		return;
+	const size_t size = ref.size();
+	std::unique_ptr<char[]> luaScript { new char[size + 1] };
+
+	AssetHandle handle = OpenAsset(std::move(ref));
+	if (!handle.ok())
+		return;
+	if (size > 0 && !handle.read(luaScript.get(), size))
+		return;
+	luaScript[size] = '\0'; // Terminate string
+
+	int status = luaL_dostring(LuaState, luaScript.get());
+	if (status != LUA_OK)
+		SDL_Log("%s", lua_tostring(LuaState, -1));
+}
+
+void LuaShutdown()
+{
+	if (LuaState == nullptr)
+		return;
+
+	lua_close(LuaState);
+}
+
+void LuaEvent(std::string name)
+{
+	lua_getglobal(LuaState, name.c_str());
+	if (!lua_isfunction(LuaState, -1))
+		return;
+	int status = lua_pcall(LuaState, 0, 0, 0);
+	if (status != LUA_OK)
+		SDL_Log("%s", lua_tostring(LuaState, -1));
+}
+
+} // namespace devilution

Source/utils/lua.hpp

@@ -0,0 +1,11 @@
+#pragma once
+
+#include <string>
+
+namespace devilution {
+
+void LuaInitialize();
+void LuaShutdown();
+void LuaEvent(std::string name);
+
+} // namespace devilution

test/timedemo_test.cpp

@@ -8,6 +8,7 @@
 #include "pfile.h"
 #include "playerdat.hpp"
 #include "utils/display.h"
+#include "utils/lua.hpp"
 #include "utils/paths.h"
 
 using namespace devilution;
@@ -33,6 +34,7 @@ void RunTimedemo(std::string timedemoFolderName)
 
 	InitKeymapActions();
 	LoadOptions();
+	LuaInitialize();
 
 	const int demoNumber = 0;