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


-- | A collection of helpers for ffi.
--   
--   Please see the README on Github at
--   <a>https://github.com/4eUeP/foreign#readme</a>
@package foreign
@version 0.1.0.0

module HsForeign.Primitive
newtype BA# a
BA# :: ByteArray# -> BA# a
newtype MBA# a
MBA# :: MutableByteArray# RealWorld -> MBA# a
newtype BAArray# a
BAArray# :: ArrayArray# -> BAArray# a

-- | Create an one element primitive array and use it as a pointer to the
--   primitive element.
--   
--   Don't pass a forever loop to this function, see <a>#14346</a>.
withPrim :: forall a b. Prim a => a -> (Ptr a -> IO b) -> IO (a, b)

-- | like <a>withPrim</a>, but don't write initial value.
allocPrim :: forall a b. Prim a => (Ptr a -> IO b) -> IO (a, b)

-- | Create an one element primitive array and use it as a pointer to the
--   primitive element.
--   
--   Return the element and the computation result.
--   
--   USE THIS FUNCTION WITH UNSAFE SYNC FFI CALL ONLY.
withPrimUnsafe :: Prim a => a -> (MBA# a -> IO b) -> IO (a, b)

-- | like <a>withPrimUnsafe</a>, but don't write initial value.
--   
--   USE THIS FUNCTION WITH UNSAFE SYNC FFI CALL ONLY.
allocPrimUnsafe :: Prim a => (MBA# a -> IO b) -> IO (a, b)

-- | Pass primitive array to safe FFI as pointer.
--   
--   Use proper pointer type and <tt>HsInt</tt> to marshall <tt>Ptr a</tt>
--   and <tt>Int</tt> arguments on C side. The memory pointed by 'Ptr a'
--   will not moved during call. After call returned, pointer is no longer
--   valid.
--   
--   The second <a>Int</a> arguement is the element size not the bytes
--   size.
--   
--   Don't pass a forever loop to this function, see <a>#14346</a>.
withPrimArray :: Prim a => PrimArray a -> (Ptr a -> Int -> IO b) -> IO b

-- | Allocate a prim array and pass to FFI as pointer, freeze result into a
--   <tt>PrimVector</tt>.
allocPrimArray :: forall a b. Prim a => Int -> (Ptr a -> IO b) -> IO (PrimArray a, b)

-- | Pass primitive array to unsafe FFI as pointer.
--   
--   Enable <tt>UnliftedFFITypes</tt> extension in your haskell code, use
--   proper pointer type and <tt>HsInt</tt> to marshall <tt>ByteArray#</tt>
--   and <tt>Int</tt> arguments on C side.
--   
--   The second <a>Int</a> arguement is the element size not the bytes
--   size.
--   
--   USE THIS FUNCTION WITH UNSAFE SYNC FFI CALL ONLY.
withPrimArrayUnsafe :: Prim a => PrimArray a -> (BA# a -> Int -> IO b) -> IO b

-- | Allocate some bytes and pass to FFI as pointer, freeze result into a
--   <a>PrimArray</a>.
--   
--   USE THIS FUNCTION WITH UNSAFE SYNC FFI CALL ONLY.
allocPrimArrayUnsafe :: forall a b. Prim a => Int -> (MBA# a -> IO b) -> IO (PrimArray a, b)

-- | Pass primitive array list to safe FFI as pointer.
--   
--   Use proper pointer type and <tt>HsInt</tt> to marshall <tt>Ptr (Ptr
--   a)</tt> and <tt>Int</tt> arguments on C side. The memory pointed by
--   'Ptr a' will not moved during call. After call returned, pointer is no
--   longer valid.
--   
--   The second <a>Int</a> arguement is the list size.
--   
--   Don't pass a forever loop to this function, see <a>#14346</a>.
withPrimArrayList :: Prim a => [PrimArray a] -> (Ptr (Ptr a) -> Int -> IO b) -> IO b

-- | Pass primitive array list to unsafe FFI as <tt>StgArrBytes**</tt>.
--   
--   Enable <tt>UnliftedFFITypes</tt> extension in your haskell code, use
--   <tt>StgArrBytes**</tt>(&gt;=8.10) or <tt>StgMutArrPtrs*</tt>(&lt;8.10)
--   pointer type and <tt>HsInt</tt> to marshall <tt>BAArray#</tt> and
--   <tt>Int</tt> arguments on C side.
--   
--   The second <a>Int</a> arguement is the list size.
--   
--   USE THIS FUNCTION WITH UNSAFE FFI CALL ONLY.
withPrimArrayListUnsafe :: [PrimArray a] -> (BAArray# a -> Int -> IO b) -> IO b
withForeignPtrList :: [ForeignPtr a] -> (Ptr (Ptr a) -> Int -> IO b) -> IO b

-- | Obtain the pointer to the content of an mutable array, and the pointer
--   should only be used during the IO action.
--   
--   This operation is only safe on <i>pinned</i> primitive arrays (Arrays
--   allocated by <a>newPinnedPrimArray</a> or
--   <a>newAlignedPinnedPrimArray</a>).
--   
--   Don't pass a forever loop to this function, see <a>#14346</a>.
withMutablePrimArrayContents :: MutablePrimArray RealWorld a -> (Ptr a -> IO b) -> IO b

-- | Obtain the pointer to the content of an array, and the pointer should
--   only be used during the IO action.
--   
--   This operation is only safe on <i>pinned</i> primitive arrays (Arrays
--   allocated by <a>newPinnedPrimArray</a> or
--   <a>newAlignedPinnedPrimArray</a>).
--   
--   Don't pass a forever loop to this function, see <a>#14346</a>.
withPrimArrayContents :: PrimArray a -> (Ptr a -> IO b) -> IO b

-- | Intended for use with pinned arrays; otherwise very unsafe!
byteArrayContents# :: ByteArray# -> Addr#
mutableByteArrayContents# :: MutableByteArray# s -> Addr#

module HsForeign.AsyncFFI
withAsyncFFI :: Int -> (Ptr a -> IO a) -> (StablePtr PrimMVar -> Int -> Ptr a -> IO b) -> IO a
withAsyncFFI' :: [MutableByteArray RealWorld] -> Int -> (Ptr a -> IO a) -> (StablePtr PrimMVar -> Int -> Ptr a -> IO b) -> IO a
withPrimAsyncFFI :: Prim a => (StablePtr PrimMVar -> Int -> Ptr a -> IO b) -> IO a

module HsForeign