l_base.h

Go to the documentation of this file.

/*
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.
*/
 
#pragma once
 
#include "common/c_types.h"
#include "common/c_internal.h"
#include "common/helper.h"
#include "gamedef.h"
#include <unordered_map>
 
extern "C" {
#include <lua.h>
#include <lauxlib.h>
}
 
#ifndef SERVER
class Client;
class GUIEngine;
#endif
class EmergeThread;
class ScriptApiBase;
class Server;
class Environment;
class ServerInventoryManager;
 
class ModApiBase : protected LuaHelper {
public:
    static ScriptApiBase*   getScriptApiBase(lua_State *L);
    static Server*          getServer(lua_State *L);
    static ServerInventoryManager *getServerInventoryMgr(lua_State *L);
    #ifndef SERVER
    static Client*          getClient(lua_State *L);
    static GUIEngine*       getGuiEngine(lua_State *L);
    #endif // !SERVER
    static EmergeThread*    getEmergeThread(lua_State *L);
 
    static IGameDef*        getGameDef(lua_State *L);
 
    static Environment*     getEnv(lua_State *L);
 
    // When we are not loading the mod, this function returns "."
    static std::string      getCurrentModPath(lua_State *L);
 
    // Get an arbitrary subclass of ScriptApiBase
    // by using dynamic_cast<> on getScriptApiBase()
    template<typename T>
    static T* getScriptApi(lua_State *L) {
        ScriptApiBase *scriptIface = getScriptApiBase(L);
        T *scriptIfaceDowncast = dynamic_cast<T*>(scriptIface);
        if (!scriptIfaceDowncast) {
            throw LuaError("Requested unavailable ScriptApi - core engine bug!");
        }
        return scriptIfaceDowncast;
    }
 
    static bool registerFunction(lua_State *L,
            const char* name,
            lua_CFunction func,
            int top);
 
    static void registerClass(lua_State *L, const char *name,
            const luaL_Reg *methods,
            const luaL_Reg *metamethods);
 
    template<typename T>
    static inline T *checkObject(lua_State *L, int narg)
    {
        return *reinterpret_cast<T**>(luaL_checkudata(L, narg, T::className));
    }
 
    static int l_deprecated_function(lua_State *L, const char *good, const char *bad, lua_CFunction func);
};