{- Copyright © 2007-2012 Gracjan Polak Copyright © 2012-2016 Ömer Sinan Ağacan Copyright © 2017 Albert Krewinkel 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. -} {-# LANGUAGE CPP #-} {-# LANGUAGE ForeignFunctionInterface #-} {-| Module : Foreign.Lua.Api.RawBindings Copyright : © 2007–2012 Gracjan Polak, 2012–2016 Ömer Sinan Ağacan, 2017 Albert Krewinkel License : MIT Maintainer : Albert Krewinkel Stability : beta Portability : ForeignFunctionInterface Haskell bindings to lua C API functions. -} module Foreign.Lua.Api.RawBindings where import Foreign.C import Foreign.Lua.Api.Types import Foreign.Ptr #include "lua.h" #include "safer-api.h" -- TODO: lua_getallocf, lua_setallocf -- TODO: Debugger functions -- Some of the Lua functions may call a Haskell function, and trigger -- garbage collection, rescheduling etc. This means we must declare these -- functions as 'safe'. -------------------------------------------------------------------------------- -- * State manipulation -- lua_newstate is currently not supported. -- | See foreign import ccall "lua.h lua_close" lua_close :: LuaState -> IO () -- lua_newthread is currently not supported. -------------------------------------------------------------------------------- -- * Basic stack manipulation -- | See foreign import ccall unsafe "lua.h lua_gettop" lua_gettop :: LuaState -> IO StackIndex -- | See foreign import ccall unsafe "lua.h lua_settop" lua_settop :: LuaState -> StackIndex -> IO () -- | See foreign import ccall unsafe "lua.h lua_pushvalue" lua_pushvalue :: LuaState -> StackIndex -> IO () #if LUA_VERSION_NUMBER >= 503 -- | See foreign import ccall unsafe "lua.h lua_rotate" lua_rotate :: LuaState -> StackIndex -> CInt -> IO () -- | See foreign import ccall unsafe "lua.h lua_copy" lua_copy :: LuaState -> StackIndex -> StackIndex -> IO () #else -- | See foreign import ccall unsafe "lua.h lua_remove" lua_remove :: LuaState -> StackIndex -> IO () -- | See foreign import ccall unsafe "lua.h lua_insert" lua_insert :: LuaState -> StackIndex -> IO () -- | See foreign import ccall unsafe "lua.h lua_replace" lua_replace :: LuaState -> StackIndex -> IO () #endif -- | See foreign import ccall unsafe "lua.h lua_checkstack" lua_checkstack :: LuaState -> StackIndex -> IO LuaBool -- lua_xmove is currently not supported. -------------------------------------------------------------------------------- -- * Stack access functions -- | See foreign import ccall unsafe "lua.h lua_isnumber" lua_isnumber :: LuaState -> StackIndex -> IO LuaBool -- | See foreign import ccall unsafe "lua.h lua_isstring" lua_isstring :: LuaState -> StackIndex -> IO LuaBool -- | See foreign import ccall unsafe "lua.h lua_iscfunction" lua_iscfunction :: LuaState -> StackIndex -> IO LuaBool -- | See foreign import ccall unsafe "lua.h lua_isuserdata" lua_isuserdata :: LuaState -> StackIndex -> IO LuaBool -- | See foreign import ccall unsafe "lua.h lua_type" lua_type :: LuaState -> StackIndex -> IO TypeCode -- | See foreign import ccall unsafe "lua.h lua_typename" lua_typename :: LuaState -> TypeCode -> IO (Ptr CChar) -- lua_compare is unsafe (might cause a longjmp), use hslua_compare instead. #if LUA_VERSION_NUM >= 502 -- | Wrapper around which catches any @longjmp@s. foreign import ccall "safer-api.h hslua_compare" hslua_compare :: LuaState -> StackIndex -> StackIndex -> CInt -> IO (Failable LuaBool) #else -- | See foreign import ccall "lua.h lua_equal" lua_equal :: LuaState -> StackIndex -> StackIndex -> IO CInt -- | See foreign import ccall "lua.h lua_lessthan" lua_lessthan :: LuaState -> StackIndex -> StackIndex -> IO CInt #endif -- | See foreign import ccall unsafe "lua.h lua_rawequal" lua_rawequal :: LuaState -> StackIndex -> StackIndex -> IO LuaBool -- -- Type coercion -- -- | See foreign import ccall unsafe "lua.h lua_toboolean" lua_toboolean :: LuaState -> StackIndex -> IO StackIndex -- | See foreign import ccall unsafe "lua.h lua_tocfunction" lua_tocfunction :: LuaState -> StackIndex -> IO CFunction #if LUA_VERSION_NUMBER >= 502 -- | See foreign import ccall unsafe "lua.h lua_tointegerx" lua_tointegerx :: LuaState -> StackIndex -> Ptr LuaBool -> IO LuaInteger -- | See foreign import ccall unsafe "lua.h lua_tonumberx" lua_tonumberx :: LuaState -> StackIndex -> Ptr LuaBool -> IO LuaNumber #else -- | See foreign import ccall unsafe "lua.h lua_tointeger" lua_tointeger :: LuaState -> StackIndex -> IO LuaInteger -- | See foreign import ccall unsafe "lua.h lua_tonumber" lua_tonumber :: LuaState -> StackIndex -> IO LuaNumber #endif -- | See foreign import ccall unsafe "lua.h lua_tolstring" lua_tolstring :: LuaState -> StackIndex -> Ptr CSize -> IO (Ptr CChar) -- | See foreign import ccall unsafe "lua.h lua_topointer" lua_topointer :: LuaState -> StackIndex -> IO (Ptr ()) -- | See foreign import ccall unsafe "lua.h lua_tothread" lua_tothread :: LuaState -> StackIndex -> IO LuaState -- | See foreign import ccall unsafe "lua.h lua_touserdata" lua_touserdata :: LuaState -> StackIndex -> IO (Ptr a) -- -- Object size -- #if LUA_VERSION_NUMBER >= 502 -- | See foreign import ccall unsafe "lua.h lua_rawlen" lua_rawlen :: LuaState -> StackIndex -> IO CSize #else -- | See foreign import ccall unsafe "lua.h lua_objlen" lua_objlen :: LuaState -> StackIndex -> IO CSize #endif -------------------------------------------------------------------------------- -- * Push functions -- | See foreign import ccall unsafe "lua.h lua_pushnil" lua_pushnil :: LuaState -> IO () -- | See foreign import ccall unsafe "lua.h lua_pushnumber" lua_pushnumber :: LuaState -> LuaNumber -> IO () -- | See foreign import ccall unsafe "lua.h lua_pushinteger" lua_pushinteger :: LuaState -> LuaInteger -> IO () -- | See foreign import ccall unsafe "lua.h lua_pushlstring" lua_pushlstring :: LuaState -> Ptr CChar -> CSize -> IO () -- lua_pushstring is currently not supported. It's difficult to use in a haskell -- context. -- | See foreign import ccall unsafe "lua.h lua_pushcclosure" lua_pushcclosure :: LuaState -> CFunction -> NumArgs -> IO () -- | See foreign import ccall unsafe "lua.h lua_pushboolean" lua_pushboolean :: LuaState -> LuaBool -> IO () -- | See foreign import ccall unsafe "lua.h lua_pushlightuserdata" lua_pushlightuserdata :: LuaState -> Ptr a -> IO () -- | See foreign import ccall unsafe "lua.h lua_pushthread" lua_pushthread :: LuaState -> IO CInt -------------------------------------------------------------------------------- -- * Get functions -- lua_gettable is unsafe, use hslua_gettable instead. -- lua_getfield is unsafe, use hslua_getfield instead. -- lua_getglobal is unsafe, use hslua_getglobal instead. -- lua_getfenv (5.1 only) is not supported. -- | Wrapper around which catches any @longjmp@s. foreign import ccall "safer-api.h hslua_gettable" hslua_gettable :: LuaState -> StackIndex -> IO CInt -- | Wrapper around which catches any @longjmp@s. foreign import ccall "safer-api.h hslua_getfield" hslua_getfield :: LuaState -> StackIndex -> Ptr CChar -> IO CInt -- | See foreign import ccall unsafe "lua.h lua_rawget" lua_rawget :: LuaState -> StackIndex -> IO () -- | See foreign import ccall unsafe "lua.h lua_rawgeti" lua_rawgeti :: LuaState -> StackIndex -> CInt -> IO () -- | See foreign import ccall unsafe "lua.h lua_createtable" lua_createtable :: LuaState -> CInt -> CInt -> IO () -- | See foreign import ccall unsafe "lua.h lua_newuserdata" lua_newuserdata :: LuaState -> CInt -> IO (Ptr ()) -- | See foreign import ccall unsafe "lua.h lua_getmetatable" lua_getmetatable :: LuaState -> StackIndex -> IO CInt -- | Wrapper around which catches any @longjmp@s. foreign import ccall "safer-api.h hslua_getglobal" hslua_getglobal :: LuaState -> Ptr CChar -> IO CInt -------------------------------------------------------------------------------- -- * Set functions -- lua_settable is unsafe, use hslua_settable instead. -- lua_setfield is unsafe, use hslua_setfield instead. -- lua_setglobal is unsafe, use hslua_setglobal instead. -- lua_setfenv (5.1 only) is not supported. -- | Wrapper around which catches any @longjmp@s. foreign import ccall "safer-api.h hslua_settable" hslua_settable :: LuaState -> StackIndex -> IO CInt -- | Wrapper around which catches any @longjmp@s. foreign import ccall "safer-api.h hslua_setfield" hslua_setfield :: LuaState -> StackIndex -> Ptr CChar -> IO CInt -- | See foreign import ccall unsafe "lua.h lua_rawset" lua_rawset :: LuaState -> StackIndex -> IO () -- | See foreign import ccall unsafe "lua.h lua_rawseti" lua_rawseti :: LuaState -> StackIndex -> CInt -> IO () -- | See foreign import ccall unsafe "lua.h lua_setmetatable" lua_setmetatable :: LuaState -> StackIndex -> IO () -- | Wrapper around which catches any @longjmp@s. foreign import ccall "safer-api.h hslua_setglobal" hslua_setglobal :: LuaState -> Ptr CChar -> IO CInt -------------------------------------------------------------------------------- -- * 'load' and 'call' functions (load and run Lua code) #if LUA_VERSION_NUMBER >= 502 -- | See foreign import ccall "lua.h lua_pcallk" lua_pcallk :: LuaState -> NumArgs -> NumResults -> StackIndex -> CInt -> Ptr () -> IO StatusCode #else -- | See foreign import ccall "lua.h lua_pcall" lua_pcall :: LuaState -> NumArgs -> NumResults -> StackIndex -> IO StatusCode #endif -- currently unsupported: -- lua_load -- lua_dump ------------------------------------------------------------------------------ -- * Coroutine functions -- lua_yield / lua_yieldk and lua_resume are currently not supported. -- | See foreign import ccall unsafe "lua.h lua_status" lua_status :: LuaState -> IO StatusCode ------------------------------------------------------------------------------ -- * Garbage-collection functions and options -- | See foreign import ccall "lua.h lua_gc" lua_gc :: LuaState -> CInt -> CInt -> IO CInt ------------------------------------------------------------------------------ -- * Miscellaneous functions -- lua_error is unsafe in a haskell context and hence not supported. -- lua_next is unsafe, use hslua_next instead. -- lua_concat is unsafe (may trigger a longjmp), use hslua_concat instead. -- | Wrapper around which catches any @longjmp@s. foreign import ccall "safer-api.h hslua_next" hslua_next :: LuaState -> StackIndex -> IO (Failable LuaBool) -- | Wrapper around which catches any @longjmp@s. foreign import ccall "safer-api.h hslua_concat" hslua_concat :: LuaState -> NumArgs -> IO (Failable LuaBool) ------------------------------------------------------------------------------ -- * Lua Libraries -- | See foreign import ccall unsafe "lualib.h luaL_openlibs" luaL_openlibs :: LuaState -> IO () -- | Point to function opening the base library. foreign import ccall unsafe "lualib.h &luaopen_base" lua_open_base_ptr :: CFunction -- | Point to function opening the table library. foreign import ccall unsafe "lualib.h &luaopen_table" lua_open_table_ptr :: CFunction -- | Point to function opening the io library. foreign import ccall unsafe "lualib.h &luaopen_io" lua_open_io_ptr :: CFunction -- | Point to function opening the os library. foreign import ccall unsafe "lualib.h &luaopen_os" lua_open_os_ptr :: CFunction -- | Point to function opening the string library. foreign import ccall unsafe "lualib.h &luaopen_string" lua_open_string_ptr :: CFunction -- | Point to function opening the math library. foreign import ccall unsafe "lualib.h &luaopen_math" lua_open_math_ptr :: CFunction -- | Point to function opening the debug library. foreign import ccall unsafe "lualib.h &luaopen_debug" lua_open_debug_ptr :: CFunction -- | Point to function opening the package library. foreign import ccall unsafe "lualib.h &luaopen_package" lua_open_package_ptr :: CFunction -------------------------------------------------------------------------------- -- * The Auxiliary Library -- | See foreign import ccall unsafe "lauxlib.h luaL_newstate" luaL_newstate :: IO LuaState -- | See foreign import ccall "lauxlib.h luaL_newmetatable" luaL_newmetatable :: LuaState -> Ptr CChar -> IO LuaBool -- | See foreign import ccall "lauxlib.h luaL_ref" luaL_ref :: LuaState -> StackIndex -> IO CInt -- | See foreign import ccall "lauxlib.h luaL_unref" luaL_unref :: LuaState -> StackIndex -> CInt -> IO () #if LUA_VERSION_NUMBER >= 502 -- | See foreign import ccall "lauxlib.h luaL_loadfilex" luaL_loadfilex :: LuaState -> Ptr CChar -> Ptr CChar -> IO StatusCode #else -- | See foreign import ccall "lauxlib.h luaL_loadfile" luaL_loadfile :: LuaState -> Ptr CChar -> IO StatusCode #endif -- | See foreign import ccall unsafe "lauxlib.h luaL_loadstring" luaL_loadstring :: LuaState -> Ptr CChar -> IO StatusCode