sol::basic_table_iterator< reference_type > Class Template Reference

#include <sol.hpp>

Inheritance diagram for sol::basic_table_iterator< reference_type >:

Public Types
typedef object	key_type
typedef object	mapped_type
typedef std::pair< object, object >	value_type
typedef std::input_iterator_tag	iterator_category
typedef std::ptrdiff_t	difference_type
typedef value_type *	pointer
typedef value_type &	reference
typedef const value_type &	const_reference

Public Member Functions
	basic_table_iterator ()
	basic_table_iterator (reference_type x)
basic_table_iterator &	operator++ ()
basic_table_iterator	operator++ (int)
reference	operator* ()
const_reference	operator* () const
bool	operator== (const basic_table_iterator &right) const
bool	operator!= (const basic_table_iterator &right) const
	~basic_table_iterator ()

Private Attributes
std::pair< object, object >	kvp
reference_type	ref
int	tableidx = 0
int	keyidx = 0
std::ptrdiff_t	idx = 0

Member Typedef Documentation

const_reference

template<typename reference_type >

typedef const value_type& sol::basic_table_iterator< reference_type >::const_reference

difference_type

template<typename reference_type >

typedef std::ptrdiff_t sol::basic_table_iterator< reference_type >::difference_type

iterator_category

template<typename reference_type >

typedef std::input_iterator_tag sol::basic_table_iterator< reference_type >::iterator_category

key_type

template<typename reference_type >

typedef object sol::basic_table_iterator< reference_type >::key_type

mapped_type

template<typename reference_type >

typedef object sol::basic_table_iterator< reference_type >::mapped_type

pointer

template<typename reference_type >

typedef value_type* sol::basic_table_iterator< reference_type >::pointer

reference

template<typename reference_type >

typedef value_type& sol::basic_table_iterator< reference_type >::reference

value_type

template<typename reference_type >

typedef std::pair<object, object> sol::basic_table_iterator< reference_type >::value_type

Constructor & Destructor Documentation

basic_table_iterator() [1/2]

template<typename reference_type >

sol::basic_table_iterator< reference_type >::basic_table_iterator ( )

inline

        : keyidx(-1), idx(-1) {
        }

basic_table_iterator() [2/2]

template<typename reference_type >

sol::basic_table_iterator< reference_type >::basic_table_iterator ( reference_type  x )

inline

        : ref(std::move(x)) {
            ref.push();
            tableidx = lua_gettop(ref.lua_state());
            stack::push(ref.lua_state(), lua_nil);
            this->operator++();
            if (idx == -1) {
                return;
            }
            --idx;
        }

~basic_table_iterator()

template<typename reference_type >

sol::basic_table_iterator< reference_type >::~basic_table_iterator ( )

inline

                                {
            if (keyidx != -1) {
                stack::remove(ref.lua_state(), keyidx, 1);
            }
            if (ref.lua_state() != nullptr && ref.valid()) {
                stack::remove(ref.lua_state(), tableidx, 1);
            }
        }

Member Function Documentation

operator!=()

template<typename reference_type >

bool sol::basic_table_iterator< reference_type >::operator!= ( const basic_table_iterator< reference_type > &  right ) const

inline

                                                                 {
            return idx != right.idx;
        }

operator*() [1/2]

template<typename reference_type >

reference sol::basic_table_iterator< reference_type >::operator* ( )

inline

                              {
            return kvp;
        }

operator*() [2/2]

template<typename reference_type >

const_reference sol::basic_table_iterator< reference_type >::operator* ( ) const

inline

                                          {
            return kvp;
        }

operator++() [1/2]

template<typename reference_type >

basic_table_iterator& sol::basic_table_iterator< reference_type >::operator++ ( )

inline

                                           {
            if (idx == -1)
                return *this;

            if (lua_next(ref.lua_state(), tableidx) == 0) {
                idx = -1;
                keyidx = -1;
                return *this;
            }
            ++idx;
            kvp.first = object(ref.lua_state(), -2);
            kvp.second = object(ref.lua_state(), -1);
            lua_pop(ref.lua_state(), 1);
            // leave key on the stack
            keyidx = lua_gettop(ref.lua_state());
            return *this;
        }

operator++() [2/2]

template<typename reference_type >

basic_table_iterator sol::basic_table_iterator< reference_type >::operator++ ( int  )

inline

                                             {
            auto saved = *this;
            this->operator++();
            return saved;
        }

operator==()

template<typename reference_type >

bool sol::basic_table_iterator< reference_type >::operator== ( const basic_table_iterator< reference_type > &  right ) const

inline

                                                                 {
            return idx == right.idx;
        }

Member Data Documentation

idx

template<typename reference_type >

std::ptrdiff_t sol::basic_table_iterator< reference_type >::idx = 0

private

keyidx

template<typename reference_type >

int sol::basic_table_iterator< reference_type >::keyidx = 0

private

kvp

template<typename reference_type >

std::pair<object, object> sol::basic_table_iterator< reference_type >::kvp

private

ref

template<typename reference_type >

reference_type sol::basic_table_iterator< reference_type >::ref

private

tableidx

template<typename reference_type >

int sol::basic_table_iterator< reference_type >::tableidx = 0

private

---

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

• external/sol.hpp