3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #include "lua_api/l_base.h"
21 #include "lua_api/l_internal.h"
22 #include "cpp_api/s_base.h"
23 #include "content/mods.h"
29 ScriptApiBase *ModApiBase::getScriptApiBase(lua_State *L)
31 // Get server from registry
32 lua_rawgeti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_SCRIPTAPI);
33 ScriptApiBase *sapi_ptr = (ScriptApiBase*) lua_touserdata(L, -1);
38 Server *ModApiBase::getServer(lua_State *L)
40 return getScriptApiBase(L)->getServer();
44 Client *ModApiBase::getClient(lua_State *L)
46 return getScriptApiBase(L)->getClient();
49 Game *ModApiBase::getGame(lua_State *L)
51 return getScriptApiBase(L)->getGame();
55 IGameDef *ModApiBase::getGameDef(lua_State *L)
57 return getScriptApiBase(L)->getGameDef();
60 Environment *ModApiBase::getEnv(lua_State *L)
62 return getScriptApiBase(L)->getEnv();
65 GUIEngine *ModApiBase::getGuiEngine(lua_State *L)
67 return getScriptApiBase(L)->getGuiEngine();
70 std::string ModApiBase::getCurrentModPath(lua_State *L)
72 lua_rawgeti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_CURRENT_MOD_NAME);
73 std::string current_mod_name = readParam<std::string>(L, -1, "");
74 if (current_mod_name.empty())
77 const ModSpec *mod = getServer(L)->getModSpec(current_mod_name);
85 bool ModApiBase::registerFunction(lua_State *L, const char *name,
86 lua_CFunction func, int top)
88 // TODO: Check presence first!
90 lua_pushcfunction(L, func);
91 lua_setfield(L, top, name);
96 std::unordered_map<std::string, luaL_Reg> ModApiBase::m_deprecated_wrappers;
97 bool ModApiBase::m_error_deprecated_calls = false;
99 int ModApiBase::l_deprecated_function(lua_State *L)
101 thread_local std::vector<u64> deprecated_logged;
103 u64 start_time = porting::getTimeUs();
106 // Get function name for lookup
107 FATAL_ERROR_IF(!lua_getstack(L, 0, &ar), "lua_getstack() failed");
108 FATAL_ERROR_IF(!lua_getinfo(L, "n", &ar), "lua_getinfo() failed");
110 // Combine name with line and script backtrace
111 FATAL_ERROR_IF(!lua_getstack(L, 1, &ar), "lua_getstack() failed");
112 FATAL_ERROR_IF(!lua_getinfo(L, "Sl", &ar), "lua_getinfo() failed");
114 // Get parent class to get the wrappers map
115 luaL_checktype(L, 1, LUA_TUSERDATA);
116 void *ud = lua_touserdata(L, 1);
117 ModApiBase *o = *(ModApiBase**)ud;
119 // New function and new function name
120 auto it = o->m_deprecated_wrappers.find(ar.name);
122 // Get backtrace and hash it to reduce the warning flood
123 std::string backtrace = ar.short_src;
124 backtrace.append(":").append(std::to_string(ar.currentline));
125 u64 hash = murmur_hash_64_ua(backtrace.data(), backtrace.length(), 0xBADBABE);
127 if (std::find(deprecated_logged.begin(), deprecated_logged.end(), hash)
128 == deprecated_logged.end()) {
130 deprecated_logged.emplace_back(hash);
131 warningstream << "Call to deprecated function '" << ar.name << "', please use '"
132 << it->second.name << "' at " << backtrace << std::endl;
134 if (m_error_deprecated_calls)
135 script_error(L, LUA_ERRRUN, NULL, NULL);
138 u64 end_time = porting::getTimeUs();
139 g_profiler->avg("l_deprecated_function", end_time - start_time);
141 return it->second.func(L);
144 void ModApiBase::markAliasDeprecated(luaL_Reg *reg)
146 std::string value = g_settings->get("deprecated_lua_api_handling");
147 m_error_deprecated_calls = value == "error";
149 if (!m_error_deprecated_calls && value != "log")
152 const char *last_name = nullptr;
153 lua_CFunction last_func = nullptr;
155 // ! Null termination !
157 if (last_func == reg->func) {
159 luaL_Reg original_reg;
160 // Do not inline struct. Breaks MSVC or is error-prone
161 original_reg.name = last_name;
162 original_reg.func = reg->func;
163 m_deprecated_wrappers.emplace(
164 std::pair<std::string, luaL_Reg>(reg->name, original_reg));
165 reg->func = l_deprecated_function;
168 last_func = reg->func;
169 last_name = reg->name;