scriptman.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 *
 * xoreos 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ENGINES_AURORA_LUA_SCRIPTMAN_H
#define ENGINES_AURORA_LUA_SCRIPTMAN_H

#include <cassert>

#include <set>
#include <map>

#include "src/common/singleton.h"
#include "src/common/ustring.h"

#include "src/aurora/lua/types.h"

namespace Aurora {

namespace Lua {

class ScriptManager : public Common::Singleton<ScriptManager> {
public:
    ScriptManager();
    ~ScriptManager();

    void init();
    void deinit();

    bool ready() const;

    void executeFile(const Common::UString &path);
    void executeString(const Common::UString &code);

    Variables callFunction(const Common::UString &name, const Variables &params);
    Variables callFunction(const Common::UString &name);

    Variable getGlobalVariable(const Common::UString &name) const;
    TableRef getGlobalTable(const Common::UString &name) const;
    FunctionRef getGlobalFunction(const Common::UString &name) const;

    void addIgnoredFile(const Common::UString &path);
    void removeIgnoredFile(const Common::UString &path);
    bool isIgnoredFile(const Common::UString &path) const;

    void declareClass(const Common::UString &name);

    void beginRegister();
    void endRegister();

    void beginRegisterNamespace(const Common::UString &name);
    void endRegisterNamespace();

    void beginRegisterClass(const Common::UString &name, const Common::UString &baseName = "",
                            lua_CFunction deleter = 0);

    void endRegisterClass();

    void registerConstant(const Common::UString &name, float value);
    void registerVariable(const Common::UString &name, lua_CFunction getter, lua_CFunction setter = 0);
    void registerFunction(const Common::UString &name, lua_CFunction func);

    int getUsedMemoryAmount() const;

    void setLuaInstanceForObject(void *object, const TableRef& luaInstance);
    void unsetLuaInstanceForObject(void *object);
    const TableRef &getLuaInstanceForObject(void *object) const;

    void injectNewIndexMetaEventIntoTable(const TableRef& table);

private:
    typedef std::map<void *, TableRef> ObjectLuaInstanceMap;

    lua_State *_luaState;
    int _regNestingLevel;
    std::set<Common::UString> _ignoredFiles;

    ObjectLuaInstanceMap _objectLuaInstances;

    void openLuaState();
    void closeLuaState();

    void requireDeclaredClass(const Common::UString &name) const;

    void registerDefaultBindings();
    void executeDefaultCode();

    static int atPanic(lua_State *state);

    static int luaGetLua(lua_State *state);
    static int luaPlayFile(lua_State *state);
    static int luaSetGCInterval(lua_State *state);
    static int luaRegisterSubst(lua_State *state);
    static int luaUnregisterSubst(lua_State *state);
    static int luaRegisterHandler(lua_State *state);
};

} // End of namespace Lua

} // End of namespace Aurora

#define LuaScriptMan ::Aurora::Lua::ScriptManager::instance()

#endif // ENGINES_AURORA_LUA_SCRIPTMAN_H