{-# LINE 1 "src/Foreign/Lua/Api/Types.hsc" #-} {- {-# LINE 2 "src/Foreign/Lua/Api/Types.hsc" #-} 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 #-} {-# LANGUAGE GeneralizedNewtypeDeriving #-} {-# LANGUAGE StandaloneDeriving #-} {-| Module : Foreign.Lua.Types.Core Copyright : © 2007–2012 Gracjan Polak, 2012–2016 Ömer Sinan Ağacan, 2017 Albert Krewinkel License : MIT Maintainer : Albert Krewinkel <tarleb+hslua@zeitkraut.de> Stability : beta Portability : ForeignFunctionInterface, GeneralizedNewtypeDeriving The core Lua types, including mappings of Lua types to Haskell. -} module Foreign.Lua.Api.Types where import Prelude hiding (EQ, LT) import Data.Int (Int64) {-# LINE 44 "src/Foreign/Lua/Api/Types.hsc" #-} import Foreign.C (CInt) import Foreign.Ptr (FunPtr, Ptr) import Foreign.Storable (Storable) {-# LINE 49 "src/Foreign/Lua/Api/Types.hsc" #-} -- required only for LUA_ERRFILE {-# LINE 51 "src/Foreign/Lua/Api/Types.hsc" #-} -- | An opaque structure that points to a thread and indirectly (through the -- thread) to the whole state of a Lua interpreter. The Lua library is fully -- reentrant: it has no global variables. All information about a state is -- accessible through this structure. -- -- Synonym for @lua_State *@. See <https://www.lua.org/manual/5.3/#lua_State lua_State>. newtype LuaState = LuaState (Ptr ()) deriving (Eq) -- | Type for C functions. -- -- In order to communicate properly with Lua, a C function must use the -- following protocol, which defines the way parameters and results are passed: -- a C function receives its arguments from Lua in its stack in direct order -- (the first argument is pushed first). So, when the function starts, -- @'gettop'@ returns the number of arguments received by the function. The -- first argument (if any) is at index 1 and its last argument is at index -- @gettop@. To return values to Lua, a C function just pushes them onto the -- stack, in direct order (the first result is pushed first), and returns the -- number of results. Any other value in the stack below the results will be -- properly discarded by Lua. Like a Lua function, a C function called by Lua -- can also return many results. -- -- See <https://www.lua.org/manual/5.3/manual.html#lua_CFunction lua_CFunction>. type CFunction = FunPtr (LuaState -> IO NumResults) -- | The type of integers in Lua. -- -- By default this type is @'Int64'@, but that can be changed to different -- values in lua. (See @LUA_INT_TYPE@ in @luaconf.h@.) -- -- See <https://www.lua.org/manual/5.3/manual.html#lua_Integer lua_Integer>. type LuaInteger = Int64 {-# LINE 84 "src/Foreign/Lua/Api/Types.hsc" #-} -- | The type of floats in Lua. -- -- By default this type is @'Double'@, but that can be changed in Lua to a -- single float or a long double. (See @LUA_FLOAT_TYPE@ in @luaconf.h@.) -- -- See <https://www.lua.org/manual/5.3/manual.html#lua_Number lua_Number>. type LuaNumber = Double {-# LINE 92 "src/Foreign/Lua/Api/Types.hsc" #-} -- -- LuaBool -- -- | Boolean value returned by a Lua C API function. This is a @'CInt'@ and -- interpreted as @'False'@ iff the value is @0@, @'True'@ otherwise. newtype LuaBool = LuaBool CInt deriving (Eq, Storable) -- | Convert a @'LuaBool'@ to a Haskell @'Bool'@. fromLuaBool :: LuaBool -> Bool fromLuaBool (LuaBool 0) = False fromLuaBool _ = True -- | Convert a Haskell @'Bool'@ to a @'LuaBool'@. toLuaBool :: Bool -> LuaBool toLuaBool True = LuaBool 1 toLuaBool False = LuaBool 0 -- -- * Type of Lua values -- -- | Enumeration used as type tag. -- See <https://www.lua.org/manual/5.3/manual.html#lua_type lua_type>. data Type = TypeNone -- ^ non-valid stack index | TypeNil -- ^ type of lua's @nil@ value | TypeBoolean -- ^ type of lua booleans | TypeLightUserdata -- ^ type of light userdata | TypeNumber -- ^ type of lua numbers. See @'LuaNumber'@ | TypeString -- ^ type of lua string values | TypeTable -- ^ type of lua tables | TypeFunction -- ^ type of functions, either normal or @'CFunction'@ | TypeUserdata -- ^ type of full user data | TypeThread -- ^ type of lua threads deriving (Bounded, Eq, Ord, Show) -- | Integer code used to encode the type of a lua value. newtype TypeCode = TypeCode { fromTypeCode :: CInt } deriving (Eq, Ord, Show) instance Enum Type where fromEnum = fromIntegral . fromTypeCode . fromType toEnum = toType . TypeCode . fromIntegral -- | Convert a lua Type to a type code which can be passed to the C API. fromType :: Type -> TypeCode fromType tp = TypeCode $ case tp of TypeNone -> -1 {-# LINE 145 "src/Foreign/Lua/Api/Types.hsc" #-} TypeNil -> 0 {-# LINE 146 "src/Foreign/Lua/Api/Types.hsc" #-} TypeBoolean -> 1 {-# LINE 147 "src/Foreign/Lua/Api/Types.hsc" #-} TypeLightUserdata -> 2 {-# LINE 148 "src/Foreign/Lua/Api/Types.hsc" #-} TypeNumber -> 3 {-# LINE 149 "src/Foreign/Lua/Api/Types.hsc" #-} TypeString -> 4 {-# LINE 150 "src/Foreign/Lua/Api/Types.hsc" #-} TypeTable -> 5 {-# LINE 151 "src/Foreign/Lua/Api/Types.hsc" #-} TypeFunction -> 6 {-# LINE 152 "src/Foreign/Lua/Api/Types.hsc" #-} TypeUserdata -> 7 {-# LINE 153 "src/Foreign/Lua/Api/Types.hsc" #-} TypeThread -> 8 {-# LINE 154 "src/Foreign/Lua/Api/Types.hsc" #-} -- | Convert numerical code to lua type. toType :: TypeCode -> Type toType (TypeCode c) = case c of (-1) -> TypeNone {-# LINE 159 "src/Foreign/Lua/Api/Types.hsc" #-} (0) -> TypeNil {-# LINE 160 "src/Foreign/Lua/Api/Types.hsc" #-} (1) -> TypeBoolean {-# LINE 161 "src/Foreign/Lua/Api/Types.hsc" #-} (2) -> TypeLightUserdata {-# LINE 162 "src/Foreign/Lua/Api/Types.hsc" #-} (3) -> TypeNumber {-# LINE 163 "src/Foreign/Lua/Api/Types.hsc" #-} (4) -> TypeString {-# LINE 164 "src/Foreign/Lua/Api/Types.hsc" #-} (5) -> TypeTable {-# LINE 165 "src/Foreign/Lua/Api/Types.hsc" #-} (6) -> TypeFunction {-# LINE 166 "src/Foreign/Lua/Api/Types.hsc" #-} (7) -> TypeUserdata {-# LINE 167 "src/Foreign/Lua/Api/Types.hsc" #-} (8) -> TypeThread {-# LINE 168 "src/Foreign/Lua/Api/Types.hsc" #-} _ -> error ("No Type corresponding to " ++ show c) -- -- * Relational Operator -- -- | Lua comparison operations. data RelationalOperator = EQ -- ^ Correponds to lua's equality (==) operator. | LT -- ^ Correponds to lua's strictly-lesser-than (<) operator | LE -- ^ Correponds to lua's lesser-or-equal (<=) operator deriving (Eq, Ord, Show) -- | Convert relation operator to its C representation. fromRelationalOperator :: RelationalOperator -> CInt {-# LINE 184 "src/Foreign/Lua/Api/Types.hsc" #-} fromRelationalOperator EQ = 0 {-# LINE 185 "src/Foreign/Lua/Api/Types.hsc" #-} fromRelationalOperator LT = 1 {-# LINE 186 "src/Foreign/Lua/Api/Types.hsc" #-} fromRelationalOperator LE = 2 {-# LINE 187 "src/Foreign/Lua/Api/Types.hsc" #-} {-# LINE 192 "src/Foreign/Lua/Api/Types.hsc" #-} -- -- * Status -- -- | Lua status values. data Status = OK -- ^ success | Yield -- ^ yielding / suspended coroutine | ErrRun -- ^ a runtime rror | ErrSyntax -- ^ syntax error during precompilation | ErrMem -- ^ memory allocation (out-of-memory) error. | ErrErr -- ^ error while running the message handler. | ErrGcmm -- ^ error while running a @__gc@ metamethod. | ErrFile -- ^ opening or reading a file failed. deriving (Eq, Show) -- | Convert C integer constant to @'LuaStatus'@. toStatus :: StatusCode -> Status toStatus (StatusCode c) = case c of -- LUA_OK is not defined in Lua 5.1 0 -> OK (1) -> Yield {-# LINE 216 "src/Foreign/Lua/Api/Types.hsc" #-} (2) -> ErrRun {-# LINE 217 "src/Foreign/Lua/Api/Types.hsc" #-} (3) -> ErrSyntax {-# LINE 218 "src/Foreign/Lua/Api/Types.hsc" #-} (4) -> ErrMem {-# LINE 219 "src/Foreign/Lua/Api/Types.hsc" #-} -- LUA_ERRGCMM did not exist in Lua 5.1; comes before LUA_ERRERR when defined {-# LINE 221 "src/Foreign/Lua/Api/Types.hsc" #-} (5) -> ErrGcmm {-# LINE 222 "src/Foreign/Lua/Api/Types.hsc" #-} (6) -> ErrErr {-# LINE 223 "src/Foreign/Lua/Api/Types.hsc" #-} {-# LINE 226 "src/Foreign/Lua/Api/Types.hsc" #-} (7) -> ErrFile {-# LINE 227 "src/Foreign/Lua/Api/Types.hsc" #-} n -> error $ "Cannot convert (" ++ show n ++ ") to LuaStatus" -- | Integer code used to signal the status of a thread or computation. -- See @'Status'@. newtype StatusCode = StatusCode CInt deriving Eq -- | Value or an error, using the convention that value below zero indicate an -- error. Values greater than zero are used verbatim. The phantom type is -- currently used for documentation only and has no effect. type Failable a = CInt -- -- * Gargabe Collection Control -- -- | Enumeration used by @gc@ function. data GCCONTROL = GCSTOP | GCRESTART | GCCOLLECT | GCCOUNT | GCCOUNTB | GCSTEP | GCSETPAUSE | GCSETSTEPMUL deriving (Enum, Eq, Ord, Show) -- | A stack index newtype StackIndex = StackIndex { fromStackIndex :: CInt } deriving (Enum, Eq, Num, Ord, Show) -- -- Number of arguments and return values -- -- | The number of arguments expected a function. newtype NumArgs = NumArgs { fromNumArgs :: CInt } deriving (Eq, Num, Ord, Show) -- | The number of results returned by a function call. newtype NumResults = NumResults { fromNumResults :: CInt } deriving (Eq, Num, Ord, Show)