-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Extism bindings
--   
--   Bindings to Extism, the universal plugin system
@package extism
@version 0.5.0

module Extism

-- | Result type
type Result a = Either Error a

-- | Extism error
newtype Error
ExtismError :: String -> Error

-- | Access the plugin that is currently executing from inside a host
--   function
type CurrentPlugin = Ptr ExtismCurrentPlugin

-- | Context for managing plugins
newtype Context
Context :: ForeignPtr ExtismContext -> Context

-- | Host function
data Function
Function :: ForeignPtr ExtismFunction -> StablePtr () -> Function

-- | Plugins can be used to call WASM function
data Plugin
Plugin :: Context -> Int32 -> [Function] -> Plugin

-- | Cancellation handle for Plugins
newtype CancelHandle
CancelHandle :: Ptr ExtismCancelHandle -> CancelHandle

-- | Log level
data LogLevel
Error :: LogLevel
Warn :: LogLevel
Info :: LogLevel
Debug :: LogLevel
Trace :: LogLevel

-- | Free a <a>Plugin</a>, this will automatically be called for every
--   plugin | associated with a <a>Context</a> when that <a>Context</a> is
--   freed
free :: Plugin -> IO ()

-- | Remove all registered plugins in a <a>Context</a>
reset :: Context -> IO ()

-- | Helper function to convert a <a>ByteString</a> to a <a>String</a>
fromByteString :: ByteString -> String

-- | Update a <a>Plugin</a> with a new WASM module
update :: Plugin -> ByteString -> [Function] -> Bool -> IO (Result Plugin)

-- | Check if a <a>Plugin</a> is valid
isValid :: Plugin -> Bool

-- | Create a <a>Plugin</a> from a WASM module, <tt>useWasi</tt> determines
--   if WASI should | be linked
plugin :: Context -> ByteString -> [Function] -> Bool -> IO (Result Plugin)

-- | Helper function to convert a <a>String</a> to a <a>ByteString</a>
toByteString :: String -> ByteString

-- | Get the Extism version string
extismVersion :: () -> IO String

-- | Create a new <a>Context</a>
newContext :: IO Context

-- | Execute a function with a new <a>Context</a> that is destroyed when it
--   returns
withContext :: (Context -> IO a) -> IO a

-- | Execute a function with the provided <a>Plugin</a> as a parameter,
--   then frees the <a>Plugin</a> | before returning the result.
withPlugin :: (Plugin -> IO a) -> Plugin -> IO a

-- | Create a <a>Plugin</a> with its own <a>Context</a>
createPlugin :: ByteString -> [Function] -> Bool -> IO (Result Plugin)

-- | Create a <a>Plugin</a> from a <a>Manifest</a>
pluginFromManifest :: Context -> Manifest -> [Function] -> Bool -> IO (Result Plugin)

-- | Create a <a>Plugin</a> with its own <a>Context</a> from a
--   <a>Manifest</a>
createPluginFromManifest :: Manifest -> [Function] -> Bool -> IO (Result Plugin)

-- | Update a <a>Plugin</a> with a new <a>Manifest</a>
updateManifest :: Plugin -> Manifest -> [Function] -> Bool -> IO (Result Plugin)

-- | Set configuration values for a plugin
setConfig :: Plugin -> [(String, Maybe String)] -> IO Bool
levelStr :: LogLevel -> String

-- | Set the log file and level, this is a global configuration
setLogFile :: String -> LogLevel -> IO Bool

-- | Check if a function exists in the given plugin
functionExists :: Plugin -> String -> IO Bool
call :: Plugin -> String -> ByteString -> IO (Result ByteString)

-- | Create a new <a>CancelHandle</a> that can be used to cancel a running
--   plugin | from another thread.
cancelHandle :: Plugin -> IO CancelHandle

-- | Cancel a running plugin using a <a>CancelHandle</a>
cancel :: CancelHandle -> IO Bool

-- | Create a new <a>Function</a> that can be called from a <a>Plugin</a>
hostFunction :: String -> [ValType] -> [ValType] -> (CurrentPlugin -> [Val] -> a -> IO [Val]) -> a -> IO Function

-- | Create a new I32 <a>Val</a>
toI32 :: Integral a => a -> Val

-- | Create a new I64 <a>Val</a>
toI64 :: Integral a => a -> Val

-- | Create a new F32 <a>Val</a>
toF32 :: Float -> Val

-- | Create a new F64 <a>Val</a>
toF64 :: Double -> Val

-- | Get I32 <a>Val</a>
fromI32 :: Integral a => Val -> Maybe a

-- | Get I64 <a>Val</a>
fromI64 :: Integral a => Val -> Maybe a

-- | Get F32 <a>Val</a>
fromF32 :: Val -> Maybe Float

-- | Get F64 <a>Val</a>
fromF64 :: Val -> Maybe Double
data () => Manifest
toString :: JSON a => a -> String
data ValType
I32 :: ValType
I64 :: ValType
F32 :: ValType
F64 :: ValType
V128 :: ValType
FuncRef :: ValType
ExternRef :: ValType
data Val
ValI32 :: Int32 -> Val
ValI64 :: Int64 -> Val
ValF32 :: Float -> Val
ValF64 :: Double -> Val
instance GHC.Show.Show Extism.LogLevel
instance GHC.Show.Show Extism.Error

module Extism.CurrentPlugin

-- | Allocate a new handle of the given size
memoryAlloc :: CurrentPlugin -> Word64 -> IO Word64

-- | Get the length of a handle, returns 0 if the handle is invalid
memoryLength :: CurrentPlugin -> Word64 -> IO Word64

-- | Free allocated memory
memoryFree :: CurrentPlugin -> Word64 -> IO ()

-- | Access a pointer to the entire memory region
memory :: CurrentPlugin -> IO (Ptr Word8)

-- | Access a pointer the a specific offset in memory
memoryOffset :: CurrentPlugin -> Word64 -> IO (Ptr Word8)

-- | Access the data associated with a handle as a <a>ByteString</a>
memoryBytes :: CurrentPlugin -> Word64 -> IO ByteString

-- | Allocate memory and copy an existing <a>ByteString</a> into it
allocBytes :: CurrentPlugin -> ByteString -> IO Word64