Copyright	© 2007–2012 Gracjan Polak; © 2012–2016 Ömer Sinan Ağacan; © 2017-2024 Albert Krewinkel
License	MIT
Maintainer	Albert Krewinkel <tarleb@hslua.org>
Stability	beta
Portability	non-portable (depends on GHC)
Safe Haskell	None
Language	Haskell2010

HsLua

Contents

Core functionality
Marshalling
Module, data, and function packaging
Type classes
Marshal to and from JSON-like structures
Utility functions

Description

Functions and utilities enabling the seamless integration of a Lua interpreter into a Haskell project.

This module combines and re-exports the functionality of the HsLua framework. Basic access to the Lua API is provided by Core from Hackage package lua.

Synopsis

checkstack' :: LuaError e => Int -> String -> LuaE e ()
dofile :: Maybe FilePath -> LuaE e Status
dostring :: ByteString -> LuaE e Status
getmetafield :: StackIndex -> Name -> LuaE e Type
getmetatable' :: Name -> LuaE e Type
getref :: LuaError e => StackIndex -> Reference -> LuaE e Type
getsubtable :: LuaError e => StackIndex -> Name -> LuaE e Bool
loadbuffer :: ByteString -> Name -> LuaE e Status
loaded :: Name
loadfile :: Maybe FilePath -> LuaE e Status
loadstring :: ByteString -> LuaE e Status
newmetatable :: Name -> LuaE e Bool
newstate :: IO State
preload :: Name
ref :: StackIndex -> LuaE e Reference
requiref :: LuaError e => Name -> CFunction -> Bool -> LuaE e ()
tostring' :: LuaError e => StackIndex -> LuaE e ByteString
traceback :: State -> Maybe ByteString -> Int -> LuaE e ()
unref :: StackIndex -> Reference -> LuaE e ()
where' :: Int -> LuaE e ()
pushHaskellFunction :: LuaError e => HaskellFunction e -> LuaE e ()
pushPreCFunction :: PreCFunction -> LuaE e ()
getupvalue :: StackIndex -> Int -> LuaE e (Maybe Name)
setupvalue :: StackIndex -> Int -> LuaE e (Maybe Name)
changeErrorType :: forall old new a. LuaE old a -> LuaE new a
failLua :: LuaError e => String -> LuaE e a
popErrorMessage :: State -> IO ByteString
pushTypeMismatchError :: ByteString -> StackIndex -> LuaE e ()
throwErrorAsException :: LuaError e => LuaE e a
throwTypeMismatchError :: LuaError e => ByteString -> StackIndex -> LuaE e a
try :: Exception e => LuaE e a -> LuaE e (Either e a)
preloadhs :: LuaError e => Name -> LuaE e NumResults -> LuaE e ()
requirehs :: LuaError e => Name -> (Name -> LuaE e ()) -> LuaE e ()
absindex :: StackIndex -> LuaE e StackIndex
call :: LuaError e => NumArgs -> NumResults -> LuaE e ()
checkstack :: Int -> LuaE e Bool
close :: State -> IO ()
compare :: LuaError e => StackIndex -> StackIndex -> RelationalOperator -> LuaE e Bool
concat :: LuaError e => NumArgs -> LuaE e ()
copy :: StackIndex -> StackIndex -> LuaE e ()
createtable :: Int -> Int -> LuaE e ()
equal :: LuaError e => StackIndex -> StackIndex -> LuaE e Bool
error :: LuaE e NumResults
gc :: GCControl -> LuaE e Int
getfield :: LuaError e => StackIndex -> Name -> LuaE e Type
getglobal :: LuaError e => Name -> LuaE e Type
getiuservalue :: StackIndex -> Int -> LuaE e Type
getmetatable :: StackIndex -> LuaE e Bool
gettable :: LuaError e => StackIndex -> LuaE e Type
gettop :: LuaE e StackIndex
insert :: StackIndex -> LuaE e ()
isboolean :: StackIndex -> LuaE e Bool
iscfunction :: StackIndex -> LuaE e Bool
isfunction :: StackIndex -> LuaE e Bool
isinteger :: StackIndex -> LuaE e Bool
islightuserdata :: StackIndex -> LuaE e Bool
isnil :: StackIndex -> LuaE e Bool
isnone :: StackIndex -> LuaE e Bool
isnoneornil :: StackIndex -> LuaE e Bool
isnumber :: StackIndex -> LuaE e Bool
isstring :: StackIndex -> LuaE e Bool
istable :: StackIndex -> LuaE e Bool
isthread :: StackIndex -> LuaE e Bool
isuserdata :: StackIndex -> LuaE e Bool
lessthan :: LuaError e => StackIndex -> StackIndex -> LuaE e Bool
load :: Reader -> Ptr () -> Name -> LuaE e Status
ltype :: StackIndex -> LuaE e Type
newtable :: LuaE e ()
newuserdatauv :: Int -> Int -> LuaE e (Ptr ())
next :: LuaError e => StackIndex -> LuaE e Bool
openbase :: LuaError e => LuaE e ()
opendebug :: LuaError e => LuaE e ()
openio :: LuaError e => LuaE e ()
openlibs :: LuaE e ()
openmath :: LuaError e => LuaE e ()
openos :: LuaError e => LuaE e ()
openpackage :: LuaError e => LuaE e ()
openstring :: LuaError e => LuaE e ()
opentable :: LuaError e => LuaE e ()
pcall :: NumArgs -> NumResults -> Maybe StackIndex -> LuaE e Status
pop :: Int -> LuaE e ()
pushboolean :: Bool -> LuaE e ()
pushcclosure :: CFunction -> NumArgs -> LuaE e ()
pushcfunction :: CFunction -> LuaE e ()
pushglobaltable :: LuaE e ()
pushinteger :: Integer -> LuaE e ()
pushlightuserdata :: Ptr a -> LuaE e ()
pushnil :: LuaE e ()
pushnumber :: Number -> LuaE e ()
pushstring :: ByteString -> LuaE e ()
pushthread :: LuaE e Bool
pushvalue :: StackIndex -> LuaE e ()
rawequal :: StackIndex -> StackIndex -> LuaE e Bool
rawget :: LuaError e => StackIndex -> LuaE e Type
rawgeti :: LuaError e => StackIndex -> Integer -> LuaE e Type
rawlen :: StackIndex -> LuaE e Int
rawset :: LuaError e => StackIndex -> LuaE e ()
rawseti :: LuaError e => StackIndex -> Integer -> LuaE e ()
register :: LuaError e => Name -> CFunction -> LuaE e ()
remove :: StackIndex -> LuaE e ()
replace :: StackIndex -> LuaE e ()
rotate :: StackIndex -> Int -> LuaE e ()
setfield :: LuaError e => StackIndex -> Name -> LuaE e ()
setglobal :: LuaError e => Name -> LuaE e ()
setiuservalue :: StackIndex -> Int -> LuaE e Bool
setmetatable :: StackIndex -> LuaE e ()
settable :: LuaError e => StackIndex -> LuaE e ()
settop :: StackIndex -> LuaE e ()
setwarnf :: WarnFunction -> Ptr () -> LuaE e ()
status :: LuaE e Status
toboolean :: StackIndex -> LuaE e Bool
tocfunction :: StackIndex -> LuaE e (Maybe CFunction)
tointeger :: StackIndex -> LuaE e (Maybe Integer)
tonumber :: StackIndex -> LuaE e (Maybe Number)
topointer :: StackIndex -> LuaE e (Ptr ())
tostring :: StackIndex -> LuaE e (Maybe ByteString)
tothread :: StackIndex -> LuaE e (Maybe State)
touserdata :: StackIndex -> LuaE e (Maybe (Ptr a))
typename :: Type -> LuaE e ByteString
upvalueindex :: StackIndex -> StackIndex
closeGCManagedState :: GCManagedState -> IO ()
newGCManagedState :: IO GCManagedState
run :: LuaE e a -> IO a
runEither :: Exception e => LuaE e a -> IO (Either e a)
withGCManagedState :: GCManagedState -> LuaE e a -> IO a
callTrace :: LuaError e => NumArgs -> NumResults -> LuaE e ()
dofileTrace :: Maybe FilePath -> LuaE e Status
dostringTrace :: ByteString -> LuaE e Status
pcallTrace :: NumArgs -> NumResults -> LuaE e Status
multret :: NumResults
noref :: Int
refnil :: Int
registryindex :: StackIndex
runWith :: State -> LuaE e a -> IO a
state :: LuaE e State
unsafeRunWith :: State -> LuaE e a -> IO a
fromuserdata :: forall a e. StackIndex -> Name -> LuaE e (Maybe a)
newhsuserdatauv :: a -> Int -> LuaE e ()
newudmetatable :: Name -> LuaE e Bool
putuserdata :: StackIndex -> Name -> a -> LuaE e Bool
setwarnf' :: LuaError e => (ByteString -> LuaE e ()) -> LuaE e ()
nth :: CInt -> StackIndex
nthBottom :: CInt -> StackIndex
nthTop :: CInt -> StackIndex
top :: StackIndex
fromReference :: Reference -> CInt
toReference :: CInt -> Reference
liftIO :: MonadIO m => IO a -> m a
newtype Exception = Exception {
- exceptionMessage :: String
}
type Lua a = LuaE Exception a
class Exception e => LuaError e where
- popException :: LuaE e e
- pushException :: e -> LuaE e ()
- luaException :: String -> e
data GCManagedState
data GCControl
- = GCStop
- | GCRestart
- | GCCollect
- | GCCount
- | GCCountb
- | GCStep CInt
- | GCInc CInt CInt CInt
- | GCGen CInt CInt
- | GCIsRunning
type HaskellFunction e = LuaE e NumResults
newtype LuaE e a = Lua {
- unLua :: ReaderT LuaEnvironment IO a
}
newtype LuaEnvironment = LuaEnvironment {
- luaEnvState :: State
}
newtype Name = Name {
- fromName :: ByteString
}
data RelationalOperator
- = EQ
- | LT
- | LE
data Status
- = OK
- | Yield
- | ErrRun
- | ErrSyntax
- | ErrMem
- | ErrErr
- | ErrFile
data Type
- = TypeNone
- | TypeNil
- | TypeBoolean
- | TypeLightUserdata
- | TypeNumber
- | TypeString
- | TypeTable
- | TypeFunction
- | TypeUserdata
- | TypeThread
data Reference
- = Reference CInt
- | RefNil
type CFunction = FunPtr PreCFunction
newtype Integer = Integer Int64
newtype NumArgs = NumArgs {
- fromNumArgs :: CInt
}
newtype NumResults = NumResults {
- fromNumResults :: CInt
}
newtype Number = Number Double
type PreCFunction = State -> IO NumResults
newtype StackIndex = StackIndex {
- fromStackIndex :: CInt
}
newtype State = State (Ptr ())
cleanup :: Peek e a -> Peek e a
failPeek :: forall a e. ByteString -> Peek e a
failure :: ByteString -> Result a
force :: LuaError e => Result a -> LuaE e a
forcePeek :: LuaError e => Peek e a -> LuaE e a
lastly :: Peek e a -> LuaE e b -> Peek e a
liftLua :: LuaE e a -> Peek e a
resultToEither :: Result a -> Either String a
retrieving :: Name -> Peek e a -> Peek e a
runPeeker :: Peeker e a -> StackIndex -> LuaE e (Result a)
withContext :: Name -> Peek e a -> Peek e a
choice :: LuaError e => [Peeker e a] -> Peeker e a
peekBool :: Peeker e Bool
peekByteString :: Peeker e ByteString
peekFieldRaw :: LuaError e => Peeker e a -> Name -> Peeker e a
peekIntegral :: (Integral a, Read a) => Peeker e a
peekKeyValuePairs :: LuaError e => Peeker e a -> Peeker e b -> Peeker e [(a, b)]
peekLazyByteString :: Peeker e ByteString
peekList :: forall a e. LuaError e => Peeker e a -> Peeker e [a]
peekMap :: (LuaError e, Ord a) => Peeker e a -> Peeker e b -> Peeker e (Map a b)
peekName :: Peeker e Name
peekNil :: Peeker e ()
peekNilOr :: Alternative m => Peeker e a -> Peeker e (m a)
peekNoneOr :: Alternative m => Peeker e a -> Peeker e (m a)
peekNoneOrNil :: Peeker e ()
peekNoneOrNilOr :: Alternative m => Peeker e a -> Peeker e (m a)
peekPair :: LuaError e => Peeker e a -> Peeker e b -> Peeker e (a, b)
peekRead :: Read a => Peeker e a
peekRealFloat :: (RealFloat a, Read a) => Peeker e a
peekSet :: (LuaError e, Ord a) => Peeker e a -> Peeker e (Set a)
peekString :: Peeker e String
peekStringy :: IsString a => Peeker e a
peekText :: Peeker e Text
peekTriple :: LuaError e => Peeker e a -> Peeker e b -> Peeker e c -> Peeker e (a, b, c)
reportValueOnFailure :: Name -> (StackIndex -> LuaE e (Maybe a)) -> Peeker e a
typeChecked :: Name -> (StackIndex -> LuaE e Bool) -> Peeker e a -> Peeker e a
typeMismatchMessage :: Name -> StackIndex -> Peek e ByteString
pushAsTable :: LuaError e => [(Name, a -> LuaE e ())] -> a -> LuaE e ()
pushBool :: Pusher e Bool
pushByteString :: Pusher e ByteString
pushIntegral :: (Integral a, Show a) => a -> LuaE e ()
pushKeyValuePairs :: LuaError e => Pusher e a -> Pusher e b -> Pusher e [(a, b)]
pushLazyByteString :: Pusher e ByteString
pushList :: LuaError e => Pusher e a -> [a] -> LuaE e ()
pushMap :: LuaError e => Pusher e a -> Pusher e b -> Pusher e (Map a b)
pushName :: Name -> LuaE e ()
pushNonEmpty :: LuaError e => Pusher e a -> NonEmpty a -> LuaE e ()
pushPair :: LuaError e => Pusher e a -> Pusher e b -> (a, b) -> LuaE e ()
pushRealFloat :: RealFloat a => a -> LuaE e ()
pushSet :: LuaError e => Pusher e a -> Pusher e (Set a)
pushString :: String -> LuaE e ()
pushText :: Pusher e Text
pushTriple :: LuaError e => Pusher e a -> Pusher e b -> Pusher e c -> (a, b, c) -> LuaE e ()
pushIterator :: forall a e. LuaError e => (a -> LuaE e NumResults) -> [a] -> LuaE e NumResults
newtype Peek e a = Peek {
- runPeek :: LuaE e (Result a)
}
type Peeker e a = StackIndex -> Peek e a
data Result a
- = Success !a
- | Failure ByteString [Name]
type Pusher e a = a -> LuaE e ()
deftypeGeneric :: Pusher e fn -> Name -> [(Operation, fn)] -> [Member e fn a] -> UDType e fn a
alias :: AliasIndex -> Text -> [AliasIndex] -> Member e fn a
deftypeGeneric' :: Pusher e fn -> Name -> [(Operation, fn)] -> [Member e fn a] -> UDTypeHooks e fn a -> UDTypeGeneric e fn a
emptyHooks :: UDTypeHooks e fn a
initType :: LuaError e => UDTypeGeneric e fn a -> LuaE e Name
methodGeneric :: Name -> fn -> Member e fn a
peekUDGeneric :: LuaError e => UDTypeGeneric e fn a -> Peeker e a
possibleProperty :: LuaError e => Name -> Text -> (Pusher e b, a -> Possible b) -> (Peeker e b, a -> b -> Possible a) -> Member e fn a
possibleProperty' :: LuaError e => Name -> TypeSpec -> Text -> (Pusher e b, a -> Possible b) -> (Peeker e b, a -> b -> Possible a) -> Member e fn a
property :: LuaError e => Name -> Text -> (Pusher e b, a -> b) -> (Peeker e b, a -> b -> a) -> Member e fn a
property' :: LuaError e => Name -> TypeSpec -> Text -> (Pusher e b, a -> b) -> (Peeker e b, a -> b -> a) -> Member e fn a
pushUDGeneric :: LuaError e => UDTypeGeneric e fn a -> a -> LuaE e ()
readonly :: Name -> Text -> (Pusher e b, a -> b) -> Member e fn a
readonly' :: Name -> TypeSpec -> Text -> (Pusher e b, a -> b) -> Member e fn a
udDocs :: UDTypeGeneric e fn a -> TypeDocs
udTypeSpec :: UDTypeGeneric e fn a -> TypeSpec
listExtension :: LuaError e => ListSpec e a itemtype -> UDTypeHooks e fn a
type UDType e fn a = UDTypeGeneric e fn a
type Alias = [AliasIndex]
data AliasIndex
- = StringIndex Name
- | IntegerIndex Integer
data Member e fn a
data Possible a
- = Actual a
- | Absent
data Property e a = Property {
- propertyGet :: a -> LuaE e NumResults
- propertySet :: Maybe (StackIndex -> a -> LuaE e a)
- propertyDescription :: Text
- propertyType :: TypeSpec
}
data UDTypeGeneric e fn a = UDType {
- udName :: Name
- udOperations :: [(Operation, fn)]
- udProperties :: Map Name (Property e a)
- udMethods :: Map Name fn
- udAliases :: Map AliasIndex Alias
- udHooks :: UDTypeHooks e fn a
- udFnPusher :: fn -> LuaE e ()
}
data UDTypeHooks e fn a = UDTypeHooks {
- hookUservalues :: Int
- hookMetatableSetup :: LuaE e ()
- hookPeekUD :: a -> StackIndex -> Peek e a
- hookPushUD :: a -> LuaE e ()
}
type ListSpec e a itemtype = ((Pusher e itemtype, a -> [itemtype]), (Peeker e itemtype, a -> [itemtype] -> a))
type UDTypeWithList e fn a itemtype = UDTypeGeneric e fn a
data Operation
- = Add
- | Sub
- | Mul
- | Div
- | Mod
- | Pow
- | Unm
- | Idiv
- | Band
- | Bor
- | Bxor
- | Bnot
- | Shl
- | Shr
- | Concat
- | Len
- | Eq
- | Lt
- | Le
- | Index
- | Newindex
- | Call
- | Tostring
- | Pairs
- | CustomOperation Name
alias :: AliasIndex -> Text -> [AliasIndex] -> Member e fn a
initType :: LuaError e => UDTypeGeneric e fn a -> LuaE e Name
possibleProperty :: LuaError e => Name -> Text -> (Pusher e b, a -> Possible b) -> (Peeker e b, a -> b -> Possible a) -> Member e fn a
possibleProperty' :: LuaError e => Name -> TypeSpec -> Text -> (Pusher e b, a -> Possible b) -> (Peeker e b, a -> b -> Possible a) -> Member e fn a
property :: LuaError e => Name -> Text -> (Pusher e b, a -> b) -> (Peeker e b, a -> b -> a) -> Member e fn a
property' :: LuaError e => Name -> TypeSpec -> Text -> (Pusher e b, a -> b) -> (Peeker e b, a -> b -> a) -> Member e fn a
readonly :: Name -> Text -> (Pusher e b, a -> b) -> Member e fn a
readonly' :: Name -> TypeSpec -> Text -> (Pusher e b, a -> b) -> Member e fn a
udDocs :: UDTypeGeneric e fn a -> TypeDocs
udTypeSpec :: UDTypeGeneric e fn a -> TypeSpec
boolParam :: Text -> Text -> Parameter e Bool
boolResult :: Text -> FunctionResults e Bool
integralParam :: (Read a, Integral a) => Text -> Text -> Parameter e a
integralResult :: (Integral a, Show a) => Text -> FunctionResults e a
stringParam :: Text -> Text -> Parameter e String
stringResult :: Text -> FunctionResults e String
textParam :: Text -> Text -> Parameter e Text
textResult :: Text -> FunctionResults e Text
docsField :: Name
documentation :: LuaError e => DocumentedFunction e
getdocumentation :: LuaError e => StackIndex -> LuaE e Type
pushFieldDoc :: LuaError e => Pusher e (Field e)
pushFunctionDoc :: LuaError e => Pusher e (DocumentedFunction e)
pushModuleDoc :: LuaError e => Pusher e (Module e)
registerDocumentation :: LuaError e => StackIndex -> LuaE e ()
(###) :: (a -> HsFnPrecursor e a) -> a -> HsFnPrecursor e a
(#?) :: DocumentedFunction e -> Text -> DocumentedFunction e
(<#>) :: HsFnPrecursor e (a -> b) -> Parameter e a -> HsFnPrecursor e b
(=#>) :: HsFnPrecursor e (LuaE e a) -> FunctionResults e a -> DocumentedFunction e
(=?>) :: HsFnPrecursor e (LuaE e NumResults) -> Text -> DocumentedFunction e
applyParameter :: HsFnPrecursor e (a -> b) -> Parameter e a -> HsFnPrecursor e b
defun :: Name -> a -> HsFnPrecursor e a
functionResult :: Pusher e a -> TypeSpec -> Text -> FunctionResults e a
lambda :: a -> HsFnPrecursor e a
liftPure :: (a -> b) -> a -> LuaE e b
liftPure2 :: (a -> b -> c) -> a -> b -> LuaE e c
liftPure3 :: (a -> b -> c -> d) -> a -> b -> c -> LuaE e d
liftPure4 :: (a -> b -> c -> d -> e) -> a -> b -> c -> d -> LuaE err e
liftPure5 :: (a -> b -> c -> d -> e -> f) -> a -> b -> c -> d -> e -> LuaE err f
opt :: Parameter e a -> Parameter e (Maybe a)
optionalParameter :: Peeker e a -> TypeSpec -> Text -> Text -> Parameter e (Maybe a)
parameter :: Peeker e a -> TypeSpec -> Text -> Text -> Parameter e a
pushDocumentedFunction :: LuaError e => DocumentedFunction e -> LuaE e ()
returnResult :: HsFnPrecursor e (LuaE e a) -> FunctionResult e a -> DocumentedFunction e
returnResults :: HsFnPrecursor e (LuaE e a) -> FunctionResults e a -> DocumentedFunction e
returnResultsOnStack :: HsFnPrecursor e (LuaE e NumResults) -> Text -> DocumentedFunction e
setName :: Name -> DocumentedFunction e -> DocumentedFunction e
since :: DocumentedFunction e -> Version -> DocumentedFunction e
toHsFnPrecursor :: StackIndex -> Name -> a -> HsFnPrecursor e a
updateFunctionDescription :: DocumentedFunction e -> Text -> DocumentedFunction e
preloadModule :: LuaError e => Module e -> LuaE e ()
preloadModuleWithName :: LuaError e => Module e -> Name -> LuaE e ()
pushModule :: LuaError e => Module e -> LuaE e ()
registerModule :: LuaError e => Module e -> LuaE e ()
deftype :: LuaError e => Name -> [(Operation, DocumentedFunction e)] -> [Member e (DocumentedFunction e) a] -> DocumentedType e a
deftype' :: LuaError e => Name -> [(Operation, DocumentedFunction e)] -> [Member e (DocumentedFunction e) a] -> Maybe (ListSpec e a itemtype) -> DocumentedTypeWithList e a itemtype
method :: DocumentedFunction e -> Member e (DocumentedFunction e) a
operation :: Operation -> DocumentedFunction e -> (Operation, DocumentedFunction e)
peekUD :: LuaError e => DocumentedTypeWithList e a itemtype -> Peeker e a
pushUD :: LuaError e => DocumentedTypeWithList e a itemtype -> a -> LuaE e ()
udparam :: LuaError e => DocumentedTypeWithList e a itemtype -> Text -> Text -> Parameter e a
udresult :: LuaError e => DocumentedTypeWithList e a itemtype -> Text -> FunctionResults e a
data Member e fn a
data Possible a
- = Actual a
- | Absent
data Property e a
data Operation
- = Add
- | Sub
- | Mul
- | Div
- | Mod
- | Pow
- | Unm
- | Idiv
- | Band
- | Bor
- | Bxor
- | Bnot
- | Shl
- | Shr
- | Concat
- | Len
- | Eq
- | Lt
- | Le
- | Index
- | Newindex
- | Call
- | Tostring
- | Pairs
- | CustomOperation Name
data FunctionResult e a = FunctionResult {
- fnResultPusher :: Pusher e a
- fnResultDoc :: ResultValueDoc
}
type FunctionResults e a = [FunctionResult e a]
data HsFnPrecursor e a
data Parameter e a = Parameter {
- parameterPeeker :: Peeker e a
- parameterDoc :: ParameterDoc
}
data DocumentedFunction e = DocumentedFunction {
- callFunction :: LuaE e NumResults
- functionName :: Name
- functionDoc :: FunctionDoc
}
data Field e = Field {
- fieldName :: Text
- fieldType :: TypeSpec
- fieldDescription :: Text
- fieldPushValue :: LuaE e ()
}
data FunctionDoc = FunctionDoc {
- functionDescription :: Text
- parameterDocs :: [ParameterDoc]
- functionResultsDocs :: ResultsDoc
- functionSince :: Maybe Version
}
data Module e = Module {
- moduleName :: Name
- moduleDescription :: Text
- moduleFields :: [Field e]
- moduleFunctions :: [DocumentedFunction e]
- moduleOperations :: [(Operation, DocumentedFunction e)]
- moduleTypeInitializers :: [LuaE e Name]
}
data ParameterDoc = ParameterDoc {
- parameterName :: Text
- parameterType :: TypeSpec
- parameterDescription :: Text
- parameterIsOptional :: Bool
}
data ResultValueDoc = ResultValueDoc {
- resultValueType :: TypeSpec
- resultValueDescription :: Text
}
data ResultsDoc
- = ResultsDocList [ResultValueDoc]
- | ResultsDocMult Text
type DocumentedType e a = UDType e (DocumentedFunction e) a
type DocumentedTypeWithList e a itemtype = UDTypeWithList e (DocumentedFunction e) a itemtype
pushAsHaskellFunction :: Exposable e a => a -> LuaE e ()
registerHaskellFunction :: Exposable e a => Name -> a -> LuaE e ()
toHaskellFunction :: Exposable e a => a -> HaskellFunction e
class LuaError e => Exposable e a where
- partialApply :: StackIndex -> a -> Peek e NumResults
invoke :: Invokable a => Name -> a
class Invokable a where
- addArg :: Name -> (forall e. LuaError e => LuaE e ()) -> NumArgs -> a
peek :: forall a e. (LuaError e, Peekable a) => StackIndex -> LuaE e a
class Peekable a where
- safepeek :: LuaError e => Peeker e a
class Pushable a where
- push :: LuaError e => a -> LuaE e ()
jsonarray :: Name
peekToAeson :: Peeker e (ToAeson e)
peekValue :: LuaError e => Peeker e Value
peekViaJSON :: (FromJSON a, LuaError e) => Peeker e a
pushToAeson :: Pusher e (ToAeson e)
pushValue :: LuaError e => Pusher e Value
pushViaJSON :: (ToJSON a, LuaError e) => Pusher e a
getglobal' :: LuaError e => Name -> LuaE e ()
setglobal' :: LuaError e => Name -> LuaE e ()
peekEither :: (LuaError e, Peekable a) => StackIndex -> LuaE e (Either e a)
popValue :: (LuaError e, Peekable a) => LuaE e a
raiseError :: (LuaError e, Pushable a) => a -> LuaE e NumResults
newtype Optional a = Optional {
- fromOptional :: Maybe a
}

Core functionality

checkstack' :: LuaError e => Int -> String -> LuaE e () #

dofile :: Maybe FilePath -> LuaE e Status #

dostring :: ByteString -> LuaE e Status #

getmetafield :: StackIndex -> Name -> LuaE e Type #

getmetatable' :: Name -> LuaE e Type #

getref :: LuaError e => StackIndex -> Reference -> LuaE e Type #

getsubtable :: LuaError e => StackIndex -> Name -> LuaE e Bool #

loadbuffer :: ByteString -> Name -> LuaE e Status #

loaded :: Name #

loadfile :: Maybe FilePath -> LuaE e Status #

loadstring :: ByteString -> LuaE e Status #

newmetatable :: Name -> LuaE e Bool #

newstate :: IO State #

preload :: Name #

ref :: StackIndex -> LuaE e Reference #

requiref :: LuaError e => Name -> CFunction -> Bool -> LuaE e () #

tostring' :: LuaError e => StackIndex -> LuaE e ByteString #

traceback :: State -> Maybe ByteString -> Int -> LuaE e () #

unref :: StackIndex -> Reference -> LuaE e () #

where' :: Int -> LuaE e () #

pushHaskellFunction :: LuaError e => HaskellFunction e -> LuaE e () #

pushPreCFunction :: PreCFunction -> LuaE e () #

getupvalue :: StackIndex -> Int -> LuaE e (Maybe Name) #

setupvalue :: StackIndex -> Int -> LuaE e (Maybe Name) #

changeErrorType :: forall old new a. LuaE old a -> LuaE new a #

failLua :: LuaError e => String -> LuaE e a #

popErrorMessage :: State -> IO ByteString #

pushTypeMismatchError :: ByteString -> StackIndex -> LuaE e () #

throwErrorAsException :: LuaError e => LuaE e a #

throwTypeMismatchError :: LuaError e => ByteString -> StackIndex -> LuaE e a #

try :: Exception e => LuaE e a -> LuaE e (Either e a) #

preloadhs :: LuaError e => Name -> LuaE e NumResults -> LuaE e () #

requirehs :: LuaError e => Name -> (Name -> LuaE e ()) -> LuaE e () #

absindex :: StackIndex -> LuaE e StackIndex #

call :: LuaError e => NumArgs -> NumResults -> LuaE e () #

checkstack :: Int -> LuaE e Bool #

close :: State -> IO () #

compare :: LuaError e => StackIndex -> StackIndex -> RelationalOperator -> LuaE e Bool #

concat :: LuaError e => NumArgs -> LuaE e () #

copy :: StackIndex -> StackIndex -> LuaE e () #

createtable :: Int -> Int -> LuaE e () #

equal :: LuaError e => StackIndex -> StackIndex -> LuaE e Bool #

error :: LuaE e NumResults #

gc :: GCControl -> LuaE e Int #

getfield :: LuaError e => StackIndex -> Name -> LuaE e Type #

getglobal :: LuaError e => Name -> LuaE e Type #

getiuservalue :: StackIndex -> Int -> LuaE e Type #

getmetatable :: StackIndex -> LuaE e Bool #

gettable :: LuaError e => StackIndex -> LuaE e Type #

gettop :: LuaE e StackIndex #

insert :: StackIndex -> LuaE e () #

isboolean :: StackIndex -> LuaE e Bool #

iscfunction :: StackIndex -> LuaE e Bool #

isfunction :: StackIndex -> LuaE e Bool #

isinteger :: StackIndex -> LuaE e Bool #

islightuserdata :: StackIndex -> LuaE e Bool #

isnil :: StackIndex -> LuaE e Bool #

isnone :: StackIndex -> LuaE e Bool #

isnoneornil :: StackIndex -> LuaE e Bool #

isnumber :: StackIndex -> LuaE e Bool #

isstring :: StackIndex -> LuaE e Bool #

istable :: StackIndex -> LuaE e Bool #

isthread :: StackIndex -> LuaE e Bool #

isuserdata :: StackIndex -> LuaE e Bool #

lessthan :: LuaError e => StackIndex -> StackIndex -> LuaE e Bool #

load :: Reader -> Ptr () -> Name -> LuaE e Status #

ltype :: StackIndex -> LuaE e Type #

newtable :: LuaE e () #

newuserdatauv :: Int -> Int -> LuaE e (Ptr ()) #

next :: LuaError e => StackIndex -> LuaE e Bool #

openbase :: LuaError e => LuaE e () #

opendebug :: LuaError e => LuaE e () #

openio :: LuaError e => LuaE e () #

openlibs :: LuaE e () #

openmath :: LuaError e => LuaE e () #

openos :: LuaError e => LuaE e () #

openpackage :: LuaError e => LuaE e () #

openstring :: LuaError e => LuaE e () #

opentable :: LuaError e => LuaE e () #

pcall :: NumArgs -> NumResults -> Maybe StackIndex -> LuaE e Status #

pop :: Int -> LuaE e () #

pushboolean :: Bool -> LuaE e () #

pushcclosure :: CFunction -> NumArgs -> LuaE e () #

pushcfunction :: CFunction -> LuaE e () #

pushglobaltable :: LuaE e () #

pushinteger :: Integer -> LuaE e () #

pushlightuserdata :: Ptr a -> LuaE e () #

pushnil :: LuaE e () #

pushnumber :: Number -> LuaE e () #

pushstring :: ByteString -> LuaE e () #

pushthread :: LuaE e Bool #

pushvalue :: StackIndex -> LuaE e () #

rawequal :: StackIndex -> StackIndex -> LuaE e Bool #

rawget :: LuaError e => StackIndex -> LuaE e Type #

rawgeti :: LuaError e => StackIndex -> Integer -> LuaE e Type #

rawlen :: StackIndex -> LuaE e Int #

rawset :: LuaError e => StackIndex -> LuaE e () #

rawseti :: LuaError e => StackIndex -> Integer -> LuaE e () #

register :: LuaError e => Name -> CFunction -> LuaE e () #

remove :: StackIndex -> LuaE e () #

replace :: StackIndex -> LuaE e () #

rotate :: StackIndex -> Int -> LuaE e () #

setfield :: LuaError e => StackIndex -> Name -> LuaE e () #

setglobal :: LuaError e => Name -> LuaE e () #

setiuservalue :: StackIndex -> Int -> LuaE e Bool #

setmetatable :: StackIndex -> LuaE e () #

settable :: LuaError e => StackIndex -> LuaE e () #

settop :: StackIndex -> LuaE e () #

setwarnf :: WarnFunction -> Ptr () -> LuaE e () #

status :: LuaE e Status #

toboolean :: StackIndex -> LuaE e Bool #

tocfunction :: StackIndex -> LuaE e (Maybe CFunction) #

tointeger :: StackIndex -> LuaE e (Maybe Integer) #

tonumber :: StackIndex -> LuaE e (Maybe Number) #

topointer :: StackIndex -> LuaE e (Ptr ()) #

tostring :: StackIndex -> LuaE e (Maybe ByteString) #

tothread :: StackIndex -> LuaE e (Maybe State) #

touserdata :: StackIndex -> LuaE e (Maybe (Ptr a)) #

typename :: Type -> LuaE e ByteString #

upvalueindex :: StackIndex -> StackIndex #

closeGCManagedState :: GCManagedState -> IO () #

newGCManagedState :: IO GCManagedState #

run :: LuaE e a -> IO a #

runEither :: Exception e => LuaE e a -> IO (Either e a) #

withGCManagedState :: GCManagedState -> LuaE e a -> IO a #

callTrace :: LuaError e => NumArgs -> NumResults -> LuaE e () #

dofileTrace :: Maybe FilePath -> LuaE e Status #

dostringTrace :: ByteString -> LuaE e Status #

pcallTrace :: NumArgs -> NumResults -> LuaE e Status #

multret :: NumResults #

noref :: Int #

refnil :: Int #

registryindex :: StackIndex #

runWith :: State -> LuaE e a -> IO a #

state :: LuaE e State #

unsafeRunWith :: State -> LuaE e a -> IO a #

fromuserdata :: forall a e. StackIndex -> Name -> LuaE e (Maybe a) #

newhsuserdatauv :: a -> Int -> LuaE e () #

newudmetatable :: Name -> LuaE e Bool #

putuserdata :: StackIndex -> Name -> a -> LuaE e Bool #

setwarnf' :: LuaError e => (ByteString -> LuaE e ()) -> LuaE e () #

nth :: CInt -> StackIndex #

nthBottom :: CInt -> StackIndex #

nthTop :: CInt -> StackIndex #

top :: StackIndex #

fromReference :: Reference -> CInt #

toReference :: CInt -> Reference #

liftIO :: MonadIO m => IO a -> m a #

newtype Exception #

Constructors

Exception
Fields exceptionMessage :: String

Instances

Instances details

Exception Exception #
Instance details Defined in HsLua.Core.Error Methods toException :: Exception -> SomeException fromException :: SomeException -> Maybe Exception displayException :: Exception -> String backtraceDesired :: Exception -> Bool
Show Exception #
Instance details Defined in HsLua.Core.Error Methods showsPrec :: Int -> Exception -> ShowS show :: Exception -> String showList :: [Exception] -> ShowS
Eq Exception #
Instance details Defined in HsLua.Core.Error Methods (==) :: Exception -> Exception -> Bool (/=) :: Exception -> Exception -> Bool
LuaError Exception #
Instance details Defined in HsLua.Core.Error Methods popException :: LuaE Exception Exception # pushException :: Exception -> LuaE Exception () # luaException :: String -> Exception #

type Lua a = LuaE Exception a #

class Exception e => LuaError e where #

Methods

popException :: LuaE e e #

pushException :: e -> LuaE e () #

luaException :: String -> e #

Instances

Instances details

LuaError Exception #
Instance details Defined in HsLua.Core.Error Methods popException :: LuaE Exception Exception # pushException :: Exception -> LuaE Exception () # luaException :: String -> Exception #

data GCManagedState #

data GCControl #

Constructors

GCStop
GCRestart
GCCollect
GCCount
GCCountb
GCStep CInt
GCInc CInt CInt CInt
GCGen CInt CInt
GCIsRunning

Instances

Instances details

Show GCControl #
Instance details Defined in HsLua.Core.Types Methods showsPrec :: Int -> GCControl -> ShowS show :: GCControl -> String showList :: [GCControl] -> ShowS
Eq GCControl #
Instance details Defined in HsLua.Core.Types Methods (==) :: GCControl -> GCControl -> Bool (/=) :: GCControl -> GCControl -> Bool
Ord GCControl #
Instance details Defined in HsLua.Core.Types Methods compare :: GCControl -> GCControl -> Ordering (<) :: GCControl -> GCControl -> Bool (<=) :: GCControl -> GCControl -> Bool (>) :: GCControl -> GCControl -> Bool (>=) :: GCControl -> GCControl -> Bool max :: GCControl -> GCControl -> GCControl min :: GCControl -> GCControl -> GCControl

type HaskellFunction e = LuaE e NumResults #

newtype LuaE e a #

Constructors

Lua
Fields unLua :: ReaderT LuaEnvironment IO a

Instances

Instances details

LuaError e => Exposable e (HaskellFunction e) #
Instance details Defined in HsLua.Class.Exposable Methods partialApply :: StackIndex -> HaskellFunction e -> Peek e NumResults #
MonadReader LuaEnvironment (LuaE e) #
Instance details Defined in HsLua.Core.Types Methods ask :: LuaE e LuaEnvironment local :: (LuaEnvironment -> LuaEnvironment) -> LuaE e a -> LuaE e a reader :: (LuaEnvironment -> a) -> LuaE e a
(LuaError e, Pushable a) => Exposable e (LuaE e a) #
Instance details Defined in HsLua.Class.Exposable Methods partialApply :: StackIndex -> LuaE e a -> Peek e NumResults #
MonadCatch (LuaE e) #
Instance details Defined in HsLua.Core.Types Methods catch :: (HasCallStack, Exception e0) => LuaE e a -> (e0 -> LuaE e a) -> LuaE e a
MonadMask (LuaE e) #
Instance details Defined in HsLua.Core.Types Methods mask :: HasCallStack => ((forall a. LuaE e a -> LuaE e a) -> LuaE e b) -> LuaE e b uninterruptibleMask :: HasCallStack => ((forall a. LuaE e a -> LuaE e a) -> LuaE e b) -> LuaE e b generalBracket :: HasCallStack => LuaE e a -> (a -> ExitCase b -> LuaE e c) -> (a -> LuaE e b) -> LuaE e (b, c)
MonadThrow (LuaE e) #
Instance details Defined in HsLua.Core.Types Methods throwM :: (HasCallStack, Exception e0) => e0 -> LuaE e a
Applicative (LuaE e) #
Instance details Defined in HsLua.Core.Types Methods pure :: a -> LuaE e a (<>) :: LuaE e (a -> b) -> LuaE e a -> LuaE e b liftA2 :: (a -> b -> c) -> LuaE e a -> LuaE e b -> LuaE e c (>) :: LuaE e a -> LuaE e b -> LuaE e b (<*) :: LuaE e a -> LuaE e b -> LuaE e a
Functor (LuaE e) #
Instance details Defined in HsLua.Core.Types Methods fmap :: (a -> b) -> LuaE e a -> LuaE e b (<$) :: a -> LuaE e b -> LuaE e a
Monad (LuaE e) #
Instance details Defined in HsLua.Core.Types Methods (>>=) :: LuaE e a -> (a -> LuaE e b) -> LuaE e b (>>) :: LuaE e a -> LuaE e b -> LuaE e b return :: a -> LuaE e a
MonadIO (LuaE e) #
Instance details Defined in HsLua.Core.Types Methods liftIO :: IO a -> LuaE e a #
(LuaError e, Peekable a) => Invokable (LuaE e a) #
Instance details Defined in HsLua.Class.Invokable Methods addArg :: Name -> (forall e0. LuaError e0 => LuaE e0 ()) -> NumArgs -> LuaE e a #

newtype LuaEnvironment #

Constructors

LuaEnvironment
Fields luaEnvState :: State

Instances

Instances details

MonadReader LuaEnvironment (LuaE e) #
Instance details Defined in HsLua.Core.Types Methods ask :: LuaE e LuaEnvironment local :: (LuaEnvironment -> LuaEnvironment) -> LuaE e a -> LuaE e a reader :: (LuaEnvironment -> a) -> LuaE e a

newtype Name #

Constructors

Name
Fields fromName :: ByteString

Instances

Instances details

Semigroup Name #
Instance details Defined in HsLua.Core.Types Methods (<>) :: Name -> Name -> Name sconcat :: NonEmpty Name -> Name stimes :: Integral b => b -> Name -> Name
IsString Name #
Instance details Defined in HsLua.Core.Types Methods fromString :: String -> Name
Show Name #
Instance details Defined in HsLua.Core.Types Methods showsPrec :: Int -> Name -> ShowS show :: Name -> String showList :: [Name] -> ShowS
Eq Name #
Instance details Defined in HsLua.Core.Types Methods (==) :: Name -> Name -> Bool (/=) :: Name -> Name -> Bool
Ord Name #
Instance details Defined in HsLua.Core.Types Methods compare :: Name -> Name -> Ordering (<) :: Name -> Name -> Bool (<=) :: Name -> Name -> Bool (>) :: Name -> Name -> Bool (>=) :: Name -> Name -> Bool max :: Name -> Name -> Name min :: Name -> Name -> Name

data RelationalOperator #

Constructors

EQ
LT
LE

Instances

Instances details

Show RelationalOperator #
Instance details Defined in HsLua.Core.Types Methods showsPrec :: Int -> RelationalOperator -> ShowS show :: RelationalOperator -> String showList :: [RelationalOperator] -> ShowS
Eq RelationalOperator #
Instance details Defined in HsLua.Core.Types Methods (==) :: RelationalOperator -> RelationalOperator -> Bool (/=) :: RelationalOperator -> RelationalOperator -> Bool
Ord RelationalOperator #
Instance details Defined in HsLua.Core.Types Methods compare :: RelationalOperator -> RelationalOperator -> Ordering (<) :: RelationalOperator -> RelationalOperator -> Bool (<=) :: RelationalOperator -> RelationalOperator -> Bool (>) :: RelationalOperator -> RelationalOperator -> Bool (>=) :: RelationalOperator -> RelationalOperator -> Bool max :: RelationalOperator -> RelationalOperator -> RelationalOperator min :: RelationalOperator -> RelationalOperator -> RelationalOperator

data Status #

Constructors

OK
Yield
ErrRun
ErrSyntax
ErrMem
ErrErr
ErrFile

Instances

Instances details

Show Status #
Instance details Defined in HsLua.Core.Types Methods showsPrec :: Int -> Status -> ShowS show :: Status -> String showList :: [Status] -> ShowS
Eq Status #
Instance details Defined in HsLua.Core.Types Methods (==) :: Status -> Status -> Bool (/=) :: Status -> Status -> Bool

data Type #

Constructors

TypeNone
TypeNil
TypeBoolean
TypeLightUserdata
TypeNumber
TypeString
TypeTable
TypeFunction
TypeUserdata
TypeThread

Instances

Instances details

Bounded Type #
Instance details Defined in HsLua.Core.Types Methods minBound :: Type maxBound :: Type
Enum Type #
Instance details Defined in HsLua.Core.Types Methods succ :: Type -> Type pred :: Type -> Type toEnum :: Int -> Type fromEnum :: Type -> Int enumFrom :: Type -> [Type] enumFromThen :: Type -> Type -> [Type] enumFromTo :: Type -> Type -> [Type] enumFromThenTo :: Type -> Type -> Type -> [Type]
Read Type #
Instance details Defined in HsLua.Core.Types Methods readsPrec :: Int -> ReadS Type readList :: ReadS [Type] readPrec :: ReadPrec Type readListPrec :: ReadPrec [Type]
Show Type #
Instance details Defined in HsLua.Core.Types Methods showsPrec :: Int -> Type -> ShowS show :: Type -> String showList :: [Type] -> ShowS
Eq Type #
Instance details Defined in HsLua.Core.Types Methods (==) :: Type -> Type -> Bool (/=) :: Type -> Type -> Bool
Ord Type #
Instance details Defined in HsLua.Core.Types Methods compare :: Type -> Type -> Ordering (<) :: Type -> Type -> Bool (<=) :: Type -> Type -> Bool (>) :: Type -> Type -> Bool (>=) :: Type -> Type -> Bool max :: Type -> Type -> Type min :: Type -> Type -> Type

data Reference #

Constructors

Reference CInt
RefNil

Instances

Instances details

Show Reference #
Instance details Defined in Lua.Auxiliary Methods showsPrec :: Int -> Reference -> ShowS show :: Reference -> String showList :: [Reference] -> ShowS
Eq Reference #
Instance details Defined in Lua.Auxiliary Methods (==) :: Reference -> Reference -> Bool (/=) :: Reference -> Reference -> Bool

type CFunction = FunPtr PreCFunction #

newtype Integer #

Constructors

Integer Int64

Instances

Instances details

Bounded Integer #
Instance details Defined in Lua.Types Methods minBound :: Integer maxBound :: Integer
Enum Integer #
Instance details Defined in Lua.Types Methods succ :: Integer -> Integer pred :: Integer -> Integer toEnum :: Int -> Integer fromEnum :: Integer -> Int enumFrom :: Integer -> [Integer] enumFromThen :: Integer -> Integer -> [Integer] enumFromTo :: Integer -> Integer -> [Integer] enumFromThenTo :: Integer -> Integer -> Integer -> [Integer]
Num Integer #
Instance details Defined in Lua.Types Methods (+) :: Integer -> Integer -> Integer (-) :: Integer -> Integer -> Integer (*) :: Integer -> Integer -> Integer negate :: Integer -> Integer abs :: Integer -> Integer signum :: Integer -> Integer fromInteger :: Integer -> Integer
Read Integer #
Instance details Defined in Lua.Types Methods readsPrec :: Int -> ReadS Integer readList :: ReadS [Integer] readPrec :: ReadPrec Integer readListPrec :: ReadPrec [Integer]
Integral Integer #
Instance details Defined in Lua.Types Methods quot :: Integer -> Integer -> Integer rem :: Integer -> Integer -> Integer div :: Integer -> Integer -> Integer mod :: Integer -> Integer -> Integer quotRem :: Integer -> Integer -> (Integer, Integer) divMod :: Integer -> Integer -> (Integer, Integer) toInteger :: Integer -> Integer
Real Integer #
Instance details Defined in Lua.Types Methods toRational :: Integer -> Rational
Show Integer #
Instance details Defined in Lua.Types Methods showsPrec :: Int -> Integer -> ShowS show :: Integer -> String showList :: [Integer] -> ShowS
Eq Integer #
Instance details Defined in Lua.Types Methods (==) :: Integer -> Integer -> Bool (/=) :: Integer -> Integer -> Bool
Ord Integer #
Instance details Defined in Lua.Types Methods compare :: Integer -> Integer -> Ordering (<) :: Integer -> Integer -> Bool (<=) :: Integer -> Integer -> Bool (>) :: Integer -> Integer -> Bool (>=) :: Integer -> Integer -> Bool max :: Integer -> Integer -> Integer min :: Integer -> Integer -> Integer
Peekable Integer #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e Integer #
Pushable Integer #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e => Integer -> LuaE e () #

newtype NumArgs #

Constructors

NumArgs
Fields fromNumArgs :: CInt

Instances

Instances details

Num NumArgs #
Instance details Defined in Lua.Types Methods (+) :: NumArgs -> NumArgs -> NumArgs (-) :: NumArgs -> NumArgs -> NumArgs (*) :: NumArgs -> NumArgs -> NumArgs negate :: NumArgs -> NumArgs abs :: NumArgs -> NumArgs signum :: NumArgs -> NumArgs fromInteger :: Integer -> NumArgs
Show NumArgs #
Instance details Defined in Lua.Types Methods showsPrec :: Int -> NumArgs -> ShowS show :: NumArgs -> String showList :: [NumArgs] -> ShowS
Eq NumArgs #
Instance details Defined in Lua.Types Methods (==) :: NumArgs -> NumArgs -> Bool (/=) :: NumArgs -> NumArgs -> Bool
Ord NumArgs #
Instance details Defined in Lua.Types Methods compare :: NumArgs -> NumArgs -> Ordering (<) :: NumArgs -> NumArgs -> Bool (<=) :: NumArgs -> NumArgs -> Bool (>) :: NumArgs -> NumArgs -> Bool (>=) :: NumArgs -> NumArgs -> Bool max :: NumArgs -> NumArgs -> NumArgs min :: NumArgs -> NumArgs -> NumArgs

newtype NumResults #

Constructors

NumResults
Fields fromNumResults :: CInt

Instances

Instances details

Num NumResults #
Instance details Defined in Lua.Types Methods (+) :: NumResults -> NumResults -> NumResults (-) :: NumResults -> NumResults -> NumResults (*) :: NumResults -> NumResults -> NumResults negate :: NumResults -> NumResults abs :: NumResults -> NumResults signum :: NumResults -> NumResults fromInteger :: Integer -> NumResults
Show NumResults #
Instance details Defined in Lua.Types Methods showsPrec :: Int -> NumResults -> ShowS show :: NumResults -> String showList :: [NumResults] -> ShowS
Eq NumResults #
Instance details Defined in Lua.Types Methods (==) :: NumResults -> NumResults -> Bool (/=) :: NumResults -> NumResults -> Bool
Ord NumResults #
Instance details Defined in Lua.Types Methods compare :: NumResults -> NumResults -> Ordering (<) :: NumResults -> NumResults -> Bool (<=) :: NumResults -> NumResults -> Bool (>) :: NumResults -> NumResults -> Bool (>=) :: NumResults -> NumResults -> Bool max :: NumResults -> NumResults -> NumResults min :: NumResults -> NumResults -> NumResults
Peekable CFunction #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e CFunction #
Pushable CFunction #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e => CFunction -> LuaE e () #
LuaError e => Exposable e (HaskellFunction e) #
Instance details Defined in HsLua.Class.Exposable Methods partialApply :: StackIndex -> HaskellFunction e -> Peek e NumResults #

newtype Number #

Constructors

Number Double

Instances

Instances details

Floating Number #
Instance details Defined in Lua.Types Methods pi :: Number exp :: Number -> Number log :: Number -> Number sqrt :: Number -> Number (**) :: Number -> Number -> Number logBase :: Number -> Number -> Number sin :: Number -> Number cos :: Number -> Number tan :: Number -> Number asin :: Number -> Number acos :: Number -> Number atan :: Number -> Number sinh :: Number -> Number cosh :: Number -> Number tanh :: Number -> Number asinh :: Number -> Number acosh :: Number -> Number atanh :: Number -> Number log1p :: Number -> Number expm1 :: Number -> Number log1pexp :: Number -> Number log1mexp :: Number -> Number
RealFloat Number #
Instance details Defined in Lua.Types Methods floatRadix :: Number -> Integer floatDigits :: Number -> Int floatRange :: Number -> (Int, Int) decodeFloat :: Number -> (Integer, Int) encodeFloat :: Integer -> Int -> Number exponent :: Number -> Int significand :: Number -> Number scaleFloat :: Int -> Number -> Number isNaN :: Number -> Bool isInfinite :: Number -> Bool isDenormalized :: Number -> Bool isNegativeZero :: Number -> Bool isIEEE :: Number -> Bool atan2 :: Number -> Number -> Number
Num Number #
Instance details Defined in Lua.Types Methods (+) :: Number -> Number -> Number (-) :: Number -> Number -> Number (*) :: Number -> Number -> Number negate :: Number -> Number abs :: Number -> Number signum :: Number -> Number fromInteger :: Integer -> Number
Read Number #
Instance details Defined in Lua.Types Methods readsPrec :: Int -> ReadS Number readList :: ReadS [Number] readPrec :: ReadPrec Number readListPrec :: ReadPrec [Number]
Fractional Number #
Instance details Defined in Lua.Types Methods (/) :: Number -> Number -> Number recip :: Number -> Number fromRational :: Rational -> Number
Real Number #
Instance details Defined in Lua.Types Methods toRational :: Number -> Rational
RealFrac Number #
Instance details Defined in Lua.Types Methods properFraction :: Integral b => Number -> (b, Number) truncate :: Integral b => Number -> b round :: Integral b => Number -> b ceiling :: Integral b => Number -> b floor :: Integral b => Number -> b
Show Number #
Instance details Defined in Lua.Types Methods showsPrec :: Int -> Number -> ShowS show :: Number -> String showList :: [Number] -> ShowS
Eq Number #
Instance details Defined in Lua.Types Methods (==) :: Number -> Number -> Bool (/=) :: Number -> Number -> Bool
Ord Number #
Instance details Defined in Lua.Types Methods compare :: Number -> Number -> Ordering (<) :: Number -> Number -> Bool (<=) :: Number -> Number -> Bool (>) :: Number -> Number -> Bool (>=) :: Number -> Number -> Bool max :: Number -> Number -> Number min :: Number -> Number -> Number
Peekable Number #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e Number #
Pushable Number #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e => Number -> LuaE e () #

type PreCFunction = State -> IO NumResults #

newtype StackIndex #

Constructors

StackIndex
Fields fromStackIndex :: CInt

Instances

Instances details

Enum StackIndex #
Instance details Defined in Lua.Types Methods succ :: StackIndex -> StackIndex pred :: StackIndex -> StackIndex toEnum :: Int -> StackIndex fromEnum :: StackIndex -> Int enumFrom :: StackIndex -> [StackIndex] enumFromThen :: StackIndex -> StackIndex -> [StackIndex] enumFromTo :: StackIndex -> StackIndex -> [StackIndex] enumFromThenTo :: StackIndex -> StackIndex -> StackIndex -> [StackIndex]
Num StackIndex #
Instance details Defined in Lua.Types Methods (+) :: StackIndex -> StackIndex -> StackIndex (-) :: StackIndex -> StackIndex -> StackIndex (*) :: StackIndex -> StackIndex -> StackIndex negate :: StackIndex -> StackIndex abs :: StackIndex -> StackIndex signum :: StackIndex -> StackIndex fromInteger :: Integer -> StackIndex
Show StackIndex #
Instance details Defined in Lua.Types Methods showsPrec :: Int -> StackIndex -> ShowS show :: StackIndex -> String showList :: [StackIndex] -> ShowS
Eq StackIndex #
Instance details Defined in Lua.Types Methods (==) :: StackIndex -> StackIndex -> Bool (/=) :: StackIndex -> StackIndex -> Bool
Ord StackIndex #
Instance details Defined in Lua.Types Methods compare :: StackIndex -> StackIndex -> Ordering (<) :: StackIndex -> StackIndex -> Bool (<=) :: StackIndex -> StackIndex -> Bool (>) :: StackIndex -> StackIndex -> Bool (>=) :: StackIndex -> StackIndex -> Bool max :: StackIndex -> StackIndex -> StackIndex min :: StackIndex -> StackIndex -> StackIndex

newtype State #

Constructors

State (Ptr ())

Instances

Instances details

Generic State #

Instance details

Defined in Lua.Types

Associated Types

type Rep State
Instance details Defined in Lua.Types type Rep State = D1 ('MetaData "State" "Lua.Types" "lua-2.3.4-8GCx88nuee6BkUvotGVBJj" 'True) (C1 ('MetaCons "State" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Ptr ()))))

Methods

from :: State -> Rep State x

to :: Rep State x -> State

Eq State #

Instance details

Defined in Lua.Types

Methods

(==) :: State -> State -> Bool

(/=) :: State -> State -> Bool

Peekable CFunction #

Instance details

Defined in HsLua.Class.Peekable

Methods

safepeek :: LuaError e => Peeker e CFunction #

Peekable State #

Instance details

Defined in HsLua.Class.Peekable

Methods

safepeek :: LuaError e => Peeker e State #

Pushable CFunction #

Instance details

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e => CFunction -> LuaE e () #

type Rep State #

Instance details

Defined in Lua.Types

type Rep State = D1 ('MetaData "State" "Lua.Types" "lua-2.3.4-8GCx88nuee6BkUvotGVBJj" 'True) (C1 ('MetaCons "State" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Ptr ()))))

Marshalling

cleanup :: Peek e a -> Peek e a #

failPeek :: forall a e. ByteString -> Peek e a #

failure :: ByteString -> Result a #

force :: LuaError e => Result a -> LuaE e a #

forcePeek :: LuaError e => Peek e a -> LuaE e a #

lastly :: Peek e a -> LuaE e b -> Peek e a #

liftLua :: LuaE e a -> Peek e a #

resultToEither :: Result a -> Either String a #

retrieving :: Name -> Peek e a -> Peek e a #

runPeeker :: Peeker e a -> StackIndex -> LuaE e (Result a) #

withContext :: Name -> Peek e a -> Peek e a #

choice :: LuaError e => [Peeker e a] -> Peeker e a #

peekBool :: Peeker e Bool #

peekByteString :: Peeker e ByteString #

peekFieldRaw :: LuaError e => Peeker e a -> Name -> Peeker e a #

peekIntegral :: (Integral a, Read a) => Peeker e a #

peekKeyValuePairs :: LuaError e => Peeker e a -> Peeker e b -> Peeker e [(a, b)] #

peekLazyByteString :: Peeker e ByteString #

peekList :: forall a e. LuaError e => Peeker e a -> Peeker e [a] #

peekMap :: (LuaError e, Ord a) => Peeker e a -> Peeker e b -> Peeker e (Map a b) #

peekName :: Peeker e Name #

peekNil :: Peeker e () #

peekNilOr :: Alternative m => Peeker e a -> Peeker e (m a) #

peekNoneOr :: Alternative m => Peeker e a -> Peeker e (m a) #

peekNoneOrNil :: Peeker e () #

peekNoneOrNilOr :: Alternative m => Peeker e a -> Peeker e (m a) #

peekPair :: LuaError e => Peeker e a -> Peeker e b -> Peeker e (a, b) #

peekRead :: Read a => Peeker e a #

peekRealFloat :: (RealFloat a, Read a) => Peeker e a #

peekSet :: (LuaError e, Ord a) => Peeker e a -> Peeker e (Set a) #

peekString :: Peeker e String #

peekStringy :: IsString a => Peeker e a #

peekText :: Peeker e Text #

peekTriple :: LuaError e => Peeker e a -> Peeker e b -> Peeker e c -> Peeker e (a, b, c) #

reportValueOnFailure :: Name -> (StackIndex -> LuaE e (Maybe a)) -> Peeker e a #

typeChecked :: Name -> (StackIndex -> LuaE e Bool) -> Peeker e a -> Peeker e a #

typeMismatchMessage :: Name -> StackIndex -> Peek e ByteString #

pushAsTable :: LuaError e => [(Name, a -> LuaE e ())] -> a -> LuaE e () #

pushBool :: Pusher e Bool #

pushByteString :: Pusher e ByteString #

pushIntegral :: (Integral a, Show a) => a -> LuaE e () #

pushKeyValuePairs :: LuaError e => Pusher e a -> Pusher e b -> Pusher e [(a, b)] #

pushLazyByteString :: Pusher e ByteString #

pushList :: LuaError e => Pusher e a -> [a] -> LuaE e () #

pushMap :: LuaError e => Pusher e a -> Pusher e b -> Pusher e (Map a b) #

pushName :: Name -> LuaE e () #

pushNonEmpty :: LuaError e => Pusher e a -> NonEmpty a -> LuaE e () #

pushPair :: LuaError e => Pusher e a -> Pusher e b -> (a, b) -> LuaE e () #

pushRealFloat :: RealFloat a => a -> LuaE e () #

pushSet :: LuaError e => Pusher e a -> Pusher e (Set a) #

pushString :: String -> LuaE e () #

pushText :: Pusher e Text #

pushTriple :: LuaError e => Pusher e a -> Pusher e b -> Pusher e c -> (a, b, c) -> LuaE e () #

pushIterator :: forall a e. LuaError e => (a -> LuaE e NumResults) -> [a] -> LuaE e NumResults #

newtype Peek e a #

Constructors

Peek
Fields runPeek :: LuaE e (Result a)

Instances

Instances details

(LuaError e, Pushable a) => Exposable e (Peek e a) #
Instance details Defined in HsLua.Class.Exposable Methods partialApply :: StackIndex -> Peek e a -> Peek e NumResults #
Alternative (Peek e) #
Instance details Defined in HsLua.Marshalling.Peek Methods empty :: Peek e a (<\|>) :: Peek e a -> Peek e a -> Peek e a some :: Peek e a -> Peek e [a] many :: Peek e a -> Peek e [a]
Applicative (Peek e) #
Instance details Defined in HsLua.Marshalling.Peek Methods pure :: a -> Peek e a (<>) :: Peek e (a -> b) -> Peek e a -> Peek e b liftA2 :: (a -> b -> c) -> Peek e a -> Peek e b -> Peek e c (>) :: Peek e a -> Peek e b -> Peek e b (<*) :: Peek e a -> Peek e b -> Peek e a
Functor (Peek e) #
Instance details Defined in HsLua.Marshalling.Peek Methods fmap :: (a -> b) -> Peek e a -> Peek e b (<$) :: a -> Peek e b -> Peek e a
Monad (Peek e) #
Instance details Defined in HsLua.Marshalling.Peek Methods (>>=) :: Peek e a -> (a -> Peek e b) -> Peek e b (>>) :: Peek e a -> Peek e b -> Peek e b return :: a -> Peek e a
MonadPlus (Peek e) #
Instance details Defined in HsLua.Marshalling.Peek Methods mzero :: Peek e a mplus :: Peek e a -> Peek e a -> Peek e a
MonadFail (Peek e) #
Instance details Defined in HsLua.Marshalling.Peek Methods fail :: String -> Peek e a

type Peeker e a = StackIndex -> Peek e a #

data Result a #

Constructors

Success !a
Failure ByteString [Name]

Instances

Instances details

Alternative Result #
Instance details Defined in HsLua.Marshalling.Peek Methods empty :: Result a (<\|>) :: Result a -> Result a -> Result a some :: Result a -> Result [a] many :: Result a -> Result [a]
Applicative Result #
Instance details Defined in HsLua.Marshalling.Peek Methods pure :: a -> Result a (<>) :: Result (a -> b) -> Result a -> Result b liftA2 :: (a -> b -> c) -> Result a -> Result b -> Result c (>) :: Result a -> Result b -> Result b (<*) :: Result a -> Result b -> Result a
Functor Result #
Instance details Defined in HsLua.Marshalling.Peek Methods fmap :: (a -> b) -> Result a -> Result b (<$) :: a -> Result b -> Result a
Monad Result #
Instance details Defined in HsLua.Marshalling.Peek Methods (>>=) :: Result a -> (a -> Result b) -> Result b (>>) :: Result a -> Result b -> Result b return :: a -> Result a
MonadPlus Result #
Instance details Defined in HsLua.Marshalling.Peek Methods mzero :: Result a mplus :: Result a -> Result a -> Result a
MonadFail Result #
Instance details Defined in HsLua.Marshalling.Peek Methods fail :: String -> Result a
Foldable Result #
Instance details Defined in HsLua.Marshalling.Peek Methods fold :: Monoid m => Result m -> m foldMap :: Monoid m => (a -> m) -> Result a -> m foldMap' :: Monoid m => (a -> m) -> Result a -> m foldr :: (a -> b -> b) -> b -> Result a -> b foldr' :: (a -> b -> b) -> b -> Result a -> b foldl :: (b -> a -> b) -> b -> Result a -> b foldl' :: (b -> a -> b) -> b -> Result a -> b foldr1 :: (a -> a -> a) -> Result a -> a foldl1 :: (a -> a -> a) -> Result a -> a toList :: Result a -> [a] null :: Result a -> Bool length :: Result a -> Int elem :: Eq a => a -> Result a -> Bool maximum :: Ord a => Result a -> a minimum :: Ord a => Result a -> a sum :: Num a => Result a -> a product :: Num a => Result a -> a
Traversable Result #
Instance details Defined in HsLua.Marshalling.Peek Methods traverse :: Applicative f => (a -> f b) -> Result a -> f (Result b) sequenceA :: Applicative f => Result (f a) -> f (Result a) mapM :: Monad m => (a -> m b) -> Result a -> m (Result b) sequence :: Monad m => Result (m a) -> m (Result a)
Show a => Show (Result a) #
Instance details Defined in HsLua.Marshalling.Peek Methods showsPrec :: Int -> Result a -> ShowS show :: Result a -> String showList :: [Result a] -> ShowS
Eq a => Eq (Result a) #
Instance details Defined in HsLua.Marshalling.Peek Methods (==) :: Result a -> Result a -> Bool (/=) :: Result a -> Result a -> Bool

type Pusher e a = a -> LuaE e () #

Module, data, and function packaging

deftypeGeneric :: Pusher e fn -> Name -> [(Operation, fn)] -> [Member e fn a] -> UDType e fn a #

alias :: AliasIndex -> Text -> [AliasIndex] -> Member e fn a #

deftypeGeneric' :: Pusher e fn -> Name -> [(Operation, fn)] -> [Member e fn a] -> UDTypeHooks e fn a -> UDTypeGeneric e fn a #

emptyHooks :: UDTypeHooks e fn a #

initType :: LuaError e => UDTypeGeneric e fn a -> LuaE e Name #

methodGeneric :: Name -> fn -> Member e fn a #

peekUDGeneric :: LuaError e => UDTypeGeneric e fn a -> Peeker e a #

possibleProperty :: LuaError e => Name -> Text -> (Pusher e b, a -> Possible b) -> (Peeker e b, a -> b -> Possible a) -> Member e fn a #

possibleProperty' :: LuaError e => Name -> TypeSpec -> Text -> (Pusher e b, a -> Possible b) -> (Peeker e b, a -> b -> Possible a) -> Member e fn a #

property :: LuaError e => Name -> Text -> (Pusher e b, a -> b) -> (Peeker e b, a -> b -> a) -> Member e fn a #

property' :: LuaError e => Name -> TypeSpec -> Text -> (Pusher e b, a -> b) -> (Peeker e b, a -> b -> a) -> Member e fn a #

pushUDGeneric :: LuaError e => UDTypeGeneric e fn a -> a -> LuaE e () #

readonly :: Name -> Text -> (Pusher e b, a -> b) -> Member e fn a #

readonly' :: Name -> TypeSpec -> Text -> (Pusher e b, a -> b) -> Member e fn a #

udDocs :: UDTypeGeneric e fn a -> TypeDocs #

udTypeSpec :: UDTypeGeneric e fn a -> TypeSpec #

listExtension :: LuaError e => ListSpec e a itemtype -> UDTypeHooks e fn a #

type UDType e fn a = UDTypeGeneric e fn a #

type Alias = [AliasIndex] #

data AliasIndex #

Constructors

StringIndex Name
IntegerIndex Integer

Instances

Instances details

IsString AliasIndex #
Instance details Defined in HsLua.ObjectOrientation.Generic Methods fromString :: String -> AliasIndex
Eq AliasIndex #
Instance details Defined in HsLua.ObjectOrientation.Generic Methods (==) :: AliasIndex -> AliasIndex -> Bool (/=) :: AliasIndex -> AliasIndex -> Bool
Ord AliasIndex #
Instance details Defined in HsLua.ObjectOrientation.Generic Methods compare :: AliasIndex -> AliasIndex -> Ordering (<) :: AliasIndex -> AliasIndex -> Bool (<=) :: AliasIndex -> AliasIndex -> Bool (>) :: AliasIndex -> AliasIndex -> Bool (>=) :: AliasIndex -> AliasIndex -> Bool max :: AliasIndex -> AliasIndex -> AliasIndex min :: AliasIndex -> AliasIndex -> AliasIndex

data Member e fn a #

data Possible a #

Constructors

Actual a
Absent

data Property e a #

Constructors

Property
Fields propertyGet :: a -> LuaE e NumResults propertySet :: Maybe (StackIndex -> a -> LuaE e a) propertyDescription :: Text propertyType :: TypeSpec

data UDTypeGeneric e fn a #

Constructors

UDType
Fields udName :: Name udOperations :: [(Operation, fn)] udProperties :: Map Name (Property e a) udMethods :: Map Name fn udAliases :: Map AliasIndex Alias udHooks :: UDTypeHooks e fn a udFnPusher :: fn -> LuaE e ()

data UDTypeHooks e fn a #

Constructors

UDTypeHooks
Fields hookUservalues :: Int hookMetatableSetup :: LuaE e () hookPeekUD :: a -> StackIndex -> Peek e a hookPushUD :: a -> LuaE e ()

type ListSpec e a itemtype = ((Pusher e itemtype, a -> [itemtype]), (Peeker e itemtype, a -> [itemtype] -> a)) #

type UDTypeWithList e fn a itemtype = UDTypeGeneric e fn a #

data Operation #

Constructors

Add
Sub
Mul
Div
Mod
Pow
Unm
Idiv
Band
Bor
Bxor
Bnot
Shl
Shr
Concat
Len
Eq
Lt
Le
Index
Newindex
Call
Tostring
Pairs
CustomOperation Name

Instances

Instances details

Show Operation #
Instance details Defined in HsLua.ObjectOrientation.Operation Methods showsPrec :: Int -> Operation -> ShowS show :: Operation -> String showList :: [Operation] -> ShowS
Eq Operation #
Instance details Defined in HsLua.ObjectOrientation.Operation Methods (==) :: Operation -> Operation -> Bool (/=) :: Operation -> Operation -> Bool
Ord Operation #
Instance details Defined in HsLua.ObjectOrientation.Operation Methods compare :: Operation -> Operation -> Ordering (<) :: Operation -> Operation -> Bool (<=) :: Operation -> Operation -> Bool (>) :: Operation -> Operation -> Bool (>=) :: Operation -> Operation -> Bool max :: Operation -> Operation -> Operation min :: Operation -> Operation -> Operation

alias :: AliasIndex -> Text -> [AliasIndex] -> Member e fn a #

initType :: LuaError e => UDTypeGeneric e fn a -> LuaE e Name #

possibleProperty :: LuaError e => Name -> Text -> (Pusher e b, a -> Possible b) -> (Peeker e b, a -> b -> Possible a) -> Member e fn a #

possibleProperty' :: LuaError e => Name -> TypeSpec -> Text -> (Pusher e b, a -> Possible b) -> (Peeker e b, a -> b -> Possible a) -> Member e fn a #

property :: LuaError e => Name -> Text -> (Pusher e b, a -> b) -> (Peeker e b, a -> b -> a) -> Member e fn a #

property' :: LuaError e => Name -> TypeSpec -> Text -> (Pusher e b, a -> b) -> (Peeker e b, a -> b -> a) -> Member e fn a #

readonly :: Name -> Text -> (Pusher e b, a -> b) -> Member e fn a #

readonly' :: Name -> TypeSpec -> Text -> (Pusher e b, a -> b) -> Member e fn a #

udDocs :: UDTypeGeneric e fn a -> TypeDocs #

udTypeSpec :: UDTypeGeneric e fn a -> TypeSpec #

boolParam :: Text -> Text -> Parameter e Bool #

boolResult :: Text -> FunctionResults e Bool #

integralParam :: (Read a, Integral a) => Text -> Text -> Parameter e a #

integralResult :: (Integral a, Show a) => Text -> FunctionResults e a #

stringParam :: Text -> Text -> Parameter e String #

stringResult :: Text -> FunctionResults e String #

textParam :: Text -> Text -> Parameter e Text #

textResult :: Text -> FunctionResults e Text #

docsField :: Name #

documentation :: LuaError e => DocumentedFunction e #

getdocumentation :: LuaError e => StackIndex -> LuaE e Type #

pushFieldDoc :: LuaError e => Pusher e (Field e) #

pushFunctionDoc :: LuaError e => Pusher e (DocumentedFunction e) #

pushModuleDoc :: LuaError e => Pusher e (Module e) #

registerDocumentation :: LuaError e => StackIndex -> LuaE e () #

(###) :: (a -> HsFnPrecursor e a) -> a -> HsFnPrecursor e a #

(#?) :: DocumentedFunction e -> Text -> DocumentedFunction e #

(<#>) :: HsFnPrecursor e (a -> b) -> Parameter e a -> HsFnPrecursor e b #

(=#>) :: HsFnPrecursor e (LuaE e a) -> FunctionResults e a -> DocumentedFunction e #

(=?>) :: HsFnPrecursor e (LuaE e NumResults) -> Text -> DocumentedFunction e #

applyParameter :: HsFnPrecursor e (a -> b) -> Parameter e a -> HsFnPrecursor e b #

defun :: Name -> a -> HsFnPrecursor e a #

functionResult :: Pusher e a -> TypeSpec -> Text -> FunctionResults e a #

lambda :: a -> HsFnPrecursor e a #

liftPure :: (a -> b) -> a -> LuaE e b #

liftPure2 :: (a -> b -> c) -> a -> b -> LuaE e c #

liftPure3 :: (a -> b -> c -> d) -> a -> b -> c -> LuaE e d #

liftPure4 :: (a -> b -> c -> d -> e) -> a -> b -> c -> d -> LuaE err e #

liftPure5 :: (a -> b -> c -> d -> e -> f) -> a -> b -> c -> d -> e -> LuaE err f #

opt :: Parameter e a -> Parameter e (Maybe a) #

optionalParameter :: Peeker e a -> TypeSpec -> Text -> Text -> Parameter e (Maybe a) #

parameter :: Peeker e a -> TypeSpec -> Text -> Text -> Parameter e a #

pushDocumentedFunction :: LuaError e => DocumentedFunction e -> LuaE e () #

returnResult :: HsFnPrecursor e (LuaE e a) -> FunctionResult e a -> DocumentedFunction e #

returnResults :: HsFnPrecursor e (LuaE e a) -> FunctionResults e a -> DocumentedFunction e #

returnResultsOnStack :: HsFnPrecursor e (LuaE e NumResults) -> Text -> DocumentedFunction e #

setName :: Name -> DocumentedFunction e -> DocumentedFunction e #

since :: DocumentedFunction e -> Version -> DocumentedFunction e #

toHsFnPrecursor :: StackIndex -> Name -> a -> HsFnPrecursor e a #

updateFunctionDescription :: DocumentedFunction e -> Text -> DocumentedFunction e #

preloadModule :: LuaError e => Module e -> LuaE e () #

preloadModuleWithName :: LuaError e => Module e -> Name -> LuaE e () #

pushModule :: LuaError e => Module e -> LuaE e () #

registerModule :: LuaError e => Module e -> LuaE e () #

deftype :: LuaError e => Name -> [(Operation, DocumentedFunction e)] -> [Member e (DocumentedFunction e) a] -> DocumentedType e a #

deftype' :: LuaError e => Name -> [(Operation, DocumentedFunction e)] -> [Member e (DocumentedFunction e) a] -> Maybe (ListSpec e a itemtype) -> DocumentedTypeWithList e a itemtype #

method :: DocumentedFunction e -> Member e (DocumentedFunction e) a #

operation :: Operation -> DocumentedFunction e -> (Operation, DocumentedFunction e) #

peekUD :: LuaError e => DocumentedTypeWithList e a itemtype -> Peeker e a #

pushUD :: LuaError e => DocumentedTypeWithList e a itemtype -> a -> LuaE e () #

udparam :: LuaError e => DocumentedTypeWithList e a itemtype -> Text -> Text -> Parameter e a #

udresult :: LuaError e => DocumentedTypeWithList e a itemtype -> Text -> FunctionResults e a #

data Member e fn a #

data Possible a #

Constructors

Actual a
Absent

data Property e a #

data Operation #

Constructors

Add
Sub
Mul
Div
Mod
Pow
Unm
Idiv
Band
Bor
Bxor
Bnot
Shl
Shr
Concat
Len
Eq
Lt
Le
Index
Newindex
Call
Tostring
Pairs
CustomOperation Name

Instances

Instances details

Show Operation #
Instance details Defined in HsLua.ObjectOrientation.Operation Methods showsPrec :: Int -> Operation -> ShowS show :: Operation -> String showList :: [Operation] -> ShowS
Eq Operation #
Instance details Defined in HsLua.ObjectOrientation.Operation Methods (==) :: Operation -> Operation -> Bool (/=) :: Operation -> Operation -> Bool
Ord Operation #
Instance details Defined in HsLua.ObjectOrientation.Operation Methods compare :: Operation -> Operation -> Ordering (<) :: Operation -> Operation -> Bool (<=) :: Operation -> Operation -> Bool (>) :: Operation -> Operation -> Bool (>=) :: Operation -> Operation -> Bool max :: Operation -> Operation -> Operation min :: Operation -> Operation -> Operation

data FunctionResult e a #

Constructors

FunctionResult
Fields fnResultPusher :: Pusher e a fnResultDoc :: ResultValueDoc

type FunctionResults e a = [FunctionResult e a] #

data HsFnPrecursor e a #

Instances

Instances details

Functor (HsFnPrecursor e) #
Instance details Defined in HsLua.Packaging.Function Methods fmap :: (a -> b) -> HsFnPrecursor e a -> HsFnPrecursor e b (<$) :: a -> HsFnPrecursor e b -> HsFnPrecursor e a

data Parameter e a #

Constructors

Parameter
Fields parameterPeeker :: Peeker e a parameterDoc :: ParameterDoc

data DocumentedFunction e #

Constructors

DocumentedFunction
Fields callFunction :: LuaE e NumResults functionName :: Name functionDoc :: FunctionDoc

data Field e #

Constructors

Field
Fields fieldName :: Text fieldType :: TypeSpec fieldDescription :: Text fieldPushValue :: LuaE e ()

data FunctionDoc #

Constructors

FunctionDoc
Fields functionDescription :: Text parameterDocs :: [ParameterDoc] functionResultsDocs :: ResultsDoc functionSince :: Maybe Version

Instances

Instances details

Show FunctionDoc #
Instance details Defined in HsLua.Packaging.Types Methods showsPrec :: Int -> FunctionDoc -> ShowS show :: FunctionDoc -> String showList :: [FunctionDoc] -> ShowS
Eq FunctionDoc #
Instance details Defined in HsLua.Packaging.Types Methods (==) :: FunctionDoc -> FunctionDoc -> Bool (/=) :: FunctionDoc -> FunctionDoc -> Bool
Ord FunctionDoc #
Instance details Defined in HsLua.Packaging.Types Methods compare :: FunctionDoc -> FunctionDoc -> Ordering (<) :: FunctionDoc -> FunctionDoc -> Bool (<=) :: FunctionDoc -> FunctionDoc -> Bool (>) :: FunctionDoc -> FunctionDoc -> Bool (>=) :: FunctionDoc -> FunctionDoc -> Bool max :: FunctionDoc -> FunctionDoc -> FunctionDoc min :: FunctionDoc -> FunctionDoc -> FunctionDoc

data Module e #

Constructors

Module
Fields moduleName :: Name moduleDescription :: Text moduleFields :: [Field e] moduleFunctions :: [DocumentedFunction e] moduleOperations :: [(Operation, DocumentedFunction e)] moduleTypeInitializers :: [LuaE e Name]

data ParameterDoc #

Constructors

ParameterDoc
Fields parameterName :: Text parameterType :: TypeSpec parameterDescription :: Text parameterIsOptional :: Bool

Instances

Instances details

Show ParameterDoc #
Instance details Defined in HsLua.Packaging.Types Methods showsPrec :: Int -> ParameterDoc -> ShowS show :: ParameterDoc -> String showList :: [ParameterDoc] -> ShowS
Eq ParameterDoc #
Instance details Defined in HsLua.Packaging.Types Methods (==) :: ParameterDoc -> ParameterDoc -> Bool (/=) :: ParameterDoc -> ParameterDoc -> Bool
Ord ParameterDoc #
Instance details Defined in HsLua.Packaging.Types Methods compare :: ParameterDoc -> ParameterDoc -> Ordering (<) :: ParameterDoc -> ParameterDoc -> Bool (<=) :: ParameterDoc -> ParameterDoc -> Bool (>) :: ParameterDoc -> ParameterDoc -> Bool (>=) :: ParameterDoc -> ParameterDoc -> Bool max :: ParameterDoc -> ParameterDoc -> ParameterDoc min :: ParameterDoc -> ParameterDoc -> ParameterDoc

data ResultValueDoc #

Constructors

ResultValueDoc
Fields resultValueType :: TypeSpec resultValueDescription :: Text

Instances

Instances details

Show ResultValueDoc #
Instance details Defined in HsLua.Packaging.Types Methods showsPrec :: Int -> ResultValueDoc -> ShowS show :: ResultValueDoc -> String showList :: [ResultValueDoc] -> ShowS
Eq ResultValueDoc #
Instance details Defined in HsLua.Packaging.Types Methods (==) :: ResultValueDoc -> ResultValueDoc -> Bool (/=) :: ResultValueDoc -> ResultValueDoc -> Bool
Ord ResultValueDoc #
Instance details Defined in HsLua.Packaging.Types Methods compare :: ResultValueDoc -> ResultValueDoc -> Ordering (<) :: ResultValueDoc -> ResultValueDoc -> Bool (<=) :: ResultValueDoc -> ResultValueDoc -> Bool (>) :: ResultValueDoc -> ResultValueDoc -> Bool (>=) :: ResultValueDoc -> ResultValueDoc -> Bool max :: ResultValueDoc -> ResultValueDoc -> ResultValueDoc min :: ResultValueDoc -> ResultValueDoc -> ResultValueDoc

data ResultsDoc #

Constructors

ResultsDocList [ResultValueDoc]
ResultsDocMult Text

Instances

Instances details

Show ResultsDoc #
Instance details Defined in HsLua.Packaging.Types Methods showsPrec :: Int -> ResultsDoc -> ShowS show :: ResultsDoc -> String showList :: [ResultsDoc] -> ShowS
Eq ResultsDoc #
Instance details Defined in HsLua.Packaging.Types Methods (==) :: ResultsDoc -> ResultsDoc -> Bool (/=) :: ResultsDoc -> ResultsDoc -> Bool
Ord ResultsDoc #
Instance details Defined in HsLua.Packaging.Types Methods compare :: ResultsDoc -> ResultsDoc -> Ordering (<) :: ResultsDoc -> ResultsDoc -> Bool (<=) :: ResultsDoc -> ResultsDoc -> Bool (>) :: ResultsDoc -> ResultsDoc -> Bool (>=) :: ResultsDoc -> ResultsDoc -> Bool max :: ResultsDoc -> ResultsDoc -> ResultsDoc min :: ResultsDoc -> ResultsDoc -> ResultsDoc

type DocumentedType e a = UDType e (DocumentedFunction e) a #

type DocumentedTypeWithList e a itemtype = UDTypeWithList e (DocumentedFunction e) a itemtype #

Type classes

pushAsHaskellFunction :: Exposable e a => a -> LuaE e () #

registerHaskellFunction :: Exposable e a => Name -> a -> LuaE e () #

toHaskellFunction :: Exposable e a => a -> HaskellFunction e #

class LuaError e => Exposable e a where #

Methods

partialApply :: StackIndex -> a -> Peek e NumResults #

Instances

Instances details

LuaError e => Exposable e (HaskellFunction e) #
Instance details Defined in HsLua.Class.Exposable Methods partialApply :: StackIndex -> HaskellFunction e -> Peek e NumResults #
(LuaError e, Pushable a) => Exposable e (LuaE e a) #
Instance details Defined in HsLua.Class.Exposable Methods partialApply :: StackIndex -> LuaE e a -> Peek e NumResults #
(LuaError e, Pushable a) => Exposable e (Peek e a) #
Instance details Defined in HsLua.Class.Exposable Methods partialApply :: StackIndex -> Peek e a -> Peek e NumResults #
(Peekable a, Exposable e b) => Exposable e (a -> b) #
Instance details Defined in HsLua.Class.Exposable Methods partialApply :: StackIndex -> (a -> b) -> Peek e NumResults #

invoke :: Invokable a => Name -> a #

class Invokable a where #

Methods

addArg :: Name -> (forall e. LuaError e => LuaE e ()) -> NumArgs -> a #

Instances

Instances details

(LuaError e, Peekable a) => Invokable (LuaE e a) #
Instance details Defined in HsLua.Class.Invokable Methods addArg :: Name -> (forall e0. LuaError e0 => LuaE e0 ()) -> NumArgs -> LuaE e a #
(Pushable a, Invokable b) => Invokable (a -> b) #
Instance details Defined in HsLua.Class.Invokable Methods addArg :: Name -> (forall e. LuaError e => LuaE e ()) -> NumArgs -> a -> b #

peek :: forall a e. (LuaError e, Peekable a) => StackIndex -> LuaE e a #

class Peekable a where #

Methods

safepeek :: LuaError e => Peeker e a #

Instances

Instances details

Peekable ByteString #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e ByteString #
Peekable ByteString #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e ByteString #
Peekable CFunction #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e CFunction #
Peekable Integer #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e Integer #
Peekable Number #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e Number #
Peekable State #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e State #
Peekable Text #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e Text #
Peekable Integer #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e Integer #
Peekable () #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e () #
Peekable Bool #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e Bool #
Peekable Double #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e Double #
Peekable Float #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e Float #
Peekable Int #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e Int #
(Ord a, Peekable a) => Peekable (Set a) #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e (Set a) #
Peekable (Ptr a) #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e (Ptr a) #
Peekable a => Peekable (Optional a) #
Instance details Defined in HsLua.Class.Util Methods safepeek :: LuaError e => Peeker e (Optional a) #
Peekable [Char] #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e [Char] #
Peekable a => Peekable [a] #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e [a] #
(Ord a, Peekable a, Peekable b) => Peekable (Map a b) #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e (Map a b) #
(Peekable a, Peekable b) => Peekable (a, b) #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e (a, b) #
(Peekable a, Peekable b, Peekable c) => Peekable (a, b, c) #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e (a, b, c) #
(Peekable a, Peekable b, Peekable c, Peekable d) => Peekable (a, b, c, d) #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e (a, b, c, d) #
(Peekable a, Peekable b, Peekable c, Peekable d, Peekable e) => Peekable (a, b, c, d, e) #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e0 => Peeker e0 (a, b, c, d, e) #
(Peekable a, Peekable b, Peekable c, Peekable d, Peekable e, Peekable f) => Peekable (a, b, c, d, e, f) #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e0 => Peeker e0 (a, b, c, d, e, f) #
(Peekable a, Peekable b, Peekable c, Peekable d, Peekable e, Peekable f, Peekable g) => Peekable (a, b, c, d, e, f, g) #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e0 => Peeker e0 (a, b, c, d, e, f, g) #
(Peekable a, Peekable b, Peekable c, Peekable d, Peekable e, Peekable f, Peekable g, Peekable h) => Peekable (a, b, c, d, e, f, g, h) #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e0 => Peeker e0 (a, b, c, d, e, f, g, h) #

class Pushable a where #

Methods

push :: LuaError e => a -> LuaE e () #

Instances

Instances details

Pushable ByteString #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e => ByteString -> LuaE e () #
Pushable ByteString #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e => ByteString -> LuaE e () #
Pushable CFunction #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e => CFunction -> LuaE e () #
Pushable Integer #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e => Integer -> LuaE e () #
Pushable Number #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e => Number -> LuaE e () #
Pushable Text #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e => Text -> LuaE e () #
Pushable Integer #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e => Integer -> LuaE e () #
Pushable () #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e => () -> LuaE e () #
Pushable Bool #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e => Bool -> LuaE e () #
Pushable Double #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e => Double -> LuaE e () #
Pushable Float #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e => Float -> LuaE e () #
Pushable Int #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e => Int -> LuaE e () #
Pushable a => Pushable (Set a) #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e => Set a -> LuaE e () #
Pushable (Ptr a) #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e => Ptr a -> LuaE e () #
Pushable a => Pushable (Optional a) #
Instance details Defined in HsLua.Class.Util Methods push :: LuaError e => Optional a -> LuaE e () #
Pushable [Char] #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e => [Char] -> LuaE e () #
Pushable a => Pushable [a] #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e => [a] -> LuaE e () #
(Pushable a, Pushable b) => Pushable (Map a b) #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e => Map a b -> LuaE e () #
(Pushable a, Pushable b) => Pushable (a, b) #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e => (a, b) -> LuaE e () #
(Pushable a, Pushable b, Pushable c) => Pushable (a, b, c) #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e => (a, b, c) -> LuaE e () #
(Pushable a, Pushable b, Pushable c, Pushable d) => Pushable (a, b, c, d) #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e => (a, b, c, d) -> LuaE e () #
(Pushable a, Pushable b, Pushable c, Pushable d, Pushable e) => Pushable (a, b, c, d, e) #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e0 => (a, b, c, d, e) -> LuaE e0 () #
(Pushable a, Pushable b, Pushable c, Pushable d, Pushable e, Pushable f) => Pushable (a, b, c, d, e, f) #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e0 => (a, b, c, d, e, f) -> LuaE e0 () #
(Pushable a, Pushable b, Pushable c, Pushable d, Pushable e, Pushable f, Pushable g) => Pushable (a, b, c, d, e, f, g) #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e0 => (a, b, c, d, e, f, g) -> LuaE e0 () #
(Pushable a, Pushable b, Pushable c, Pushable d, Pushable e, Pushable f, Pushable g, Pushable h) => Pushable (a, b, c, d, e, f, g, h) #
Instance details Defined in HsLua.Class.Pushable Methods push :: LuaError e0 => (a, b, c, d, e, f, g, h) -> LuaE e0 () #

Marshal to and from JSON-like structures

jsonarray :: Name #

peekToAeson :: Peeker e (ToAeson e) #

peekValue :: LuaError e => Peeker e Value #

peekViaJSON :: (FromJSON a, LuaError e) => Peeker e a #

pushToAeson :: Pusher e (ToAeson e) #

pushValue :: LuaError e => Pusher e Value #

pushViaJSON :: (ToJSON a, LuaError e) => Pusher e a #

Utility functions

getglobal' :: LuaError e => Name -> LuaE e () Source #

Like getglobal, but knows about packages and nested tables. E.g.

getglobal' "math.sin"

will return the function sin in package math.

setglobal' :: LuaError e => Name -> LuaE e () Source #

Like setglobal, but knows about packages and nested tables. E.g.

pushstring "0.9.4"
setglobal' "mypackage.version"

All tables and fields, except for the last field, must exist.

peekEither :: (LuaError e, Peekable a) => StackIndex -> LuaE e (Either e a) #

popValue :: (LuaError e, Peekable a) => LuaE e a #

raiseError :: (LuaError e, Pushable a) => a -> LuaE e NumResults #

newtype Optional a #

Constructors

Optional
Fields fromOptional :: Maybe a

Instances

Instances details

Peekable a => Peekable (Optional a) #
Instance details Defined in HsLua.Class.Util Methods safepeek :: LuaError e => Peeker e (Optional a) #
Pushable a => Pushable (Optional a) #
Instance details Defined in HsLua.Class.Util Methods push :: LuaError e => Optional a -> LuaE e () #