minetest/src/script/common/c_internal.cpp

193 lines
4.9 KiB
C++
Raw Normal View History

/*
Minetest
Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#include "common/c_internal.h"
#include "debug.h"
2014-04-29 17:47:34 +02:00
#include "log.h"
#include "settings.h"
std::string script_get_backtrace(lua_State *L)
{
std::string s;
lua_getglobal(L, "debug");
if(lua_istable(L, -1)){
lua_getfield(L, -1, "traceback");
if(lua_isfunction(L, -1)) {
lua_call(L, 0, 1);
if(lua_isstring(L, -1)){
s = lua_tostring(L, -1);
}
}
lua_pop(L, 1);
}
lua_pop(L, 1);
return s;
}
int script_error_handler(lua_State *L) {
lua_getglobal(L, "debug");
if (!lua_istable(L, -1)) {
lua_pop(L, 1);
return 1;
}
lua_getfield(L, -1, "traceback");
if (!lua_isfunction(L, -1)) {
lua_pop(L, 2);
return 1;
}
lua_pushvalue(L, 1);
lua_pushinteger(L, 2);
lua_call(L, 2, 1);
return 1;
}
int script_exception_wrapper(lua_State *L, lua_CFunction f)
{
try {
return f(L); // Call wrapped function and return result.
} catch (const char *s) { // Catch and convert exceptions.
lua_pushstring(L, s);
} catch (std::exception &e) {
lua_pushstring(L, e.what());
}
return lua_error(L); // Rethrow as a Lua error.
}
2015-08-05 06:49:35 +02:00
/*
* Note that we can't get tracebacks for LUA_ERRMEM or LUA_ERRERR (without
* hacking Lua internals). For LUA_ERRMEM, this is because memory errors will
* not execute the the error handler, and by the time lua_pcall returns the
* execution stack will have already been unwound. For LUA_ERRERR, there was
* another error while trying to generate a backtrace from a LUA_ERRRUN. It is
* presumed there is an error with the internal Lua state and thus not possible
* to gather a coherent backtrace. Realistically, the best we can do here is
* print which C function performed the failing pcall.
*/
void script_error(lua_State *L, int pcall_result, const char *mod, const char *fxn)
{
2015-08-05 06:49:35 +02:00
if (pcall_result == 0)
return;
const char *err_type;
switch (pcall_result) {
case LUA_ERRRUN:
err_type = "Runtime";
break;
case LUA_ERRMEM:
err_type = "OOM";
break;
case LUA_ERRERR:
err_type = "Double fault";
break;
default:
err_type = "Unknown";
}
if (!mod)
mod = "??";
if (!fxn)
fxn = "??";
2015-08-05 06:49:35 +02:00
const char *err_descr = lua_tostring(L, -1);
if (!err_descr)
err_descr = "<no description>";
char buf[256];
snprintf(buf, sizeof(buf), "%s error from mod '%s' in callback %s(): ",
err_type, mod, fxn);
std::string err_msg(buf);
2015-08-05 06:49:35 +02:00
err_msg += err_descr;
if (pcall_result == LUA_ERRMEM) {
err_msg += "\nCurrent Lua memory usage: "
+ itos(lua_gc(L, LUA_GCCOUNT, 0) >> 10) + " MB";
}
2015-08-05 06:49:35 +02:00
throw LuaError(err_msg);
}
// Push the list of callbacks (a lua table).
// Then push nargs arguments.
// Then call this function, which
// - runs the callbacks
2013-12-08 04:03:07 +01:00
// - replaces the table and arguments with the return value,
// computed depending on mode
2015-08-05 06:49:35 +02:00
void script_run_callbacks_f(lua_State *L, int nargs,
RunCallbacksMode mode, const char *fxn)
{
FATAL_ERROR_IF(lua_gettop(L) < nargs + 1, "Not enough arguments");
2013-12-08 04:03:07 +01:00
// Insert error handler
PUSH_ERROR_HANDLER(L);
int error_handler = lua_gettop(L) - nargs - 1;
lua_insert(L, error_handler);
2014-04-28 03:02:48 +02:00
// Insert run_callbacks between error handler and table
lua_getglobal(L, "core");
2013-12-08 04:03:07 +01:00
lua_getfield(L, -1, "run_callbacks");
lua_remove(L, -2);
lua_insert(L, error_handler + 1);
2013-12-08 04:03:07 +01:00
// Insert mode after table
lua_pushnumber(L, (int) mode);
lua_insert(L, error_handler + 3);
2013-12-08 04:03:07 +01:00
// Stack now looks like this:
// ... <error handler> <run_callbacks> <table> <mode> <arg#1> <arg#2> ... <arg#n>
int result = lua_pcall(L, nargs + 2, 1, error_handler);
if (result != 0)
script_error(L, result, NULL, fxn);
2013-12-08 04:03:07 +01:00
lua_remove(L, error_handler);
}
2015-08-05 06:49:35 +02:00
void log_deprecated(lua_State *L, const std::string &message)
2014-04-29 17:47:34 +02:00
{
static bool configured = false;
static bool do_log = false;
static bool do_error = false;
2014-04-29 17:47:34 +02:00
// Only read settings on first call
2014-04-29 17:47:34 +02:00
if (!configured) {
std::string value = g_settings->get("deprecated_lua_api_handling");
if (value == "log") {
do_log = true;
} else if (value == "error") {
do_log = true;
do_error = true;
2014-04-29 17:47:34 +02:00
}
}
if (do_log) {
warningstream << message << std::endl;
// L can be NULL if we get called by log_deprecated(const std::string &msg)
// from scripting_game.cpp.
if (L) {
if (do_error)
script_error(L, LUA_ERRRUN, NULL, NULL);
else
infostream << script_get_backtrace(L) << std::endl;
}
2014-04-29 17:47:34 +02:00
}
}