sol::stack_reference Class Reference

#include <sol.hpp>

Public Member Functions
	stack_reference () noexcept=default
	stack_reference (lua_nil_t) noexcept
	stack_reference (lua_State *L, lua_nil_t) noexcept
	stack_reference (lua_State *L, int i) noexcept
	stack_reference (lua_State *L, absolute_index i) noexcept
	stack_reference (lua_State *L, raw_index i) noexcept
	stack_reference (lua_State *L, ref_index i) noexcept=delete
	stack_reference (lua_State *L, const reference &r) noexcept=delete
	stack_reference (lua_State *L, const stack_reference &r) noexcept
	stack_reference (stack_reference &&o) noexcept=default
stack_reference &	operator= (stack_reference &&) noexcept=default
	stack_reference (const stack_reference &) noexcept=default
stack_reference &	operator= (const stack_reference &) noexcept=default
int	push () const noexcept
int	push (lua_State *Ls) const noexcept
void	pop () const noexcept
void	pop (lua_State *Ls, int n=1) const noexcept
int	stack_index () const noexcept
const void *	pointer () const noexcept
type	get_type () const noexcept
lua_State *	lua_state () const noexcept
bool	valid () const noexcept

Protected Member Functions
int	registry_index () const noexcept

Private Attributes
lua_State *	luastate = nullptr
int	index = 0

Constructor & Destructor Documentation

stack_reference() [1/11]

sol::stack_reference::stack_reference ( )

defaultnoexcept

stack_reference() [2/11]

sol::stack_reference::stack_reference ( lua_nil_t  )

inlinenoexcept

        : stack_reference(){};

stack_reference() [3/11]

sol::stack_reference::stack_reference ( lua_State *  L, lua_nil_t    )

inlinenoexcept

        : luastate(L), index(0) {
        }

stack_reference() [4/11]

sol::stack_reference::stack_reference ( lua_State *  L, int  i  )

inlinenoexcept

        : stack_reference(L, absolute_index(L, i)) {
        }

stack_reference() [5/11]

sol::stack_reference::stack_reference ( lua_State *  L, absolute_index  i  )

inlinenoexcept

        : luastate(L), index(i) {
        }

stack_reference() [6/11]

sol::stack_reference::stack_reference ( lua_State *  L, raw_index  i  )

inlinenoexcept

        : luastate(L), index(i) {
        }

stack_reference() [7/11]

sol::stack_reference::stack_reference ( lua_State *  L, ref_index  i  )

deletenoexcept

stack_reference() [8/11]

sol::stack_reference::stack_reference ( lua_State *  L, const reference &  r  )

deletenoexcept

stack_reference() [9/11]

sol::stack_reference::stack_reference ( lua_State *  L, const stack_reference &  r  )

inlinenoexcept

        : luastate(L) {
            if (!r.valid()) {
                index = 0;
                return;
            }
            int i = r.stack_index();
            if (detail::xmovable(lua_state(), r.lua_state())) {
                lua_pushvalue(r.lua_state(), r.index);
                lua_xmove(r.lua_state(), luastate, 1);
                i = absolute_index(luastate, -1);
            }
            index = i;
        }

stack_reference() [10/11]

sol::stack_reference::stack_reference ( stack_reference &&  o )

defaultnoexcept

stack_reference() [11/11]

sol::stack_reference::stack_reference ( const stack_reference &  )

defaultnoexcept

Member Function Documentation

get_type()

type sol::stack_reference::get_type ( ) const

inlinenoexcept

                                       {
            int result = lua_type(lua_state(), index);
            return static_cast<type>(result);
        }

lua_state()

lua_State* sol::stack_reference::lua_state ( ) const

inlinenoexcept

                                              {
            return luastate;
        }

operator=() [1/2]

stack_reference& sol::stack_reference::operator= ( stack_reference &&  )

defaultnoexcept

operator=() [2/2]

stack_reference& sol::stack_reference::operator= ( const stack_reference &  )

defaultnoexcept

pointer()

const void* sol::stack_reference::pointer ( ) const

inlinenoexcept

                                             {
            const void* vp = lua_topointer(lua_state(), stack_index());
            return vp;
        }

pop() [1/2]

void sol::stack_reference::pop ( ) const

inlinenoexcept

                                  {
            pop(lua_state());
        }

pop() [2/2]

void sol::stack_reference::pop ( lua_State *  Ls, int  n = 1  ) const

inlinenoexcept

                                                          {
            lua_pop(Ls, n);
        }

push() [1/2]

int sol::stack_reference::push ( ) const

inlinenoexcept

                                  {
            return push(lua_state());
        }

push() [2/2]

int sol::stack_reference::push ( lua_State *  Ls ) const

inlinenoexcept

                                               {
            if (lua_state() == nullptr) {
                lua_pushnil(Ls);
                return 1;
            }
            lua_pushvalue(lua_state(), index);
            if (Ls != lua_state()) {
                lua_xmove(lua_state(), Ls, 1);
            }
            return 1;
        }

registry_index()

int sol::stack_reference::registry_index ( ) const

inlineprotectednoexcept

                                            {
            return LUA_NOREF;
        }

stack_index()

int sol::stack_reference::stack_index ( ) const

inlinenoexcept

                                         {
            return index;
        }

valid()

bool sol::stack_reference::valid ( ) const

inlinenoexcept

                                    {
            type t = get_type();
            return t != type::lua_nil && t != type::none;
        }

Member Data Documentation

index

int sol::stack_reference::index = 0

private

luastate

lua_State* sol::stack_reference::luastate = nullptr

private

---

The documentation for this class was generated from the following file:

• external/sol.hpp