// Copyright (c) 2008-2022 the Urho3D project // License: MIT #include "../Precompiled.h" #include "../Core/CoreEvents.h" #include "../Core/ProcessUtils.h" #include "../Core/Profiler.h" #include "../Engine/EngineEvents.h" #include "../IO/File.h" #include "../IO/FileSystem.h" #include "../IO/Log.h" #include "../LuaScript/LuaFile.h" #include "../LuaScript/LuaFunction.h" #include "../LuaScript/LuaScript.h" #include "../LuaScript/LuaScriptEventInvoker.h" #include "../LuaScript/LuaScriptInstance.h" #include "../Resource/ResourceCache.h" #include "../Scene/Scene.h" extern "C" { #include } #include #include "../LuaScript/ToluaUtils.h" #include "../DebugNew.h" extern int tolua_AudioLuaAPI_open(lua_State*); extern int tolua_CoreLuaAPI_open(lua_State*); extern int tolua_EngineLuaAPI_open(lua_State*); extern int tolua_GraphicsLuaAPI_open(lua_State*); extern int tolua_InputLuaAPI_open(lua_State*); extern int tolua_IOLuaAPI_open(lua_State*); extern int tolua_MathLuaAPI_open(lua_State*); #ifdef URHO3D_NAVIGATION extern int tolua_NavigationLuaAPI_open(lua_State*); #endif #ifdef URHO3D_NETWORK extern int tolua_NetworkLuaAPI_open(lua_State*); #endif #ifdef URHO3D_DATABASE extern int tolua_DatabaseLuaAPI_open(lua_State*); #endif #ifdef URHO3D_IK extern int tolua_IKLuaAPI_open(lua_State*); #endif #ifdef URHO3D_PHYSICS extern int tolua_PhysicsLuaAPI_open(lua_State*); #endif #ifdef URHO3D_PHYSICS2D extern int tolua_Physics2DLuaAPI_open(lua_State*); #endif extern int tolua_ResourceLuaAPI_open(lua_State*); extern int tolua_SceneLuaAPI_open(lua_State*); extern int tolua_UILuaAPI_open(lua_State*); #ifdef URHO3D_URHO2D extern int tolua_Urho2DLuaAPI_open(lua_State*); #endif extern int tolua_LuaScriptLuaAPI_open(lua_State*); namespace Urho3D { LuaScript::LuaScript(Context* context) : Object(context), luaState_(nullptr), executeConsoleCommands_(false) { RegisterLuaScriptLibrary(context_); luaState_ = luaL_newstate(); if (!luaState_) { URHO3D_LOGERROR("Could not create Lua state"); return; } lua_atpanic(luaState_, &LuaScript::AtPanic); luaL_openlibs(luaState_); RegisterLoader(); ReplacePrint(); tolua_MathLuaAPI_open(luaState_); tolua_CoreLuaAPI_open(luaState_); tolua_IOLuaAPI_open(luaState_); tolua_ResourceLuaAPI_open(luaState_); tolua_SceneLuaAPI_open(luaState_); tolua_AudioLuaAPI_open(luaState_); tolua_EngineLuaAPI_open(luaState_); tolua_GraphicsLuaAPI_open(luaState_); tolua_InputLuaAPI_open(luaState_); #ifdef URHO3D_NAVIGATION tolua_NavigationLuaAPI_open(luaState_); #endif #ifdef URHO3D_NETWORK tolua_NetworkLuaAPI_open(luaState_); #endif #ifdef URHO3D_DATABASE tolua_DatabaseLuaAPI_open(luaState_); #endif #ifdef URHO3D_IK tolua_IKLuaAPI_open(luaState_); #endif #ifdef URHO3D_PHYSICS tolua_PhysicsLuaAPI_open(luaState_); #endif #ifdef URHO3D_PHYSICS2D tolua_Physics2DLuaAPI_open(luaState_); #endif tolua_UILuaAPI_open(luaState_); #ifdef URHO3D_URHO2D tolua_Urho2DLuaAPI_open(luaState_); #endif tolua_LuaScriptLuaAPI_open(luaState_); SetContext(luaState_, context_); eventInvoker_ = new LuaScriptEventInvoker(context_); coroutineUpdate_ = GetFunction("coroutine.update"); // Subscribe to post update SubscribeToEvent(E_POSTUPDATE, URHO3D_HANDLER(LuaScript, HandlePostUpdate)); // Subscribe to console commands SetExecuteConsoleCommands(true); } LuaScript::~LuaScript() { functionPointerToFunctionMap_.Clear(); functionNameToFunctionMap_.Clear(); lua_State* luaState = luaState_; luaState_ = nullptr; coroutineUpdate_ = nullptr; if (luaState) lua_close(luaState); } void LuaScript::AddEventHandler(const String& eventName, int index) { LuaFunction* function = GetFunction(index); if (function) eventInvoker_->AddEventHandler(nullptr, eventName, function); } void LuaScript::AddEventHandler(const String& eventName, const String& functionName) { LuaFunction* function = GetFunction(functionName); if (function) eventInvoker_->AddEventHandler(nullptr, eventName, function); } void LuaScript::AddEventHandler(Object* sender, const String& eventName, int index) { if (!sender) return; LuaFunction* function = GetFunction(index); if (function) eventInvoker_->AddEventHandler(sender, eventName, function); } void LuaScript::AddEventHandler(Object* sender, const String& eventName, const String& functionName) { if (!sender) return; LuaFunction* function = GetFunction(functionName); if (function) eventInvoker_->AddEventHandler(sender, eventName, function); } void LuaScript::RemoveEventHandler(const String& eventName) { eventInvoker_->UnsubscribeFromEvent(eventName); } void LuaScript::RemoveEventHandler(Object* sender, const String& eventName) { if (!sender) return; eventInvoker_->UnsubscribeFromEvent(sender, eventName); } void LuaScript::RemoveEventHandlers(Object* sender) { if (!sender) return; eventInvoker_->UnsubscribeFromEvents(sender); } void LuaScript::RemoveAllEventHandlers() { eventInvoker_->UnsubscribeFromAllEvents(); } void LuaScript::RemoveEventHandlersExcept(const Vector& exceptionNames) { PODVector exceptionTypes(exceptionNames.Size()); for (unsigned i = 0; i < exceptionTypes.Size(); ++i) exceptionTypes[i] = StringHash(exceptionNames[i]); eventInvoker_->UnsubscribeFromAllEventsExcept(exceptionTypes, true); } bool LuaScript::HasEventHandler(const String& eventName) const { return eventInvoker_->HasSubscribedToEvent(eventName); } bool LuaScript::HasEventHandler(Object* sender, const String& eventName) const { return eventInvoker_->HasSubscribedToEvent(sender, eventName); } bool LuaScript::ExecuteFile(const String& fileName) { URHO3D_PROFILE(ExecuteFile); #ifdef URHO3D_LUA_RAW_SCRIPT_LOADER if (ExecuteRawFile(fileName)) return true; #endif auto* cache = GetSubsystem(); auto* luaFile = cache->GetResource(fileName); return luaFile && luaFile->LoadAndExecute(luaState_); } bool LuaScript::ExecuteString(const String& string) { URHO3D_PROFILE(ExecuteString); if (luaL_dostring(luaState_, string.CString())) { const char* message = lua_tostring(luaState_, -1); URHO3D_LOGERRORF("Execute Lua string failed: %s", message); lua_pop(luaState_, 1); return false; } return true; } bool LuaScript::LoadRawFile(const String& fileName) { URHO3D_PROFILE(LoadRawFile); URHO3D_LOGINFO("Finding Lua file on file system: " + fileName); auto* cache = GetSubsystem(); String filePath = cache->GetResourceFileName(fileName); if (filePath.Empty()) { URHO3D_LOGINFO("Lua file not found: " + fileName); return false; } filePath = GetNativePath(filePath); URHO3D_LOGINFO("Loading Lua file from file system: " + filePath); if (luaL_loadfile(luaState_, filePath.CString())) { const char* message = lua_tostring(luaState_, -1); URHO3D_LOGERRORF("Load Lua file failed: %s", message); lua_pop(luaState_, 1); return false; } URHO3D_LOGINFO("Lua file loaded: " + filePath); return true; } bool LuaScript::ExecuteRawFile(const String& fileName) { URHO3D_PROFILE(ExecuteRawFile); if (!LoadRawFile(fileName)) return false; if (lua_pcall(luaState_, 0, 0, 0)) { const char* message = lua_tostring(luaState_, -1); URHO3D_LOGERRORF("Execute Lua file failed: %s", message); lua_pop(luaState_, 1); return false; } return true; } bool LuaScript::ExecuteFunction(const String& functionName) { LuaFunction* function = GetFunction(functionName); return function && function->BeginCall() && function->EndCall(); } void LuaScript::SetExecuteConsoleCommands(bool enable) { if (enable == executeConsoleCommands_) return; executeConsoleCommands_ = enable; if (enable) SubscribeToEvent(E_CONSOLECOMMAND, URHO3D_HANDLER(LuaScript, HandleConsoleCommand)); else UnsubscribeFromEvent(E_CONSOLECOMMAND); } void LuaScript::RegisterLoader() { // Get package.loaders table lua_getglobal(luaState_, "package"); lua_getfield(luaState_, -1, "loaders"); // Add LuaScript::Loader to the end of the table lua_pushinteger(luaState_, lua_objlen(luaState_, -1) + 1); lua_pushcfunction(luaState_, &LuaScript::Loader); lua_settable(luaState_, -3); lua_pop(luaState_, 2); } int LuaScript::AtPanic(lua_State* L) { String errorMessage = luaL_checkstring(L, -1); URHO3D_LOGERROR("Lua error: Error message = '" + errorMessage + "'"); lua_pop(L, 1); return 0; } int LuaScript::Loader(lua_State* L) { // Get module name String fileName(luaL_checkstring(L, 1)); #ifdef URHO3D_LUA_RAW_SCRIPT_LOADER // First attempt to load lua script file from the file system // Attempt to load .luc file first, then fall back to .lua auto* lua = ::GetContext(L)->GetSubsystem(); if (lua->LoadRawFile(fileName + ".luc") || lua->LoadRawFile(fileName + ".lua")) return 1; #endif auto* cache = ::GetContext(L)->GetSubsystem(); // Attempt to get .luc file first auto* lucFile = cache->GetResource(fileName + ".luc", false); if (lucFile) return lucFile->LoadChunk(L) ? 1 : 0; // Then try to get .lua file. If this also fails, error is logged and // resource not found event is sent auto* luaFile = cache->GetResource(fileName + ".lua"); if (luaFile) return luaFile->LoadChunk(L) ? 1 : 0; return 0; } void LuaScript::ReplacePrint() { static const struct luaL_reg reg[] = { {"print", &LuaScript::Print}, {nullptr, nullptr} }; lua_getglobal(luaState_, "_G"); luaL_register(luaState_, nullptr, reg); lua_pop(luaState_, 1); } int LuaScript::Print(lua_State* L) { int n = lua_gettop(L); Vector strings((unsigned)n); // Call the tostring function repeatedly for each arguments in the stack lua_getglobal(L, "tostring"); for (int i = 1; i <= n; ++i) { lua_pushvalue(L, -1); lua_pushvalue(L, i); lua_call(L, 1, 1); const char* s = lua_tostring(L, -1); lua_pop(L, 1); if (s) strings[i - 1] = s; else { lua_pop(L, 1); return luaL_error(L, LUA_QL("tostring") " failed at index %d to return a string to " LUA_QL("print"), i); } } lua_pop(L, 1); URHO3D_LOGRAWF("%s\n", String::Joined(strings, " ").CString()); return 0; } LuaFunction* LuaScript::GetFunction(int index) { if (!lua_isfunction(luaState_, index)) return nullptr; const void* functionPointer = lua_topointer(luaState_, index); if (!functionPointer) return nullptr; HashMap>::Iterator i = functionPointerToFunctionMap_.Find(functionPointer); if (i != functionPointerToFunctionMap_.End()) return i->second_; SharedPtr function(new LuaFunction(luaState_, index)); functionPointerToFunctionMap_[functionPointer] = function; return function; } LuaFunction* LuaScript::GetFunction(const String& functionName, bool silentIfNotFound) { if (!luaState_) return nullptr; HashMap>::Iterator i = functionNameToFunctionMap_.Find(functionName); if (i != functionNameToFunctionMap_.End()) return i->second_; SharedPtr function; if (PushLuaFunction(luaState_, functionName)) { function = GetFunction(-1); functionNameToFunctionMap_[functionName] = function; } else if (!silentIfNotFound) URHO3D_LOGERRORF("%s", lua_tostring(luaState_, -1)); lua_pop(luaState_, 1); return function; } void LuaScript::HandlePostUpdate(StringHash eventType, VariantMap& eventData) { if (coroutineUpdate_ && coroutineUpdate_->BeginCall()) { using namespace PostUpdate; float timeStep = eventData[P_TIMESTEP].GetFloat(); coroutineUpdate_->PushFloat(timeStep); coroutineUpdate_->EndCall(); } // Collect garbage { URHO3D_PROFILE(LuaCollectGarbage); lua_gc(luaState_, LUA_GCSTEP, 0); } } void LuaScript::HandleConsoleCommand(StringHash eventType, VariantMap& eventData) { using namespace ConsoleCommand; if (eventData[P_ID].GetString() == GetTypeName()) ExecuteString(eventData[P_COMMAND].GetString()); } bool LuaScript::PushLuaFunction(lua_State* L, const String& functionName) { Vector splitNames = functionName.Split('.'); String currentName = splitNames.Front(); lua_getglobal(L, currentName.CString()); if (splitNames.Size() > 1) { for (unsigned i = 0; i < splitNames.Size() - 1; ++i) { if (i) { currentName = currentName + "." + splitNames[i]; lua_getfield(L, -1, splitNames[i].CString()); lua_replace(L, -2); } if (!lua_istable(L, -1)) { lua_pop(L, 1); lua_pushstring(L, ("Could not find Lua table: Table name = '" + currentName + "'").CString()); return false; } } currentName = currentName + "." + splitNames.Back(); lua_getfield(L, -1, splitNames.Back().CString()); lua_replace(L, -2); } if (!lua_isfunction(L, -1)) { lua_pop(L, 1); lua_pushstring(L, ("Could not find Lua function: Function name = '" + currentName + "'").CString()); return false; } return true; } void RegisterLuaScriptLibrary(Context* context) { LuaFile::RegisterObject(context); LuaScriptInstance::RegisterObject(context); } }