/* Copyright (c) 2009 Peter "Corsix" Cawley 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. */ #ifndef CORSIX_TH_TH_LUA_H_ #define CORSIX_TH_TH_LUA_H_ #include "config.h" #include #include #include #include #include #include #include #include "lua.hpp" class lua_state_deleter { public: void operator()(lua_State* L) const { lua_close(L); } }; //! \brief Unique pointer for lua_State using lua_state_unique_ptr = std::unique_ptr; int luaopen_th(lua_State* L); // Print debugging helper functions void luaT_printvalue(lua_State* L, int idx); void luaT_printstack(lua_State* L); void luaT_printrawtable(lua_State* L, int idx); //! Lua 5.3 lua_rotate backported to 5.1+ /*! /sa https://www.lua.org/manual/5.4/manual.html#lua_rotate */ inline void luaT_rotate(lua_State* L, int idx, int n) { #if LUA_VERSION_NUM >= 503 lua_rotate(L, idx, n); #else if (n < 0) { if (idx < 0) { idx = lua_gettop(L) + idx + 1; } n = lua_gettop(L) - idx + 1 + n; } for (int i = 0; i < n; i++) { lua_insert(L, idx); } #endif } // Compatibility layer for removal of environments in 5.2 #if LUA_VERSION_NUM >= 502 const int luaT_environindex = lua_upvalueindex(1); #else const int luaT_environindex = LUA_ENVIRONINDEX; #endif inline int luaT_upvalueindex(int i) { #if LUA_VERSION_NUM >= 502 return lua_upvalueindex(i + 1); #else return lua_upvalueindex(i); #endif } //! Compatibility function for Lua 5.1 luaL_register /*! luaL_register was removed in Lua 5.2. \param L The lua state \param n The name of the library to register \param l An array of functions to register in the library \sa https://www.lua.org/manual/5.1/manual.html#luaL_register */ template inline void luaT_register(lua_State* L, const char* n, Collection& l) { #if LUA_VERSION_NUM >= 502 lua_createtable(L, 0, static_cast(l.size())); lua_pushvalue(L, luaT_environindex); luaL_setfuncs(L, l.data(), 1); lua_pushvalue(L, -1); lua_setglobal(L, n); #else luaL_register(L, n, l.data()); #endif } //! Register functions into the table on top of the stack /*! \param L The lua state \param R An array of functions to register \sa https://www.lua.org/manual/5.1/manual.html#luaL_register */ inline void luaT_setfuncs(lua_State* L, const luaL_Reg* R) { #if LUA_VERSION_NUM >= 502 lua_pushvalue(L, luaT_environindex); luaL_setfuncs(L, R, 1); #else luaL_register(L, nullptr, R); #endif } inline void luaT_pushcclosure(lua_State* L, lua_CFunction f, int nups) { #if LUA_VERSION_NUM >= 502 ++nups; lua_pushvalue(L, luaT_environindex); lua_insert(L, -nups); lua_pushcclosure(L, f, nups); #else lua_pushcclosure(L, f, nups); #endif } inline void luaT_pushcfunction(lua_State* L, lua_CFunction f) { luaT_pushcclosure(L, f, 0); } inline int luaT_cpcall(lua_State* L, lua_CFunction f, void* u) { #if LUA_VERSION_NUM >= 502 lua_checkstack(L, 2); lua_pushcfunction(L, f); lua_pushlightuserdata(L, u); return lua_pcall(L, 1, 0, 0); #else return lua_cpcall(L, f, u); #endif } // Compatibility for missing mode argument on lua_load in 5.1 inline int luaT_load(lua_State* L, lua_Reader r, void* d, const char* s, const char* m) { #if LUA_VERSION_NUM >= 502 return lua_load(L, r, d, s, m); #else return lua_load(L, r, d, s); #endif } // Compatibility for older versions of lua_resume inline int luaT_resume(lua_State* L, lua_State* f, int n, int* nresults) { #if LUA_VERSION_NUM >= 504 return lua_resume(L, f, n, nresults); #elif LUA_VERSION_NUM >= 502 int res = lua_resume(L, f, n); *nresults = lua_gettop(L); return res; #else int res = lua_resume(L, n); *nresults = lua_gettop(L); return res; #endif } //! Version of operator new which allocates into a Lua userdata /*! If a specific constructor of T is required, then call like: T* variable = luaT_new(L, constructor arguments); If the default constructor is wanted, it can be called like: T* variable = luaT_new(L); See also luaT_stdnew() which allocates, and also sets up the environment table and metatable for the userdata. */ template T* luaT_new(lua_State* L, Ts... args) { return new (lua_newuserdata(L, sizeof(T))) T(args...); } //! Check that a Lua argument is a binary data blob /*! If the given argument is a string or (full) userdata, then returns a pointer to the start of it, and the length of it. Otherwise, throws a Lua error. */ const uint8_t* luaT_checkfile(lua_State* L, int idx, size_t* pDataLen); //! Check that a Lua argument is a string or a proxied string const char* luaT_checkstring(lua_State* L, int idx, size_t* pLength); //! Push a C closure as a callable table void luaT_pushcclosuretable(lua_State* L, lua_CFunction fn, int n); //! Set a field on the environment table of a value /*! Performs: env(stack[index])[k] = top; pop() */ void luaT_setenvfield(lua_State* L, int index, const char* k); //! Get a field from the environment table of a value /*! Performs: push(env(stack[index])[k]) */ void luaT_getenvfield(lua_State* L, int index, const char* k); template inline T* luaT_stdnew(lua_State* L, int mt_idx = luaT_environindex, bool env = false, Args&&... args) { T* p = luaT_new(L, std::forward(args)...); lua_pushvalue(L, mt_idx); lua_setmetatable(L, -2); if (env) { lua_newtable(L); lua_setfenv(L, -2); } return p; } template struct luaT_classinfo {}; class render_target; template <> struct luaT_classinfo { static inline const char* name() { return "Surface"; } }; class level_map; template <> struct luaT_classinfo { static inline const char* name() { return "Map"; } }; class sprite_sheet; template <> struct luaT_classinfo { static inline const char* name() { return "SpriteSheet"; } }; class animation; template <> struct luaT_classinfo { static inline const char* name() { return "Animation"; } }; class animation_manager; template <> struct luaT_classinfo { static inline const char* name() { return "Animator"; } }; class palette; template <> struct luaT_classinfo { static inline const char* name() { return "Palette"; } }; class raw_bitmap; template <> struct luaT_classinfo { static inline const char* name() { return "RawBitmap"; } }; class font; template <> struct luaT_classinfo { static inline const char* name() { return "Font"; } }; class bitmap_font; template <> struct luaT_classinfo { static inline const char* name() { return "BitmapFont"; } }; class freetype_font; template <> struct luaT_classinfo { static inline const char* name() { return "FreeTypeFont"; } }; struct layers; template <> struct luaT_classinfo { static inline const char* name() { return "Layers"; } }; class pathfinder; template <> struct luaT_classinfo { static inline const char* name() { return "Pathfinder"; } }; class cursor; template <> struct luaT_classinfo { static inline const char* name() { return "Cursor"; } }; class line_sequence; template <> struct luaT_classinfo { static inline const char* name() { return "Line"; } }; class music; template <> struct luaT_classinfo { static inline const char* name() { return "Music"; } }; class sound_archive; template <> struct luaT_classinfo { static inline const char* name() { return "SoundArchive"; } }; class sound_player; template <> struct luaT_classinfo { static inline const char* name() { return "SoundEffects"; } }; class movie_player; template <> struct luaT_classinfo { static inline const char* name() { return "Movie"; } }; class abstract_window; template <> struct luaT_classinfo { static inline const char* name() { return "WindowBase"; } }; class sprite_render_list; template <> struct luaT_classinfo { static inline const char* name() { return "SpriteRenderList"; } }; class string_proxy; template <> struct luaT_classinfo { static inline const char* name() { return "StringProxy"; } }; class lfs_ext; template <> struct luaT_classinfo { static inline const char* name() { return "LfsExt"; } }; class iso_filesystem; template <> struct luaT_classinfo { static inline const char* name() { return "ISO Filesystem"; } }; class th_lua_midi_player; template <> struct luaT_classinfo { static inline const char* name() { return "MidiPlayer"; } }; template T* luaT_testuserdata(lua_State* L, int idx, int mt_idx, bool required = true) { // Turn mt_idx into an absolute index, as the stack size changes. if (mt_idx > LUA_REGISTRYINDEX && mt_idx < 0) { mt_idx = lua_gettop(L) + mt_idx + 1; } void* ud = lua_touserdata(L, idx); if (ud != nullptr && lua_getmetatable(L, idx) != 0) { while (true) { if (lua_equal(L, mt_idx, -1) != 0) { lua_pop(L, 1); return static_cast(ud); } // Go up one inheritance level, if there is one. if (lua_type(L, -1) != LUA_TTABLE) break; lua_rawgeti(L, -1, 1); lua_replace(L, -2); } lua_pop(L, 1); } if (required) { const char* msg = lua_pushfstring(L, "%s expected, got %s", luaT_classinfo::name(), luaL_typename(L, idx)); luaL_argerror(L, idx, msg); assert(false); // unreachable } return nullptr; } template T* luaT_testuserdata(lua_State* L, int idx = 1, bool required = true) { int iMetaIndex = luaT_environindex; if (idx > 1) iMetaIndex = luaT_upvalueindex(idx - 1); return luaT_testuserdata(L, idx, iMetaIndex, required); } template int luaT_stdgc(lua_State* L) { T* p = luaT_testuserdata(L, 1, mt, false); if (p != nullptr) { p->~T(); } return 0; } void luaT_execute(lua_State* L, const char* sLuaString); void luaT_execute_loadstring(lua_State* L, const char* sLuaString); void luaT_push(lua_State* L, lua_CFunction f); void luaT_push(lua_State* L, int i); void luaT_push(lua_State* L, const char* s); template void luaT_execute(lua_State* L, const char* sLuaString, T arg) { luaT_execute_loadstring(L, sLuaString); luaT_push(L, arg); lua_call(L, 1, LUA_MULTRET); } template void luaT_execute(lua_State* L, const char* sLuaString, T1 arg1, T2 arg2) { luaT_execute_loadstring(L, sLuaString); luaT_push(L, arg1); luaT_push(L, arg2); lua_call(L, 2, LUA_MULTRET); } template void luaT_execute(lua_State* L, const char* sLuaString, T1 arg1, T2 arg2, T3 arg3) { luaT_execute_loadstring(L, sLuaString); luaT_push(L, arg1); luaT_push(L, arg2); luaT_push(L, arg3); lua_call(L, 3, LUA_MULTRET); } template void luaT_execute(lua_State* L, const char* sLuaString, T1 arg1, T2 arg2, T3 arg3, T4 arg4) { luaT_execute_loadstring(L, sLuaString); luaT_push(L, arg1); luaT_push(L, arg2); luaT_push(L, arg3); luaT_push(L, arg4); lua_call(L, 4, LUA_MULTRET); } void luaT_pushtablebool(lua_State* L, const char* k, bool v); void preload_lua_package(lua_State* L, const char* name, lua_CFunction fn); namespace { int luaT_get_userdata_classname(lua_State* L, int idx, const char** class_name, void** userdata) { void* p = lua_touserdata(L, idx); *userdata = p; if (p == nullptr) { return 0; } int added_stack = 0; if (lua_getmetatable(L, idx) == 0) { std::printf("Warn: No metatable for userdata\n"); return 0; } lua_getfield(L, -1, "__index"); added_stack += 2; // metadata and field if (lua_type(L, -1) != LUA_TTABLE) { lua_pop(L, added_stack); std::printf("Warn: No __index field method table for userdata\n"); return 0; } if (lua_getmetatable(L, -1) == 0) { lua_pop(L, added_stack); std::printf("Warn: No metatable for method table of userdata\n"); return 0; } lua_getfield(L, -1, "__class_name"); added_stack += 2; // method metatable and class name field if (lua_type(L, -1) != LUA_TSTRING) { lua_pop(L, added_stack); std::printf("Warn: No __class_name field for userdata\n"); return 0; } *class_name = lua_tostring(L, -1); return added_stack; } } // namespace // Find the appropriate derived class of base for a given // userdata object. // // th_lua_internal.h defines our c++ binding class metatables: // metatable: { __index = method_table, ... } // method_table: { ... } // method_table metatable: { __class_name = class_name } template B* luaT_touserdata_base(lua_State* L, int idx, const std::initializer_list& class_names) { static_assert(std::is_base_of::value, "B must be a base class for T1"); static_assert(std::is_base_of::value, "B must be a base class for T2"); const char* class_name = nullptr; void* p; int stack = luaT_get_userdata_classname(L, idx, &class_name, &p); if (class_name == nullptr) { return nullptr; } auto it = class_names.begin(); if (std::strcmp(class_name, *it) == 0) { lua_pop(L, stack); return static_cast(p); } it++; if (std::strcmp(class_name, *it) == 0) { lua_pop(L, stack); return static_cast(p); } std::printf("Warn: Unknown class name for usertype %s\n", class_name); lua_pop(L, stack); return nullptr; } #endif // CORSIX_TH_TH_LUA_H_