src/script/lua_api/l_base.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 #pragma once
  21
  22 #include "common/c_types.h"
  23 #include "common/c_internal.h"
  24 #include "common/helper.h"
  25 #include "gamedef.h"
  26 #include <unordered_map>
  27
  28 extern "C" {
  29 #include <lua.h>
  30 #include <lauxlib.h>
  31 }
  32
  33 #ifndef SERVER
  34 class Client;
  35 #endif
  36
  37 class ScriptApiBase;
  38 class Server;
  39 class Environment;
  40 class GUIEngine;
  41
  42 class ModApiBase : protected LuaHelper {
  43
  44 public:
  45         static ScriptApiBase*   getScriptApiBase(lua_State *L);
  46         static Server*          getServer(lua_State *L);
  47         #ifndef SERVER
  48         static Client*          getClient(lua_State *L);
  49         #endif // !SERVER
  50
  51         static IGameDef*        getGameDef(lua_State *L);
  52
  53         static Environment*     getEnv(lua_State *L);
  54         static GUIEngine*       getGuiEngine(lua_State *L);
  55         // When we are not loading the mod, this function returns "."
  56         static std::string      getCurrentModPath(lua_State *L);
  57
  58         // Get an arbitrary subclass of ScriptApiBase
  59         // by using dynamic_cast<> on getScriptApiBase()
  60         template<typename T>
  61         static T* getScriptApi(lua_State *L) {
  62                 ScriptApiBase *scriptIface = getScriptApiBase(L);
  63                 T *scriptIfaceDowncast = dynamic_cast<T*>(scriptIface);
  64                 if (!scriptIfaceDowncast) {
  65                         throw LuaError("Requested unavailable ScriptApi - core engine bug!");
  66                 }
  67                 return scriptIfaceDowncast;
  68         }
  69
  70         static bool registerFunction(lua_State *L,
  71                         const char* name,
  72                         lua_CFunction func,
  73                         int top);
  74
  75         static int l_deprecated_function(lua_State *L);
  76         static void markAliasDeprecated(luaL_Reg *reg);
  77 private:
  78         // <old_name> = { <new_name>, <new_function> }
  79         static std::unordered_map<std::string, luaL_Reg> m_deprecated_wrappers;
  80         static bool m_error_deprecated_calls;
  81 };