src/script/common/c_internal.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   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.
   9
  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.
  14
  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.
  18 */
  19
  20 /******************************************************************************/
  21 /******************************************************************************/
  22 /* WARNING!!!! do NOT add this header in any include file or any code file    */
  23 /*             not being a modapi file!!!!!!!!                                */
  24 /******************************************************************************/
  25 /******************************************************************************/
  26
  27 #pragma once
  28
  29 extern "C" {
  30 #include <lua.h>
  31 #include <lauxlib.h>
  32 }
  33
  34 #include "common/c_types.h"
  35
  36
  37 /*
  38         Define our custom indices into the Lua registry table.
  39
  40         Lua 5.2 and above define the LUA_RIDX_LAST macro. Only numbers above that
  41         may be used for custom indices, anything else is reserved.
  42
  43         Lua 5.1 / LuaJIT do not use any numeric indices (only string indices),
  44         so we can use numeric indices freely.
  45 */
  46 #ifdef LUA_RIDX_LAST
  47 #define CUSTOM_RIDX_BASE ((LUA_RIDX_LAST)+1)
  48 #else
  49 #define CUSTOM_RIDX_BASE 1
  50 #endif
  51
  52 #define CUSTOM_RIDX_SCRIPTAPI           (CUSTOM_RIDX_BASE)
  53 #define CUSTOM_RIDX_GLOBALS_BACKUP      (CUSTOM_RIDX_BASE + 1)
  54 #define CUSTOM_RIDX_CURRENT_MOD_NAME    (CUSTOM_RIDX_BASE + 2)
  55 #define CUSTOM_RIDX_BACKTRACE           (CUSTOM_RIDX_BASE + 3)
  56
  57 // Pushes the error handler onto the stack and returns its index
  58 #define PUSH_ERROR_HANDLER(L) \
  59         (lua_rawgeti((L), LUA_REGISTRYINDEX, CUSTOM_RIDX_BACKTRACE), lua_gettop((L)))
  60
  61 #define PCALL_RESL(L, RES) {                            \
  62         int result_ = (RES);                                \
  63         if (result_ != 0) {                                 \
  64                 script_error((L), result_, NULL, __FUNCTION__); \
  65         }                                                   \
  66 }
  67
  68 #define script_run_callbacks(L, nargs, mode) \
  69         script_run_callbacks_f((L), (nargs), (mode), __FUNCTION__)
  70
  71 // What script_run_callbacks does with the return values of callbacks.
  72 // Regardless of the mode, if only one callback is defined,
  73 // its return value is the total return value.
  74 // Modes only affect the case where 0 or >= 2 callbacks are defined.
  75 enum RunCallbacksMode
  76 {
  77         // Returns the return value of the first callback
  78         // Returns nil if list of callbacks is empty
  79         RUN_CALLBACKS_MODE_FIRST,
  80         // Returns the return value of the last callback
  81         // Returns nil if list of callbacks is empty
  82         RUN_CALLBACKS_MODE_LAST,
  83         // If any callback returns a false value, the first such is returned
  84         // Otherwise, the first callback's return value (trueish) is returned
  85         // Returns true if list of callbacks is empty
  86         RUN_CALLBACKS_MODE_AND,
  87         // Like above, but stops calling callbacks (short circuit)
  88         // after seeing the first false value
  89         RUN_CALLBACKS_MODE_AND_SC,
  90         // If any callback returns a true value, the first such is returned
  91         // Otherwise, the first callback's return value (falseish) is returned
  92         // Returns false if list of callbacks is empty
  93         RUN_CALLBACKS_MODE_OR,
  94         // Like above, but stops calling callbacks (short circuit)
  95         // after seeing the first true value
  96         RUN_CALLBACKS_MODE_OR_SC,
  97         // Note: "a true value" and "a false value" refer to values that
  98         // are converted by readParam<bool> to true or false, respectively.
  99 };
 100
 101 std::string script_get_backtrace(lua_State *L);
 102 int script_exception_wrapper(lua_State *L, lua_CFunction f);
 103 void script_error(lua_State *L, int pcall_result, const char *mod, const char *fxn);
 104 void script_run_callbacks_f(lua_State *L, int nargs,
 105         RunCallbacksMode mode, const char *fxn);
 106 void log_deprecated(lua_State *L, const std::string &message);