]> git.lizzy.rs Git - dragonfireclient.git/blobdiff - src/script/common/c_internal.cpp
set_sky improvements, set_sun, set_moon and set_stars
[dragonfireclient.git] / src / script / common / c_internal.cpp
index f811dd5d31b545aaf73daed57d5be2ab5d0ec46a..a7dcf9b5f11cf28a737052770217078c1b126c99 100644 (file)
@@ -20,42 +20,16 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "common/c_internal.h"
 #include "debug.h"
 #include "log.h"
-#include "main.h"
+#include "porting.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_rawgeti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_BACKTRACE);
+       lua_call(L, 0, 1);
+       std::string result = luaL_checkstring(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;
+       return result;
 }
 
 int script_exception_wrapper(lua_State *L, lua_CFunction f)
@@ -64,19 +38,65 @@ int script_exception_wrapper(lua_State *L, lua_CFunction f)
                return f(L);  // Call wrapped function and return result.
        } catch (const char *s) {  // Catch and convert exceptions.
                lua_pushstring(L, s);
-       } catch (std::exceptione) {
+       } catch (std::exception &e) {
                lua_pushstring(L, e.what());
-       } catch (...) {
-               lua_pushliteral(L, "caught (...)");
        }
        return lua_error(L);  // Rethrow as a Lua error.
 }
 
-void script_error(lua_State *L)
+/*
+ * 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)
 {
-       const char *s = lua_tostring(L, -1);
-       std::string str(s ? s : "");
-       throw LuaError(str);
+       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 = "??";
+
+       const char *err_descr = lua_tostring(L, -1);
+       if (!err_descr)
+               err_descr = "<no description>";
+
+       char buf[256];
+       porting::mt_snprintf(buf, sizeof(buf), "%s error from mod '%s' in callback %s(): ",
+               err_type, mod, fxn);
+
+       std::string err_msg(buf);
+       err_msg += err_descr;
+
+       if (pcall_result == LUA_ERRMEM) {
+               err_msg += "\nCurrent Lua memory usage: "
+                       + itos(lua_gc(L, LUA_GCCOUNT, 0) >> 10) + " MB";
+       }
+
+       throw LuaError(err_msg);
 }
 
 // Push the list of callbacks (a lua table).
@@ -85,69 +105,73 @@ void script_error(lua_State *L)
 // - runs the callbacks
 // - replaces the table and arguments with the return value,
 //     computed depending on mode
-void script_run_callbacks(lua_State *L, int nargs, RunCallbacksMode mode)
+void script_run_callbacks_f(lua_State *L, int nargs,
+       RunCallbacksMode mode, const char *fxn)
 {
-       assert(lua_gettop(L) >= nargs + 1);
+       FATAL_ERROR_IF(lua_gettop(L) < nargs + 1, "Not enough arguments");
 
        // Insert error handler
-       lua_pushcfunction(L, script_error_handler);
-       int errorhandler = lua_gettop(L) - nargs - 1;
-       lua_insert(L, errorhandler);
+       PUSH_ERROR_HANDLER(L);
+       int error_handler = lua_gettop(L) - nargs - 1;
+       lua_insert(L, error_handler);
 
        // Insert run_callbacks between error handler and table
        lua_getglobal(L, "core");
        lua_getfield(L, -1, "run_callbacks");
        lua_remove(L, -2);
-       lua_insert(L, errorhandler + 1);
+       lua_insert(L, error_handler + 1);
 
        // Insert mode after table
        lua_pushnumber(L, (int) mode);
-       lua_insert(L, errorhandler + 3);
+       lua_insert(L, error_handler + 3);
 
        // Stack now looks like this:
        // ... <error handler> <run_callbacks> <table> <mode> <arg#1> <arg#2> ... <arg#n>
 
-       if (lua_pcall(L, nargs + 2, 1, errorhandler)) {
-               script_error(L);
+       int result = lua_pcall(L, nargs + 2, 1, error_handler);
+       if (result != 0)
+               script_error(L, result, NULL, fxn);
+
+       lua_remove(L, error_handler);
+}
+
+static void script_log(lua_State *L, const std::string &message,
+       std::ostream &log_to, bool do_error, int stack_depth)
+{
+       lua_Debug ar;
+
+       log_to << message << " ";
+       if (lua_getstack(L, stack_depth, &ar)) {
+               FATAL_ERROR_IF(!lua_getinfo(L, "Sl", &ar), "lua_getinfo() failed");
+               log_to << "(at " << ar.short_src << ":" << ar.currentline << ")";
+       } else {
+               log_to << "(at ?:?)";
        }
+       log_to << std::endl;
 
-       lua_remove(L, -2); // Remove error handler
+       if (do_error)
+               script_error(L, LUA_ERRRUN, NULL, NULL);
+       else
+               infostream << script_get_backtrace(L) << std::endl;
 }
 
-void log_deprecated(lua_State *L, std::string message)
+void log_deprecated(lua_State *L, const std::string &message, int stack_depth)
 {
        static bool configured = false;
-       static bool dolog      = false;
-       static bool doerror    = false;
+       static bool do_log     = false;
+       static bool do_error   = false;
 
-       // performance optimization to not have to read and compare setting for every logline
+       // Only read settings on first call
        if (!configured) {
                std::string value = g_settings->get("deprecated_lua_api_handling");
                if (value == "log") {
-                       dolog = true;
-               }
-               if (value == "error") {
-                       dolog = true;
-                       doerror = true;
+                       do_log = true;
+               } else if (value == "error") {
+                       do_log   = true;
+                       do_error = true;
                }
        }
 
-       if (doerror) {
-               if (L != NULL) {
-                       script_error(L);
-               } else {
-                       /* As of april 2014 assert is not optimized to nop in release builds
-                        * therefore this is correct. */
-                       assert("Can't do a scripterror for this deprecated message, so exit completely!");
-               }
-       }
-
-       if (dolog) {
-               /* abusing actionstream because of lack of file-only-logged loglevel */
-               actionstream << message << std::endl;
-               if (L != NULL) {
-                       actionstream << script_get_backtrace(L) << std::endl;
-               }
-       }
+       if (do_log)
+               script_log(L, message, warningstream, do_error, stack_depth);
 }
-