src/script/lua_api/l_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 #include "common/c_internal.h"
  30
  31 #define luamethod(class, name) {#name, class::l_##name}
  32
  33 #define luamethod_dep(class, good, bad)                                     \
  34                 {#bad, [](lua_State *L) -> int {                                    \
  35                         return l_deprecated_function(L, #good, #bad, &class::l_##good); \
  36                 }}
  37
  38 #define luamethod_aliased(class, good, bad) \
  39                 luamethod(class, good),               \
  40                 luamethod_dep(class, good, bad)
  41
  42 #define API_FCT(name) registerFunction(L, #name, l_##name, top)
  43
  44 // For future use
  45 #define MAP_LOCK_REQUIRED ((void)0)
  46 #define NO_MAP_LOCK_REQUIRED ((void)0)
  47
  48 /* In debug mode ensure no code tries to retrieve the server env when it isn't
  49  * actually available (in CSM) */
  50 #if !defined(SERVER) && !defined(NDEBUG)
  51 #define DEBUG_ASSERT_NO_CLIENTAPI                    \
  52         FATAL_ERROR_IF(getClient(L) != nullptr, "Tried " \
  53                 "to retrieve ServerEnvironment on client")
  54 #else
  55 #define DEBUG_ASSERT_NO_CLIENTAPI ((void)0)
  56 #endif
  57
  58 // Retrieve ServerEnvironment pointer as `env` (no map lock)
  59 #define GET_ENV_PTR_NO_MAP_LOCK                              \
  60         DEBUG_ASSERT_NO_CLIENTAPI;                               \
  61         ServerEnvironment *env = (ServerEnvironment *)getEnv(L); \
  62         if (env == NULL)                                         \
  63                 return 0
  64
  65 // Retrieve ServerEnvironment pointer as `env`
  66 #define GET_ENV_PTR         \
  67         MAP_LOCK_REQUIRED;      \
  68         GET_ENV_PTR_NO_MAP_LOCK
  69
  70 // Retrieve Environment pointer as `env` (no map lock)
  71 #define GET_PLAIN_ENV_PTR_NO_MAP_LOCK            \
  72         Environment *env = (Environment *)getEnv(L); \
  73         if (env == NULL)                             \
  74                 return 0
  75
  76 // Retrieve Environment pointer as `env`
  77 #define GET_PLAIN_ENV_PTR         \
  78         MAP_LOCK_REQUIRED;            \
  79         GET_PLAIN_ENV_PTR_NO_MAP_LOCK