path: root/libs/lua/LuaBridge/detail/Stack.h

//------------------------------------------------------------------------------
/*
  https://github.com/vinniefalco/LuaBridge

  Copyright 2016, Robin Gareus <robin@gareus.org>
  Copyright 2012, Vinnie Falco <vinnie.falco@gmail.com>
  Copyright 2007, Nathan Reed

  License: The MIT License (http://www.opensource.org/licenses/mit-license.php)

  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:

  The above copyright notice and this permission notice shall be included in all
  copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.
*/
//==============================================================================

//------------------------------------------------------------------------------
/**
    Receive the lua_State* as an argument.
*/
template <>
struct Stack <lua_State*>
{
  static lua_State* get (lua_State* L, int)
  {
    return L;
  }
};

//------------------------------------------------------------------------------
/**
    Push a lua_CFunction.
*/
template <>
struct Stack <lua_CFunction>
{
  static void push (lua_State* L, lua_CFunction f)
  {
    lua_pushcfunction (L, f);
  }

  static lua_CFunction get (lua_State* L, int index)
  {
    return lua_tocfunction (L, index);
  }
};

//------------------------------------------------------------------------------
/**
    Stack specialization for passing references to built-in types.

    This allows to call functions using primitives, but
    the value assigned by the C++ function is *lost*.

    http://sourceforge.net/p/luabind/mailman/message/32692027/

    Alternatives:
     - wrap all C++ function that have non const reference arguments
    (cleanest solution)

     - use a struct to wrap the value (not a primitive)
    (needs major work to special case arguments in CFunc::)

     - wrap the function and provide the assigned value
     as addition return values

    Either would place hard constraints on the lua code though.

    We currently only need this for Ardour::Editor::do_import() framecnt_t&
    and the returned position is not important.
*/

//------------------------------------------------------------------------------
/**
    Stack specialization for `int`.
*/
template <>
struct Stack <int>
{
  static inline void push (lua_State* L, int value)
  {
    lua_pushinteger (L, static_cast <lua_Integer> (value));
  }

  static inline int get (lua_State* L, int index)
  {
    return static_cast <int> (luaL_checkinteger (L, index));
  }
};

template <>
struct Stack <int const&>
{
  static inline void push (lua_State* L, int value)
  {
    lua_pushnumber (L, static_cast <lua_Number> (value));
  }

  static inline int get (lua_State* L, int index)
  {
    return static_cast <int > (luaL_checknumber (L, index));
  }
};

template <>
struct Stack <int &>
{
  static inline void push (lua_State* L, int &value)
  {
    lua_pushnumber (L, static_cast <lua_Number> (value));
  }

  static inline int& get (lua_State* L, int index)
  {
    int l = static_cast <int> (luaL_checknumber (L, index));
    boost::reference_wrapper<int> r (l);
    return r.get();
  }
};

//------------------------------------------------------------------------------
/**
    Stack specialization for `unsigned int`.
*/
template <>
struct Stack <unsigned int>
{
  static inline void push (lua_State* L, unsigned int value)
  {
    lua_pushinteger (L, static_cast <lua_Integer> (value));
  }

  static inline unsigned int get (lua_State* L, int index)
  {
    return static_cast <unsigned int> (luaL_checkinteger (L, index));
  }
};

template <>
struct Stack <unsigned int const&>
{
  static inline void push (lua_State* L, unsigned int value)
  {
    lua_pushnumber (L, static_cast <lua_Number> (value));
  }

  static inline unsigned int get (lua_State* L, int index)
  {
    return static_cast <unsigned int > (luaL_checknumber (L, index));
  }
};

template <>
struct Stack <unsigned int &>
{
  static inline void push (lua_State* L, unsigned int& value)
  {
    lua_pushnumber (L, static_cast <lua_Number> (value));
  }

  static inline unsigned int& get (lua_State* L, int index)
  {
    unsigned int l = static_cast <unsigned int> (luaL_checknumber (L, index));
    boost::reference_wrapper<unsigned int> r (l);
    return r.get();
  }
};

//------------------------------------------------------------------------------
/**
    Stack specialization for `unsigned char`.
*/
template <>
struct Stack <unsigned char>
{
  static inline void push (lua_State* L, unsigned char value)
  {
    lua_pushinteger (L, static_cast <lua_Integer> (value));
  }

  static inline unsigned char get (lua_State* L, int index)
  {
    return static_cast <unsigned char> (luaL_checkinteger (L, index));
  }
};

template <>
struct Stack <unsigned char const&>
{
  static inline void push (lua_State* L, unsigned char value)
  {
    lua_pushnumber (L, static_cast <lua_Number> (value));
  }

  static inline unsigned char get (lua_State* L, int index)
  {
    return static_cast <unsigned char> (luaL_checknumber (L, index));
  }
};

template <>
struct Stack <unsigned char &>
{
  static inline void push (lua_State* L, unsigned char& value)
  {
    lua_pushnumber (L, static_cast <lua_Number> (value));
  }

  static inline unsigned char& get (lua_State* L, int index)
  {
    unsigned char l = static_cast <unsigned char> (luaL_checknumber (L, index));
    boost::reference_wrapper<unsigned char> r (l);
    return r.get();
  }
};

//------------------------------------------------------------------------------
/**
    Stack specialization for `short`.
*/
template <>
struct Stack <short>
{
  static inline void push (lua_State* L, short value)
  {
    lua_pushinteger (L, static_cast <lua_Integer> (value));
  }

  static inline short get (lua_State* L, int index)
  {
    return static_cast <short> (luaL_checkinteger (L, index));
  }
};

template <>
struct Stack <short const&>
{
  static inline void push (lua_State* L, short value)
  {
    lua_pushnumber (L, static_cast <lua_Number> (value));
  }

  static inline short get (lua_State* L, int index)
  {
    return static_cast <short> (luaL_checknumber (L, index));
  }
};

template <>
struct Stack <short &>
{
  static inline void push (lua_State* L, short& value)
  {
    lua_pushnumber (L, static_cast <lua_Number> (value));
  }

  static inline short& get (lua_State* L, int index)
  {
    short l = static_cast <short> (luaL_checknumber (L, index));
    boost::reference_wrapper<short> r (l);
    return r.get();
  }
};

//------------------------------------------------------------------------------
/**
    Stack specialization for `unsigned short`.
*/
template <>
struct Stack <unsigned short>
{
  static inline void push (lua_State* L, unsigned short value)
  {
    lua_pushinteger (L, static_cast <lua_Integer> (value));
  }

  static inline unsigned short get (lua_State* L, int index)
  {
    return static_cast <unsigned short> (luaL_checkinteger (L, index));
  }
};

template <>
struct Stack <unsigned short const&>
{
  static inline void push (lua_State* L, unsigned short value)
  {
    lua_pushnumber (L, static_cast <lua_Number> (value));
  }

  static inline unsigned short get (lua_State* L, int index)
  {
    return static_cast <unsigned short> (luaL_checknumber (L, index));
  }
};

template <>
struct Stack <unsigned short &>
{
  static inline void push (lua_State* L, unsigned short& value)
  {
    lua_pushnumber (L, static_cast <lua_Number> (value));
  }

  static inline unsigned short& get (lua_State* L, int index)
  {
    unsigned short l = static_cast <unsigned short> (luaL_checknumber (L, index));
    boost::reference_wrapper<unsigned short> r (l);
    return r.get();
  }
};

//------------------------------------------------------------------------------
/**
    Stack specialization for `long`.
*/
template <>
struct Stack <long>
{
  static inline void push (lua_State* L, long value)
  {
    lua_pushinteger (L, static_cast <lua_Integer> (value));
  }

  static inline long get (lua_State* L, int index)
  {
    return static_cast <long> (luaL_checkinteger (L, index));
  }
};

template <>
struct Stack <long const&>
{
  static inline void push (lua_State* L, long value)
  {
    lua_pushnumber (L, static_cast <lua_Number> (value));
  }

  static inline long get (lua_State* L, int index)
  {
    return static_cast <long> (luaL_checknumber (L, index));
  }
};

template <>
struct Stack <long &>
{
  static inline void push (lua_State* L, long& value)
  {
    lua_pushnumber (L, static_cast <lua_Number> (value));
  }

  static inline long& get (lua_State* L, int index)
  {
    long l = static_cast <long> (luaL_checknumber (L, index));
    boost::reference_wrapper<long> r (l);
    return r.get();
  }
};

//------------------------------------------------------------------------------
/**
    Stack specialization for `unsigned long`.
*/
template <>
struct Stack <unsigned long>
{
  static inline void push (lua_State* L, unsigned long value)
  {
    lua_pushinteger (L, static_cast <lua_Integer> (value));
  }

  static inline unsigned long get (lua_State* L, int index)
  {
    return static_cast <unsigned long> (luaL_checkinteger (L, index));
  }
};

template <>
struct Stack <unsigned long const&>
{
  static inline void push (lua_State* L, unsigned long value)
  {
    lua_pushnumber (L, static_cast <lua_Number> (value));
  }

  static inline unsigned long get (lua_State* L, int index)
  {
    return static_cast <unsigned long> (luaL_checknumber (L, index));
  }
};

template <>
struct Stack <unsigned long &>
{
  static inline void push (lua_State* L, unsigned long& value)
  {
    lua_pushnumber (L, static_cast <lua_Number> (value));
  }

  static inline unsigned long& get (lua_State* L, int index)
  {
    unsigned long l = static_cast <unsigned long> (luaL_checknumber (L, index));
    boost::reference_wrapper<unsigned long> r (l);
    return r.get();
  }
};

//------------------------------------------------------------------------------
/**
    Stack specialization for `long long`.
*/
template <>
struct Stack <long long>
{
  static inline void push (lua_State* L, long long value)
  {
    lua_pushinteger (L, static_cast <lua_Integer> (value));
  }

  static inline long long get (lua_State* L, int index)
  {
    return static_cast <long long> (luaL_checkinteger (L, index));
  }
};

template <>
struct Stack <long long const&>
{
  static inline void push (lua_State* L, long long value)
  {
    lua_pushnumber (L, static_cast <lua_Number> (value));
  }

  static inline long long get (lua_State* L, int index)
  {
    return static_cast <long long> (luaL_checknumber (L, index));
  }
};

template <>
struct Stack <long long &>
{
  static inline void push (lua_State* L, long long& value)
  {
    lua_pushnumber (L, static_cast <lua_Number> (value));
  }

  static inline long long& get (lua_State* L, int index)
  {
    long long l = static_cast <long long> (luaL_checknumber (L, index));
    boost::reference_wrapper<long long> r (l);
    return r.get();
  }
};

//------------------------------------------------------------------------------
/**
    Stack specialization for `unsigned long long`.
*/
template <>
struct Stack <unsigned long long>
{
  static inline void push (lua_State* L, unsigned long long value)
  {
    lua_pushinteger (L, static_cast <lua_Integer> (value));
  }

  static inline unsigned long long get (lua_State* L, int index)
  {
    return static_cast <unsigned long long> (luaL_checkinteger (L, index));
  }
};

template <>
struct Stack <unsigned long long const&>
{
  static inline void push (lua_State* L, unsigned long long value)
  {
    lua_pushnumber (L, static_cast <lua_Number> (value));
  }

  static inline unsigned long long get (lua_State* L, int index)
  {
    return static_cast <unsigned long long> (luaL_checknumber (L, index));
  }
};

//------------------------------------------------------------------------------
/**
    Stack specialization for `float`.
*/
template <>
struct Stack <float>
{
  static inline void push (lua_State* L, float value)
  {
    lua_pushnumber (L, static_cast <lua_Number> (value));
  }

  static inline float get (lua_State* L, int index)
  {
    return static_cast <float> (luaL_checknumber (L, index));
  }
};

template <>
struct Stack <float const&>
{
  static inline void push (lua_State* L, float value)
  {
    lua_pushnumber (L, static_cast <lua_Number> (value));
  }

  static inline float get (lua_State* L, int index)
  {
    return static_cast <float> (luaL_checknumber (L, index));
  }
};

template <>
struct Stack <float &>
{
  static inline void push (lua_State* L, float& value)
  {
    lua_pushnumber (L, static_cast <lua_Number> (value));
  }

  static inline float& get (lua_State* L, int index)
  {
    float l = static_cast <float> (luaL_checknumber (L, index));
    boost::reference_wrapper<float> r (l);
    return r.get();
  }
};

//------------------------------------------------------------------------------
/**
    Stack specialization for `double`.
*/
template <> struct Stack <double>
{
  static inline void push (lua_State* L, double value)
  {
    lua_pushnumber (L, static_cast <lua_Number> (value));
  }

  static inline double get (lua_State* L, int index)
  {
    return static_cast <double> (luaL_checknumber (L, index));
  }
};

template <> struct Stack <double const&>
{
  static inline void push (lua_State* L, double value)
  {
    lua_pushnumber (L, static_cast <lua_Number> (value));
  }

  static inline double get (lua_State* L, int index)
  {
    return static_cast <double> (luaL_checknumber (L, index));
  }
};

template <> struct Stack <double &>
{
  static inline void push (lua_State* L, double& value)
  {
    lua_pushnumber (L, static_cast <lua_Number> (value));
  }

  static inline double& get (lua_State* L, int index)
  {
    double l = static_cast <double> (luaL_checknumber (L, index));
    boost::reference_wrapper<double> r (l);
    return r.get();
  }
};

//------------------------------------------------------------------------------
/**
    Stack specialization for `bool`.
*/
template <>
struct Stack <bool> {
  static inline void push (lua_State* L, bool value)
  {
    lua_pushboolean (L, value ? 1 : 0);
  }

  static inline bool get (lua_State* L, int index)
  {
    return lua_toboolean (L, index) ? true : false;
  }
};

template <>
struct Stack <bool const&> {
  static inline void push (lua_State* L, bool value)
  {
    lua_pushboolean (L, value ? 1 : 0);
  }

  static inline bool get (lua_State* L, int index)
  {
    return lua_toboolean (L, index) ? true : false;
  }
};

template <>
struct Stack <bool &> {
  static inline void push (lua_State* L, bool& value)
  {
    lua_pushboolean (L, value ? 1 : 0);
  }

  static inline bool& get (lua_State* L, int index)
  {
    bool l = lua_toboolean (L, index) ? true : false;
    boost::reference_wrapper<bool> r (l);
    return r.get();
  }
};

//------------------------------------------------------------------------------
/**
    Stack specialization for `char`.
*/
template <>
struct Stack <char>
{
  static inline void push (lua_State* L, char value)
  {
    char str [2] = { value, 0 };
    lua_pushstring (L, str);
  }

  static inline char get (lua_State* L, int index)
  {
    return luaL_checkstring (L, index) [0];
  }
};

template <>
struct Stack <char const&>
{
  static inline void push (lua_State* L, char value)
  {
    char str [2] = { value, 0 };
    lua_pushstring (L, str);
  }

  static inline char get (lua_State* L, int index)
  {
    return luaL_checkstring (L, index) [0];
  }
};

template <>
struct Stack <char const *>
{
  static inline void push (lua_State* L, char const* str)
  {
    if (str != 0)
      lua_pushstring (L, str);
    else
      lua_pushnil (L);
  }

  static inline char const *get (lua_State* L, int index)
  {
    return lua_isnil (L, index) ? 0 : luaL_checkstring (L, index);
  }
};

template <>
struct Stack <char &>
{
  static inline void push (lua_State* L, char& value)
  {
    char str [2] = { value, 0 };
    lua_pushstring (L, str);
  }

  static inline char get (lua_State* L, int index)
  {
    char l = luaL_checkstring (L, index) [0];
    boost::reference_wrapper<char> r (l);
    return r.get();
  }
};

//------------------------------------------------------------------------------
/**
    Stack specialization for `std::string`.
*/
template <>
struct Stack <std::string>
{
  static inline void push (lua_State* L, std::string const& str)
  {
    lua_pushlstring (L, str.c_str (), str.size());
  }

  static inline std::string get (lua_State* L, int index)
  {
    size_t len;
    const char *str = luaL_checklstring(L, index, &len);
    return std::string (str, len);
  }
};

template <>
struct Stack <std::string const&>
{
  static inline void push (lua_State* L, std::string const& str)
  {
    lua_pushstring (L, str.c_str());
  }

  static inline std::string get (lua_State* L, int index)
  {
    size_t len;
    const char *str = luaL_checklstring(L, index, &len);
    return std::string (str, len);
  }
};

template <>
struct Stack <std::string &>
{
  static inline void push (lua_State* L, std::string& str)
  {
    lua_pushlstring (L, str.c_str (), str.size());
  }

  static inline std::string& get (lua_State* L, int index)
  {
    size_t len;
    const char *str = luaL_checklstring(L, index, &len);
    std::string l (str, len);
    boost::reference_wrapper<std::string> r (l);
    return r.get();
  }
};