stack.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_STACK_H
#define ENGINES_AURORA_LUA_STACK_H

#include "src/common/ustring.h"

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

struct lua_State;

namespace Aurora {

namespace Lua {

class Variable;

class Stack {
public:
    Stack(lua_State &state);
    ~Stack();

    int getSize() const;

    void pushNil();
    void pushBoolean(bool value);
    void pushFloat(float value);
    void pushInt(int value);
    void pushString(const char *value);
    void pushString(const Common::UString &value);
    void pushTable(const TableRef &value);
    void pushFunction(const FunctionRef &value);
    void pushRawUserType(void *value, const Common::UString &type);

    void pushVariable(const Variable &var);
    void pushVariables(const Variables &vars);

    template<typename T>
    void pushUserType(T &value, const Common::UString &type);

    bool getBooleanAt(int index) const;
    float getFloatAt(int index) const;
    int getIntAt(int index) const;
    Common::UString getStringAt(int index) const;
    TableRef getTableAt(int index) const;
    FunctionRef getFunctionAt(int index) const;
    void *getRawUserTypeAt(int index, const Common::UString &type = "") const;

    template<typename T>
    T *getUserTypeAt(int index, const Common::UString &type = "") const;

    Variable getVariableAt(int index) const;

    Common::UString getExactTypeAt(int index) const;
    Type getTypeAt(int index) const;

    Variables getVariables() const;
    Variables getVariablesFromTop(int count) const;

    bool isNilAt(int index) const;
    bool isBooleanAt(int index) const;
    bool isNumberAt(int index) const;
    bool isStringAt(int index) const;
    bool isTableAt(int index) const;
    bool isFunctionAt(int index) const;
    bool isUserTypeAt(int index, const Common::UString &type = "") const;

    void registerGCForTopObject();

    lua_State &getLuaState() const;

private:
    lua_State &_luaState;

    bool checkIndex(int index) const;
};

template<typename T>
void Stack::pushUserType(T &value, const Common::UString &type) {
    return pushRawUserType(&value, type);
}

template<typename T>
T *Stack::getUserTypeAt(int index, const Common::UString &type) const {
    return reinterpret_cast<T *>(getRawUserTypeAt(index, type));
}

} // End of namespace Lua

} // End of namespace Aurora

#endif // ENGINES_AURORA_LUA_STACK_H