-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | A simple and high performance IO toolkit for Haskell
--
-- This package provides a simple and high performance IO toolkit for
-- Haskell, including packed vectors, unicode texts, socket, file system,
-- timers and more!
@package stdio
@version 0.1.1.0
module Std.Data.Builder.Numeric.DigitTable
decDigitTable :: Addr
hexDigitTable :: Addr
hexDigitTableUpper :: Addr
-- | This module implement some bit twiddling with ghc primitives.
--
-- We currently didn't use all functions from this module though: the
-- performance is not catching up c version yet. But this module and
-- relevant benchmarks are kept in hope that once we have fully SIMD
-- support in GHC, we might optimize these functions further to compete
-- with c.
--
-- Reference:
--
--
module Std.Data.PrimArray.BitTwiddle
isOffsetAligned# :: Int# -> Bool
mkMask# :: Word# -> Word#
nullByteMagic# :: Word# -> Word#
-- | Search a word8 in array.
--
-- Currently this function is ~4 times slow than c version, so we didn't
-- use it.
memchr :: PrimArray Word8 -> Word8 -> Int -> Int -> Int
-- | The unboxed version of memchr
memchr# :: ByteArray# -> Word# -> Int# -> Int# -> Int#
-- | Search a word8 array in reverse order.
--
-- This function is used in elemIndexEnd, since there's no c
-- equivalent.
memchrReverse :: PrimArray Word8 -> Word8 -> Int -> Int -> Int
-- | The unboxed version of memchrReverse
memchrReverse# :: ByteArray# -> Word# -> Int# -> Int# -> Int#
c_memchr :: ByteArray# -> Int -> Word8 -> Int -> Int
-- | This module is borrowed from basement's Cast module with conditional
-- instances removed. The purpose of Cast is to provide primitive
-- types which share the same byte size, so that arrays and vectors
-- parameterized by them can be safely coerced without breaking the index
-- bounds. You can also use it to directly cast primitives just like
-- reinterpret_cast. A Coercible based instance is also
-- provide for convenience.
module Std.Data.PrimArray.Cast
-- | Cast between primitive types of the same size.
class Cast source destination
cast :: Cast source destination => source -> destination
instance GHC.Types.Coercible a b => Std.Data.PrimArray.Cast.Cast a b
instance Std.Data.PrimArray.Cast.Cast GHC.Int.Int8 GHC.Word.Word8
instance Std.Data.PrimArray.Cast.Cast GHC.Int.Int16 GHC.Word.Word16
instance Std.Data.PrimArray.Cast.Cast GHC.Int.Int32 GHC.Word.Word32
instance Std.Data.PrimArray.Cast.Cast GHC.Int.Int64 GHC.Word.Word64
instance Std.Data.PrimArray.Cast.Cast GHC.Types.Int GHC.Types.Word
instance Std.Data.PrimArray.Cast.Cast GHC.Word.Word8 GHC.Int.Int8
instance Std.Data.PrimArray.Cast.Cast GHC.Word.Word16 GHC.Int.Int16
instance Std.Data.PrimArray.Cast.Cast GHC.Word.Word32 GHC.Int.Int32
instance Std.Data.PrimArray.Cast.Cast GHC.Word.Word64 GHC.Int.Int64
instance Std.Data.PrimArray.Cast.Cast GHC.Types.Word GHC.Types.Int
instance Std.Data.PrimArray.Cast.Cast GHC.Word.Word64 GHC.Types.Double
instance Std.Data.PrimArray.Cast.Cast GHC.Word.Word32 GHC.Types.Float
instance Std.Data.PrimArray.Cast.Cast GHC.Types.Double GHC.Word.Word64
instance Std.Data.PrimArray.Cast.Cast GHC.Types.Float GHC.Word.Word32
instance Std.Data.PrimArray.Cast.Cast GHC.Int.Int64 GHC.Types.Double
instance Std.Data.PrimArray.Cast.Cast GHC.Int.Int32 GHC.Types.Float
instance Std.Data.PrimArray.Cast.Cast GHC.Types.Double GHC.Int.Int64
instance Std.Data.PrimArray.Cast.Cast GHC.Types.Float GHC.Int.Int32
-- | Unified unboxed and boxed array operations using functional
-- dependencies.
--
-- All operations are NOT bound checked, if you need checked operations
-- please use Std.Data.Array.Checked. It exports exactly same APIs
-- so that you can switch between without pain.
--
-- Some mnemonics:
--
--
module Std.Data.Array
-- | A typeclass to unify box & unboxed, mutable & immutable array
-- operations.
--
-- Most of these functions simply wrap their primitive counterpart, if
-- there's no primitive ones, we polyfilled using other operations to get
-- the same semantics.
--
-- One exception is that shrinkMutableArr only perform closure
-- resizing on PrimArray because current RTS support only that,
-- shrinkMutableArr will do nothing on other array type.
--
-- It's reasonable to trust GHC with specializing & inlining these
-- polymorphric functions. They are used across this package and perform
-- identical to their monomophric counterpart.
class Arr (marr :: * -> * -> *) (arr :: * -> *) a | arr -> marr, marr -> arr
-- | Make a new array with given size.
--
-- For boxed array, all elements are uninitialized which shall not
-- be accessed. For primitive array, elements are just random garbage.
newArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s) => Int -> m (marr s a)
-- | Make a new array and fill it with an initial value.
newArrWith :: (Arr marr arr a, PrimMonad m, PrimState m ~ s) => Int -> a -> m (marr s a)
-- | Index mutable array in a primitive monad.
readArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s) => marr s a -> Int -> m a
-- | Write mutable array in a primitive monad.
writeArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s) => marr s a -> Int -> a -> m ()
-- | Fill mutable array with a given value.
setArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s) => marr s a -> Int -> Int -> a -> m ()
-- | Index immutable array, which is a pure operation. This operation often
-- result in an indexing thunk for lifted arrays, use 'indexArr\'' or
-- indexArrM if that's not desired.
indexArr :: Arr marr arr a => arr a -> Int -> a
-- | Index immutable array, pattern match on the unboxed unit tuple to
-- force indexing (without forcing the element).
indexArr' :: Arr marr arr a => arr a -> Int -> (# a #)
-- | Index immutable array in a primitive monad, this helps in situations
-- that you want your indexing result is not a thunk referencing whole
-- array.
indexArrM :: (Arr marr arr a, Monad m) => arr a -> Int -> m a
-- | Safely freeze mutable array by make a immutable copy of its slice.
freezeArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s) => marr s a -> Int -> Int -> m (arr a)
-- | Safely thaw immutable array by make a mutable copy of its slice.
thawArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s) => arr a -> Int -> Int -> m (marr s a)
-- | In place freeze a mutable array, the original mutable array can not be
-- used anymore.
unsafeFreezeArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s) => marr s a -> m (arr a)
-- | In place thaw a immutable array, the original immutable array can not
-- be used anymore.
unsafeThawArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s) => arr a -> m (marr s a)
-- | Copy a slice of immutable array to mutable array at given offset.
copyArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s) => marr s a -> Int -> arr a -> Int -> Int -> m ()
-- | Copy a slice of mutable array to mutable array at given offset. The
-- two mutable arrays shall no be the same one.
copyMutableArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s) => marr s a -> Int -> marr s a -> Int -> Int -> m ()
-- | Copy a slice of mutable array to mutable array at given offset. The
-- two mutable arrays may be the same one.
moveArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s) => marr s a -> Int -> marr s a -> Int -> Int -> m ()
-- | Create immutable copy.
cloneArr :: Arr marr arr a => arr a -> Int -> Int -> arr a
-- | Create mutable copy.
cloneMutableArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s) => marr s a -> Int -> Int -> m (marr s a)
-- | Resize mutable array to given size.
resizeMutableArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s) => marr s a -> Int -> m (marr s a)
-- | Shrink mutable array to given size. This operation only works on
-- primitive arrays. For boxed array, this is a no-op, e.g.
-- sizeOfMutableArr will not change.
shrinkMutableArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s) => marr s a -> Int -> m ()
-- | Is two mutable array are reference equal.
sameMutableArr :: Arr marr arr a => marr s a -> marr s a -> Bool
-- | Size of immutable array.
sizeofArr :: Arr marr arr a => arr a -> Int
-- | Size of mutable array.
sizeofMutableArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s) => marr s a -> m Int
-- | Is two immutable array are referencing the same one.
--
-- Note that sameArr 's result may change depending on compiler's
-- optimizations, for example let arr = runST ... in arr
-- sameArr arr may return false if compiler decides to inline
-- it.
--
-- See https://ghc.haskell.org/trac/ghc/ticket/13908 for more
-- background.
sameArr :: Arr marr arr a => arr a -> arr a -> Bool
-- | RealWorld is deeply magical. It is primitive, but it
-- is not unlifted (hence ptrArg). We never manipulate
-- values of type RealWorld; it's only used in the type system,
-- to parameterise State#.
data RealWorld :: Type
data Array a
Array :: Array# a -> Array a
[array#] :: Array a -> Array# a
data MutableArray s a
MutableArray :: MutableArray# s a -> MutableArray s a
[marray#] :: MutableArray s a -> MutableArray# s a
data SmallArray a
SmallArray :: SmallArray# a -> SmallArray a
data SmallMutableArray s a
SmallMutableArray :: SmallMutableArray# s a -> SmallMutableArray s a
-- | Bottom value (throw (UndefinedElement
-- "Data.Array.uninitialized")) for initialize new boxed
-- array(Array, SmallArray..).
--
-- NOTE: These functions may segfault when used with indices which are
-- out of bounds.
uninitialized :: a
data PrimArray a
PrimArray :: ByteArray# -> PrimArray a
data MutablePrimArray s a
MutablePrimArray :: MutableByteArray# s -> MutablePrimArray s a
class Prim a
sizeOf# :: Prim a => a -> Int#
alignment# :: Prim a => a -> Int#
indexByteArray# :: Prim a => ByteArray# -> Int# -> a
readByteArray# :: Prim a => MutableByteArray# s -> Int# -> State# s -> (# State# s, a #)
writeByteArray# :: Prim a => MutableByteArray# s -> Int# -> a -> State# s -> State# s
setByteArray# :: Prim a => MutableByteArray# s -> Int# -> Int# -> a -> State# s -> State# s
indexOffAddr# :: Prim a => Addr# -> Int# -> a
readOffAddr# :: Prim a => Addr# -> Int# -> State# s -> (# State# s, a #)
writeOffAddr# :: Prim a => Addr# -> Int# -> a -> State# s -> State# s
setOffAddr# :: Prim a => Addr# -> Int# -> Int# -> a -> State# s -> State# s
-- | Create a pinned byte array of the specified size, The garbage
-- collector is guaranteed not to move it.
newPinnedPrimArray :: forall m a. (PrimMonad m, Prim a) => Int -> m (MutablePrimArray (PrimState m) a)
-- | Create a pinned primitive array of the specified size and
-- respect given primitive type's alignment. The garbage collector is
-- guaranteed not to move it.
newAlignedPinnedPrimArray :: forall m a. (PrimMonad m, Prim a) => Int -> m (MutablePrimArray (PrimState m) a)
copyPrimArrayToPtr :: (PrimMonad m, Prim a) => Ptr a -> PrimArray a -> Int -> Int -> m ()
copyMutablePrimArrayToPtr :: (PrimMonad m, Prim a) => Ptr a -> MutablePrimArray (PrimState m) a -> Int -> Int -> m ()
copyPtrToMutablePrimArray :: (PrimMonad m, Prim a) => MutablePrimArray (PrimState m) a -> Int -> Ptr a -> Int -> m ()
-- | Yield a pointer to the array's data.
--
-- This operation is only safe on pinned primitive arrays
-- allocated by newPinnedPrimArray or
-- newAlignedPinnedPrimArray, and you have to make sure the
-- PrimArray can outlive the Ptr.
primArrayContents :: PrimArray a -> Ptr a
-- | Yield a pointer to the array's data.
--
-- This operation is only safe on pinned primitive arrays
-- allocated by newPinnedPrimArray or
-- newAlignedPinnedPrimArray. and you have to make sure the
-- PrimArray can outlive the Ptr.
mutablePrimArrayContents :: MutablePrimArray s a -> Ptr a
-- | Yield a pointer to the array's data and do computation with it.
--
-- This operation is only safe on pinned primitive arrays
-- allocated by newPinnedPrimArray or
-- newAlignedPinnedPrimArray.
--
-- Don't pass a forever loop to this function, see #14346.
withPrimArrayContents :: PrimArray a -> (Ptr a -> IO b) -> IO b
-- | Yield a pointer to the array's data and do computation with it.
--
-- This operation is only safe on pinned primitive arrays
-- allocated by newPinnedPrimArray or
-- newAlignedPinnedPrimArray.
--
-- Don't pass a forever loop to this function, see #14346.
withMutablePrimArrayContents :: MutablePrimArray RealWorld a -> (Ptr a -> IO b) -> IO b
-- | Check if a primitive array is pinned.
isPrimArrayPinned :: PrimArray a -> Bool
-- | Check if a mutable primitive array is pinned.
isMutablePrimArrayPinned :: MutablePrimArray s a -> Bool
data UnliftedArray e
UnliftedArray :: ArrayArray# -> UnliftedArray e
data MutableUnliftedArray s e
MutableUnliftedArray :: MutableArrayArray# s -> MutableUnliftedArray s e
class PrimUnlifted a
toArrayArray# :: PrimUnlifted a => a -> ArrayArray#
fromArrayArray# :: PrimUnlifted a => ArrayArray# -> a
-- | Exceptions generated by array operations
data ArrayException
-- | An attempt was made to index an array outside its declared bounds.
IndexOutOfBounds :: String -> ArrayException
-- | An attempt was made to evaluate an element of an array that had not
-- been initialized.
UndefinedElement :: String -> ArrayException
-- | Cast between arrays
castArray :: (Arr marr arr a, Cast a b) => arr a -> arr b
castMutableArray :: (Arr marr arr a, Cast a b) => marr s a -> marr s b
instance Std.Data.Array.Arr Data.Primitive.Array.MutableArray Data.Primitive.Array.Array a
instance Std.Data.Array.Arr Data.Primitive.SmallArray.SmallMutableArray Data.Primitive.SmallArray.SmallArray a
instance Data.Primitive.Types.Prim a => Std.Data.Array.Arr Data.Primitive.PrimArray.MutablePrimArray Data.Primitive.PrimArray.PrimArray a
instance Data.Primitive.UnliftedArray.PrimUnlifted a => Std.Data.Array.Arr Data.Primitive.UnliftedArray.MutableUnliftedArray Data.Primitive.UnliftedArray.UnliftedArray a
-- | This module provides exactly the same API with Std.Data.Array,
-- but will throw an IndexOutOfBounds ArrayException on
-- bound check failure, it's useful when debugging array algorithms: just
-- swap this module with Std.Data.Array, segmentation faults
-- caused by out bound access will be turned into exceptions with more
-- informations.
module Std.Data.Array.Checked
-- | A typeclass to unify box & unboxed, mutable & immutable array
-- operations.
--
-- Most of these functions simply wrap their primitive counterpart, if
-- there's no primitive ones, we polyfilled using other operations to get
-- the same semantics.
--
-- One exception is that shrinkMutableArr only perform closure
-- resizing on PrimArray because current RTS support only that,
-- shrinkMutableArr will do nothing on other array type.
--
-- It's reasonable to trust GHC with specializing & inlining these
-- polymorphric functions. They are used across this package and perform
-- identical to their monomophric counterpart.
class Arr (marr :: * -> * -> *) (arr :: * -> *) a | arr -> marr, marr -> arr
-- | RealWorld is deeply magical. It is primitive, but it
-- is not unlifted (hence ptrArg). We never manipulate
-- values of type RealWorld; it's only used in the type system,
-- to parameterise State#.
data RealWorld :: Type
newArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => Int -> m (marr s a)
newArrWith :: (Arr marr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => Int -> a -> m (marr s a)
readArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => marr s a -> Int -> m a
writeArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => marr s a -> Int -> a -> m ()
setArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => marr s a -> Int -> Int -> a -> m ()
indexArr :: (Arr marr arr a, HasCallStack) => arr a -> Int -> a
indexArr' :: (Arr marr arr a, HasCallStack) => arr a -> Int -> (# a #)
indexArrM :: (Arr marr arr a, Monad m, HasCallStack) => arr a -> Int -> m a
freezeArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => marr s a -> Int -> Int -> m (arr a)
thawArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => arr a -> Int -> Int -> m (marr s a)
copyArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => marr s a -> Int -> arr a -> Int -> Int -> m ()
copyMutableArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => marr s a -> Int -> marr s a -> Int -> Int -> m ()
moveArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => marr s a -> Int -> marr s a -> Int -> Int -> m ()
cloneArr :: (Arr marr arr a, HasCallStack) => arr a -> Int -> Int -> arr a
cloneMutableArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => marr s a -> Int -> Int -> m (marr s a)
resizeMutableArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => marr s a -> Int -> m (marr s a)
-- | New size should be >= 0, and <= original size.
shrinkMutableArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => marr s a -> Int -> m ()
-- | In place freeze a mutable array, the original mutable array can not be
-- used anymore.
unsafeFreezeArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s) => marr s a -> m (arr a)
-- | In place thaw a immutable array, the original immutable array can not
-- be used anymore.
unsafeThawArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s) => arr a -> m (marr s a)
-- | Is two mutable array are reference equal.
sameMutableArr :: Arr marr arr a => marr s a -> marr s a -> Bool
-- | Size of immutable array.
sizeofArr :: Arr marr arr a => arr a -> Int
-- | Size of mutable array.
sizeofMutableArr :: (Arr marr arr a, PrimMonad m, PrimState m ~ s) => marr s a -> m Int
-- | Is two immutable array are referencing the same one.
--
-- Note that sameArr 's result may change depending on compiler's
-- optimizations, for example let arr = runST ... in arr
-- sameArr arr may return false if compiler decides to inline
-- it.
--
-- See https://ghc.haskell.org/trac/ghc/ticket/13908 for more
-- background.
sameArr :: Arr marr arr a => arr a -> arr a -> Bool
data Array a
Array :: Array# a -> Array a
[array#] :: Array a -> Array# a
data MutableArray s a
MutableArray :: MutableArray# s a -> MutableArray s a
[marray#] :: MutableArray s a -> MutableArray# s a
data SmallArray a
SmallArray :: SmallArray# a -> SmallArray a
data SmallMutableArray s a
SmallMutableArray :: SmallMutableArray# s a -> SmallMutableArray s a
-- | Bottom value (throw (UndefinedElement
-- "Data.Array.uninitialized")) for initialize new boxed
-- array(Array, SmallArray..).
--
-- NOTE: These functions may segfault when used with indices which are
-- out of bounds.
uninitialized :: a
data PrimArray a
PrimArray :: ByteArray# -> PrimArray a
data MutablePrimArray s a
MutablePrimArray :: MutableByteArray# s -> MutablePrimArray s a
-- | Create a pinned byte array of the specified size, The garbage
-- collector is guaranteed not to move it.
newPinnedPrimArray :: (PrimMonad m, Prim a, HasCallStack) => Int -> m (MutablePrimArray (PrimState m) a)
-- | Create a pinned primitive array of the specified size and
-- respect given primitive type's alignment. The garbage collector is
-- guaranteed not to move it.
newAlignedPinnedPrimArray :: (PrimMonad m, Prim a, HasCallStack) => Int -> m (MutablePrimArray (PrimState m) a)
copyPrimArrayToPtr :: (PrimMonad m, Prim a, HasCallStack) => Ptr a -> PrimArray a -> Int -> Int -> m ()
copyMutablePrimArrayToPtr :: (PrimMonad m, Prim a, HasCallStack) => Ptr a -> MutablePrimArray (PrimState m) a -> Int -> Int -> m ()
copyPtrToMutablePrimArray :: (PrimMonad m, Prim a, HasCallStack) => MutablePrimArray (PrimState m) a -> Int -> Ptr a -> Int -> m ()
-- | Yield a pointer to the array's data.
--
-- This operation is only safe on pinned primitive arrays
-- allocated by newPinnedPrimArray or
-- newAlignedPinnedPrimArray, and you have to make sure the
-- PrimArray can outlive the Ptr.
primArrayContents :: PrimArray a -> Ptr a
-- | Yield a pointer to the array's data.
--
-- This operation is only safe on pinned primitive arrays
-- allocated by newPinnedPrimArray or
-- newAlignedPinnedPrimArray. and you have to make sure the
-- PrimArray can outlive the Ptr.
mutablePrimArrayContents :: MutablePrimArray s a -> Ptr a
-- | Yield a pointer to the array's data and do computation with it.
--
-- This operation is only safe on pinned primitive arrays
-- allocated by newPinnedPrimArray or
-- newAlignedPinnedPrimArray.
--
-- Don't pass a forever loop to this function, see #14346.
withPrimArrayContents :: PrimArray a -> (Ptr a -> IO b) -> IO b
-- | Yield a pointer to the array's data and do computation with it.
--
-- This operation is only safe on pinned primitive arrays
-- allocated by newPinnedPrimArray or
-- newAlignedPinnedPrimArray.
--
-- Don't pass a forever loop to this function, see #14346.
withMutablePrimArrayContents :: MutablePrimArray RealWorld a -> (Ptr a -> IO b) -> IO b
-- | Check if a primitive array is pinned.
isPrimArrayPinned :: PrimArray a -> Bool
-- | Check if a mutable primitive array is pinned.
isMutablePrimArrayPinned :: MutablePrimArray s a -> Bool
data UnliftedArray e
UnliftedArray :: ArrayArray# -> UnliftedArray e
data MutableUnliftedArray s e
MutableUnliftedArray :: MutableArrayArray# s -> MutableUnliftedArray s e
class PrimUnlifted a
toArrayArray# :: PrimUnlifted a => a -> ArrayArray#
fromArrayArray# :: PrimUnlifted a => ArrayArray# -> a
-- | Exceptions generated by array operations
data ArrayException
-- | An attempt was made to index an array outside its declared bounds.
IndexOutOfBounds :: String -> ArrayException
-- | An attempt was made to evaluate an element of an array that had not
-- been initialized.
UndefinedElement :: String -> ArrayException
-- | This module provides functions for writing PrimArray related
-- literals QuasiQuote.
module Std.Data.PrimArray.QQ
arrASCII :: QuasiQuoter
arrW8 :: QuasiQuoter
arrW16 :: QuasiQuoter
arrW32 :: QuasiQuoter
arrW64 :: QuasiQuoter
arrWord :: QuasiQuoter
arrI8 :: QuasiQuoter
arrI16 :: QuasiQuoter
arrI32 :: QuasiQuoter
arrI64 :: QuasiQuoter
arrInt :: QuasiQuoter
-- | Construct data with ASCII encoded literals.
--
-- Example usage:
--
--
-- arrASCII :: QuasiQuoter
-- arrASCII = QuasiQuoter
-- (asciiLiteral $ len addr -> [| word8ArrayFromAddr $(len) $(addr) |])
-- ...
--
-- word8ArrayFromAddr :: Int -> Addr# -> PrimArray Word8
-- {--}
-- word8ArrayFromAddr l addr# = runST $ do
-- mba <- newPrimArray (I# l)
-- copyPtrToMutablePrimArray mba 0 (Ptr addr#) l
-- unsafeFreezePrimArray mba
--
asciiLiteral :: (ExpQ -> ExpQ -> ExpQ) -> String -> ExpQ
-- | Construct data with UTF-8 encoded literals.
--
-- Smiliar to asciIILiteral, the
utf8Literal :: (ExpQ -> ExpQ -> ExpQ) -> String -> ExpQ
word8Literal :: (ExpQ -> ExpQ -> ExpQ) -> String -> ExpQ
word16Literal :: (ExpQ -> ExpQ -> ExpQ) -> String -> ExpQ
word32Literal :: (ExpQ -> ExpQ -> ExpQ) -> String -> ExpQ
word64Literal :: (ExpQ -> ExpQ -> ExpQ) -> String -> ExpQ
wordLiteral :: (ExpQ -> ExpQ -> ExpQ) -> String -> ExpQ
int8Literal :: (ExpQ -> ExpQ -> ExpQ) -> String -> ExpQ
int16Literal :: (ExpQ -> ExpQ -> ExpQ) -> String -> ExpQ
int32Literal :: (ExpQ -> ExpQ -> ExpQ) -> String -> ExpQ
int64Literal :: (ExpQ -> ExpQ -> ExpQ) -> String -> ExpQ
intLiteral :: (ExpQ -> ExpQ -> ExpQ) -> String -> ExpQ
word8ArrayFromAddr :: Int -> Addr# -> PrimArray Word8
word16ArrayFromAddr :: Int -> Addr# -> PrimArray Word16
word32ArrayFromAddr :: Int -> Addr# -> PrimArray Word32
word64ArrayFromAddr :: Int -> Addr# -> PrimArray Word64
wordArrayFromAddr :: Int -> Addr# -> PrimArray Word
int8ArrayFromAddr :: Int -> Addr# -> PrimArray Int8
int16ArrayFromAddr :: Int -> Addr# -> PrimArray Int16
int32ArrayFromAddr :: Int -> Addr# -> PrimArray Int32
int64ArrayFromAddr :: Int -> Addr# -> PrimArray Int64
intArrayFromAddr :: Int -> Addr# -> PrimArray Int
-- | This module implements unaligned element access with ghc primitives
-- (> 8.6).
module Std.Data.PrimArray.UnalignedAccess
newtype UnalignedSize a
UnalignedSize :: Int -> UnalignedSize a
[getUnalignedSize] :: UnalignedSize a -> Int
-- | Primitive types which can be unaligned accessed
class UnalignedAccess a
unalignedSize :: UnalignedAccess a => UnalignedSize a
writeWord8ArrayAs :: UnalignedAccess a => MutableByteArray# s -> Int# -> a -> State# s -> State# s
readWord8ArrayAs :: UnalignedAccess a => MutableByteArray# s -> Int# -> State# s -> (# State# s, a #)
indexWord8ArrayAs :: UnalignedAccess a => ByteArray# -> Int# -> a
-- | little endianess wrapper
newtype LE a
LE :: a -> LE a
[getLE] :: LE a -> a
-- | big endianess wrapper
newtype BE a
BE :: a -> BE a
[getBE] :: BE a -> a
instance GHC.Classes.Eq a => GHC.Classes.Eq (Std.Data.PrimArray.UnalignedAccess.BE a)
instance GHC.Show.Show a => GHC.Show.Show (Std.Data.PrimArray.UnalignedAccess.BE a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Std.Data.PrimArray.UnalignedAccess.LE a)
instance GHC.Show.Show a => GHC.Show.Show (Std.Data.PrimArray.UnalignedAccess.LE a)
instance GHC.Classes.Eq (Std.Data.PrimArray.UnalignedAccess.UnalignedSize a)
instance GHC.Show.Show (Std.Data.PrimArray.UnalignedAccess.UnalignedSize a)
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess (Std.Data.PrimArray.UnalignedAccess.BE GHC.Word.Word16)
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess (Std.Data.PrimArray.UnalignedAccess.BE GHC.Word.Word32)
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess (Std.Data.PrimArray.UnalignedAccess.BE GHC.Word.Word64)
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess (Std.Data.PrimArray.UnalignedAccess.BE GHC.Types.Word)
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess (Std.Data.PrimArray.UnalignedAccess.BE GHC.Int.Int16)
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess (Std.Data.PrimArray.UnalignedAccess.BE GHC.Int.Int32)
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess (Std.Data.PrimArray.UnalignedAccess.BE GHC.Int.Int64)
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess (Std.Data.PrimArray.UnalignedAccess.BE GHC.Types.Int)
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess (Std.Data.PrimArray.UnalignedAccess.BE GHC.Types.Float)
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess (Std.Data.PrimArray.UnalignedAccess.BE GHC.Types.Double)
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess (Std.Data.PrimArray.UnalignedAccess.BE GHC.Types.Char)
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess (Std.Data.PrimArray.UnalignedAccess.LE GHC.Word.Word16)
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess (Std.Data.PrimArray.UnalignedAccess.LE GHC.Word.Word32)
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess (Std.Data.PrimArray.UnalignedAccess.LE GHC.Word.Word64)
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess (Std.Data.PrimArray.UnalignedAccess.LE GHC.Types.Word)
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess (Std.Data.PrimArray.UnalignedAccess.LE GHC.Int.Int16)
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess (Std.Data.PrimArray.UnalignedAccess.LE GHC.Int.Int32)
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess (Std.Data.PrimArray.UnalignedAccess.LE GHC.Int.Int64)
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess (Std.Data.PrimArray.UnalignedAccess.LE GHC.Types.Int)
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess (Std.Data.PrimArray.UnalignedAccess.LE GHC.Types.Float)
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess (Std.Data.PrimArray.UnalignedAccess.LE GHC.Types.Double)
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess (Std.Data.PrimArray.UnalignedAccess.LE GHC.Types.Char)
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess GHC.Word.Word8
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess GHC.Int.Int8
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess GHC.Word.Word16
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess GHC.Word.Word32
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess GHC.Word.Word64
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess GHC.Types.Word
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess GHC.Int.Int16
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess GHC.Int.Int32
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess GHC.Int.Int64
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess GHC.Types.Int
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess GHC.Types.Float
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess GHC.Types.Double
instance Std.Data.PrimArray.UnalignedAccess.UnalignedAccess GHC.Types.Char
-- | Internal module for PrimSTRef and PrimIORef.
module Std.Data.PrimSTRef.Base
-- | A mutable variable in the ST monad which can hold an instance of
-- Prim.
newtype PrimSTRef s a
PrimSTRef :: MutableByteArray s -> PrimSTRef s a
-- | Build a new PrimSTRef
newPrimSTRef :: Prim a => a -> ST s (PrimSTRef s a)
-- | Read the value of an PrimSTRef
readPrimSTRef :: Prim a => PrimSTRef s a -> ST s a
-- | Write a new value into an PrimSTRef
writePrimSTRef :: Prim a => PrimSTRef s a -> a -> ST s ()
-- | Mutate the contents of an PrimSTRef.
--
-- Unboxed reference is always strict on the value it hold.
modifyPrimSTRef :: Prim a => PrimSTRef s a -> (a -> a) -> ST s ()
-- | This module provide fast unboxed references for ST monad. Unboxed
-- reference is implemented using single cell MutableByteArray s to
-- eliminate indirection overhead which MutVar# s a carry, on the
-- otherhand unboxed reference only support limited type(instances of
-- Prim class).
module Std.Data.PrimSTRef
-- | A mutable variable in the ST monad which can hold an instance of
-- Prim.
data PrimSTRef s a
-- | Build a new PrimSTRef
newPrimSTRef :: Prim a => a -> ST s (PrimSTRef s a)
-- | Read the value of an PrimSTRef
readPrimSTRef :: Prim a => PrimSTRef s a -> ST s a
-- | Write a new value into an PrimSTRef
writePrimSTRef :: Prim a => PrimSTRef s a -> a -> ST s ()
-- | Mutate the contents of an PrimSTRef.
--
-- Unboxed reference is always strict on the value it hold.
modifyPrimSTRef :: Prim a => PrimSTRef s a -> (a -> a) -> ST s ()
-- | This package provide fast unboxed references for IO monad and atomic
-- operations for Counter type. Unboxed reference is implemented
-- using single cell MutableByteArray s to eliminate indirection overhead
-- which MutVar# s a carry, on the otherhand unboxed reference only
-- support limited type(instances of Prim class).
--
-- Atomic operations on Counter type are implemented using
-- fetch-and-add primitives, which is much faster than a CAS
-- loop(atomicModifyIORef). Beside basic atomic counter usage,
-- you can also leverage idempotence of and 0, or (-1)
-- to make a concurrent flag.
module Std.Data.PrimIORef
-- | A mutable variable in the IO monad which can hold an instance of
-- Prim.
data PrimIORef a
-- | Build a new PrimIORef
newPrimIORef :: Prim a => a -> IO (PrimIORef a)
-- | Read the value of an PrimIORef
readPrimIORef :: Prim a => PrimIORef a -> IO a
-- | Write a new value into an PrimIORef
writePrimIORef :: Prim a => PrimIORef a -> a -> IO ()
-- | Mutate the contents of an IORef.
--
-- Unboxed reference is always strict on the value it hold.
modifyPrimIORef :: Prim a => PrimIORef a -> (a -> a) -> IO ()
-- | Alias for 'PrimIORef Int' which support several atomic operations.
type Counter = PrimIORef Int
-- | Build a new Counter
newCounter :: Int -> IO Counter
-- | Atomically add a Counter, return the value BEFORE added.
atomicAddCounter :: Counter -> Int -> IO Int
-- | Atomically sub a Counter, return the value BEFORE subbed.
atomicSubCounter :: Counter -> Int -> IO Int
-- | Atomically and a Counter, return the value BEFORE anded.
atomicAndCounter :: Counter -> Int -> IO Int
-- | Atomically nand a Counter, return the value BEFORE nanded.
atomicNandCounter :: Counter -> Int -> IO Int
-- | Atomically or a Counter, return the value BEFORE ored.
atomicOrCounter :: Counter -> Int -> IO Int
-- | Atomically xor a Counter, return the value BEFORE xored.
atomicXorCounter :: Counter -> Int -> IO Int
-- | Atomically add a Counter, return the value AFTER added.
atomicAddCounter' :: Counter -> Int -> IO Int
-- | Atomically sub a Counter, return the value AFTER subbed.
atomicSubCounter' :: Counter -> Int -> IO Int
-- | Atomically and a Counter, return the value AFTER anded.
atomicAndCounter' :: Counter -> Int -> IO Int
-- | Atomically nand a Counter, return the value AFTER nanded.
atomicNandCounter' :: Counter -> Int -> IO Int
-- | Atomically or a Counter, return the value AFTER ored.
atomicOrCounter' :: Counter -> Int -> IO Int
-- | Atomically xor a Counter, return the value AFTER xored.
atomicXorCounter' :: Counter -> Int -> IO Int
-- | Atomically add a Counter.
atomicAddCounter_ :: Counter -> Int -> IO ()
-- | Atomically sub a Counter
atomicSubCounter_ :: Counter -> Int -> IO ()
-- | Atomically and a Counter
atomicAndCounter_ :: Counter -> Int -> IO ()
-- | Atomically nand a Counter
atomicNandCounter_ :: Counter -> Int -> IO ()
-- | Atomically or a Counter
atomicOrCounter_ :: Counter -> Int -> IO ()
-- | Atomically xor a Counter
atomicXorCounter_ :: Counter -> Int -> IO ()
-- | UTF-8 codecs and helpers.
module Std.Data.Text.UTF8Codec
-- | Return a codepoint's encoded length in bytes
--
-- If the codepoint is invalid, we return 3(encoded bytes length of
-- replacement char U+FFFD).
encodeCharLength :: Char -> Int
-- | Encode a Char into bytes, write replacementChar for
-- invalid unicode codepoint.
--
-- This function assumed there're enough space for encoded bytes, and
-- return the advanced index.
encodeChar :: MutablePrimArray s Word8 -> Int -> Char -> ST s Int
-- | The unboxed version of encodeChar.
--
-- This function is marked as NOINLINE to reduce code size, and
-- stop messing up simplifier due to too much branches.
encodeChar# :: MutableByteArray# s -> Int# -> Char# -> State# s -> (# State# s, Int# #)
-- | Encode a Char into bytes with non-standard UTF-8 encoding(Used
-- in Data.CBytes).
--
-- '\NUL' is encoded as two bytes C0 80 , '\xD800' ~ '\xDFFF' is
-- encoded as a three bytes normal UTF-8 codepoint. This function assumed
-- there're enough space for encoded bytes, and return the advanced
-- index.
encodeCharModifiedUTF8 :: PrimMonad m => MutablePrimArray (PrimState m) Word8 -> Int -> Char -> m Int
-- | The unboxed version of encodeCharModifiedUTF8.
encodeCharModifiedUTF8# :: MutableByteArray# s -> Int# -> Char# -> State# s -> (# State# s, Int# #)
-- | Decode a Char from bytes
--
-- This function assumed all bytes are UTF-8 encoded, and the index param
-- point to the beginning of a codepoint, the decoded character and the
-- advancing offset are returned.
--
-- It's annoying to use unboxed tuple here but we really don't want
-- allocation even if GHC can't optimize it away.
decodeChar :: PrimArray Word8 -> Int -> (# Char, Int #)
decodeChar_ :: PrimArray Word8 -> Int -> Char
-- | The unboxed version of decodeChar
--
-- This function is marked as NOINLINE to reduce code size, and
-- stop messing up simplifier due to too much branches.
decodeChar# :: ByteArray# -> Int# -> (# Char#, Int# #)
-- | Decode a codepoint's length in bytes
--
-- This function assumed all bytes are UTF-8 encoded, and the index param
-- point to the beginning of a codepoint.
decodeCharLen :: PrimArray Word8 -> Int -> Int
-- | The unboxed version of decodeCharLen
--
-- This function is marked as NOINLINE to reduce code size, and
-- stop messing up simplifier due to too much branches.
decodeCharLen# :: ByteArray# -> Int# -> Int#
-- | Decode a Char from bytes in rerverse order.
--
-- This function assumed all bytes are UTF-8 encoded, and the index param
-- point to the end of a codepoint, the decoded character and the
-- backward advancing offset are returned.
decodeCharReverse :: PrimArray Word8 -> Int -> (# Char, Int #)
decodeCharReverse_ :: PrimArray Word8 -> Int -> Char
-- | The unboxed version of decodeCharReverse
--
-- This function is marked as NOINLINE to reduce code size, and
-- stop messing up simplifier due to too much branches.
decodeCharReverse# :: ByteArray# -> Int# -> (# Char#, Int# #)
-- | Decode a codepoint's length in bytes in reverse order.
--
-- This function assumed all bytes are UTF-8 encoded, and the index param
-- point to the end of a codepoint.
decodeCharLenReverse :: PrimArray Word8 -> Int -> Int
-- | The unboxed version of decodeCharLenReverse
--
-- This function is marked as NOINLINE to reduce code size, and
-- stop messing up simplifier due to too much branches.
decodeCharLenReverse# :: ByteArray# -> Int# -> Int#
between# :: Word# -> Word# -> Word# -> Bool
isContinueByte# :: Word# -> Bool
chr1# :: Word# -> Char#
chr2# :: Word# -> Word# -> Char#
chr3# :: Word# -> Word# -> Word# -> Char#
chr4# :: Word# -> Word# -> Word# -> Word# -> Char#
-- | Unrolled copy loop for copying a utf8-encoded codepoint from source
-- array to target array.
copyChar :: Int -> MutablePrimArray s Word8 -> Int -> PrimArray Word8 -> Int -> ST s ()
-- | Unrolled copy loop for copying a utf8-encoded codepoint from source
-- array to target array.
copyChar' :: Int -> MutablePrimArray s Word8 -> Int -> MutablePrimArray s Word8 -> Int -> ST s ()
-- | xFFFD, which will be encoded as 0xEF 0xBF 0xBD 3
-- bytes.
replacementChar :: Char
-- | INTERNAL MODULE, provides utf8rewind constants
module Std.Data.Text.UTF8Rewind
-- | Locale for case mapping.
newtype Locale
Locale :: CSize -> Locale
localeDefault :: Locale
localeLithuanian :: Locale
localeTurkishAndAzeriLatin :: Locale
-- | see NormalizeMode in Std.Data.Text.Base
normalizeCompose :: CSize
normalizeDecompose :: CSize
normalizeCompatibility :: CSize
-- | These are the Unicode Normalization Forms:
--
--
-- Form | Description
-- ---------------------------- | ---------------------------------------------
-- Normalization Form D (NFD) | Canonical decomposition
-- Normalization Form C (NFC) | Canonical decomposition, followed by canonical composition
-- Normalization Form KD (NFKD) | Compatibility decomposition
-- Normalization Form KC (NFKC) | Compatibility decomposition, followed by canonical composition
--
data NormalizeMode
NFC :: NormalizeMode
NFKC :: NormalizeMode
NFD :: NormalizeMode
NFKD :: NormalizeMode
normalizeModeToFlag :: NormalizeMode -> CSize
data NormalizationResult
NormalizedYes :: NormalizationResult
NormalizedMaybe :: NormalizationResult
NormalizedNo :: NormalizationResult
toNormalizationResult :: Int -> NormalizationResult
-- | Unicode categories. See isCategory, you can combine categories
-- with bitwise or.
newtype Category
Category :: CSize -> Category
categoryLetterUppercase :: Category
categoryLetterLowercase :: Category
categoryLetterTitlecase :: Category
categoryLetterOther :: Category
categoryLetter :: Category
categoryCaseMapped :: Category
categoryMarkNonSpacing :: Category
categoryMarkSpacing :: Category
categoryMarkEnclosing :: Category
categoryMark :: Category
categoryNumberDecimal :: Category
categoryNumberLetter :: Category
categoryNumberOther :: Category
categoryNumber :: Category
categoryPunctuationConnector :: Category
categoryPunctuationDash :: Category
categoryPunctuationOpen :: Category
categoryPunctuationClose :: Category
categoryPunctuationInitial :: Category
categoryPunctuationFinal :: Category
categoryPunctuationOther :: Category
categoryPunctuation :: Category
categorySymbolMath :: Category
categorySymbolCurrency :: Category
categorySymbolModifier :: Category
categorySymbolOther :: Category
categorySymbol :: Category
categorySeparatorSpace :: Category
categorySeparatorLine :: Category
categorySeparatorParagraph :: Category
categorySeparator :: Category
categoryControl :: Category
categoryFormat :: Category
categorySurrogate :: Category
categoryPrivateUse :: Category
categoryUnassigned :: Category
categoryCompatibility :: Category
categoryIgnoreGraphemeCluste :: Category
categoryIscntrl :: Category
categoryIsprint :: Category
categoryIsspace :: Category
categoryIsblank :: Category
categoryIsgraph :: Category
categoryIspunct :: Category
categoryIsalnum :: Category
categoryIsalpha :: Category
categoryIsupper :: Category
categoryIslower :: Category
categoryIsdigit :: Category
categoryIsxdigit :: Category
utf8envlocale :: IO Category
instance GHC.Generics.Generic Std.Data.Text.UTF8Rewind.Category
instance Data.Bits.FiniteBits Std.Data.Text.UTF8Rewind.Category
instance Data.Bits.Bits Std.Data.Text.UTF8Rewind.Category
instance GHC.Classes.Ord Std.Data.Text.UTF8Rewind.Category
instance GHC.Classes.Eq Std.Data.Text.UTF8Rewind.Category
instance GHC.Show.Show Std.Data.Text.UTF8Rewind.Category
instance GHC.Generics.Generic Std.Data.Text.UTF8Rewind.NormalizationResult
instance GHC.Classes.Ord Std.Data.Text.UTF8Rewind.NormalizationResult
instance GHC.Classes.Eq Std.Data.Text.UTF8Rewind.NormalizationResult
instance GHC.Show.Show Std.Data.Text.UTF8Rewind.NormalizationResult
instance GHC.Generics.Generic Std.Data.Text.UTF8Rewind.NormalizeMode
instance GHC.Classes.Ord Std.Data.Text.UTF8Rewind.NormalizeMode
instance GHC.Classes.Eq Std.Data.Text.UTF8Rewind.NormalizeMode
instance GHC.Show.Show Std.Data.Text.UTF8Rewind.NormalizeMode
instance GHC.Generics.Generic Std.Data.Text.UTF8Rewind.Locale
instance GHC.Classes.Ord Std.Data.Text.UTF8Rewind.Locale
instance GHC.Classes.Eq Std.Data.Text.UTF8Rewind.Locale
instance GHC.Show.Show Std.Data.Text.UTF8Rewind.Locale
-- | This module provides unified vector interface. Conceptually a vector
-- is simply a slice of an array, for example this is the definition of
-- boxed vector:
--
--
-- data Vector a = Vector !(SmallArray a) !Int !Int
-- -- payload offset length
--
--
-- The Vec class unified different type of vectors, and this
-- module provide operation over Vec instances, with all the
-- internal structures. Be careful on modifying internal slices,
-- otherwise segmentation fault await.
module Std.Data.Vector.Base
-- | Typeclass for box and unboxed vectors, which are created by slicing
-- arrays.
class (Arr (MArray v) (IArray v) a) => Vec v a where {
-- | Vector's mutable array type
type family MArray v = (marr :: * -> * -> *) | marr -> v;
-- | Vector's immutable array type
type family IArray v = (iarr :: * -> *) | iarr -> v;
}
-- | Get underline array and slice range(offset and length).
toArr :: Vec v a => v a -> (IArray v a, Int, Int)
-- | Create a vector by slicing an array(with offset and length).
fromArr :: Vec v a => IArray v a -> Int -> Int -> v a
-- | A pattern synonyms for matching the underline array, offset and
-- length.
--
-- This is a bidirectional pattern synonyms, but very unsafe if not use
-- properly. Make sure your slice is within array's bounds!
-- | O(1) Index array element.
--
-- Return Nothing if index is out of bounds.
indexMaybe :: (Vec v a, HasCallStack) => v a -> Int -> Maybe a
-- | Boxed vector
data Vector a
Vector :: {-# UNPACK #-} !SmallArray a -> {-# UNPACK #-} !Int -> {-# UNPACK #-} !Int -> Vector a
-- | Primitive vector
data PrimVector a
PrimVector :: {-# UNPACK #-} !PrimArray a -> {-# UNPACK #-} !Int -> {-# UNPACK #-} !Int -> PrimVector a
-- | Bytes is just primitive word8 vectors.
type Bytes = PrimVector Word8
packASCII :: String -> Bytes
-- | Conversion between Word8 and Char. Should compile to a
-- no-op.
w2c :: Word8 -> Char
-- | Unsafe conversion between Char and Word8. This is a
-- no-op and silently truncates to 8 bits Chars > '\255'. It is
-- provided as convenience for PrimVector construction.
c2w :: Char -> Word8
-- | Create a vector with size N.
create :: Vec v a => Int -> (forall s. MArray v s a -> ST s ()) -> v a
-- | Create a vector with a initial size N array (which may not be the
-- final array).
create' :: Vec v a => Int -> (forall s. MArray v s a -> ST s (IPair (MArray v s a))) -> v a
-- | Create a vector with a initial size N array, return both the vector
-- and the monadic result during creating.
--
-- The result is not demanded strictly while the returned vector will be
-- in normal form. It this is not desired, use return $! idiom
-- in your initialization function.
creating :: Vec v a => Int -> (forall s. MArray v s a -> ST s b) -> (b, v a)
-- | Create a vector with a initial size N array (which may not be the
-- final array), return both the vector and the monadic result during
-- creating.
--
-- The result is not demanded strictly while the returned vector will be
-- in normal form. It this is not desired, use return $! idiom
-- in your initialization function.
creating' :: Vec v a => Int -> (forall s. MArray v s a -> ST s (b, IPair (MArray v s a))) -> (b, v a)
-- | Create a vector up to a specific length.
--
-- If the initialization function return a length larger than initial
-- size, an IndexOutOfVectorRange will be raised.
createN :: (Vec v a, HasCallStack) => Int -> (forall s. MArray v s a -> ST s Int) -> v a
-- | Create two vector up to a specific length.
--
-- If the initialization function return lengths larger than initial
-- sizes, an IndexOutOfVectorRange will be raised.
createN2 :: (Vec v a, Vec u b, HasCallStack) => Int -> Int -> (forall s. MArray v s a -> MArray u s b -> ST s (Int, Int)) -> (v a, u b)
-- | O(1). The empty vector.
empty :: Vec v a => v a
-- | O(1). Single element vector.
singleton :: Vec v a => a -> v a
-- | O(n). Copy a vector from slice.
copy :: Vec v a => v a -> v a
-- | O(n) Convert a list into a vector
--
-- Alias for packN defaultInitSize.
pack :: Vec v a => [a] -> v a
-- | O(n) Convert a list into a vector with an approximate size.
--
-- If the list's length is large than the size given, we simply double
-- the buffer size and continue building.
--
-- This function is a good consumer in the sense of build/foldr
-- fusion.
packN :: forall v a. Vec v a => Int -> [a] -> v a
-- | O(n) Alias for packRN defaultInitSize.
packR :: Vec v a => [a] -> v a
-- | O(n) packN in reverse order.
--
-- This function is a good consumer in the sense of build/foldr
-- fusion.
packRN :: forall v a. Vec v a => Int -> [a] -> v a
-- | O(n) Convert vector to a list.
--
-- Unpacking is done lazily. i.e. we will retain reference to the array
-- until all element are consumed.
--
-- This function is a good producer in the sense of build/foldr
-- fusion.
unpack :: Vec v a => v a -> [a]
-- | O(n) Convert vector to a list in reverse order.
--
-- This function is a good producer in the sense of build/foldr
-- fusion.
unpackR :: Vec v a => v a -> [a]
-- | O(1) Test whether a vector is empty.
null :: Vec v a => v a -> Bool
-- | O(1) The length of a vector.
length :: Vec v a => v a -> Int
-- | O(m+n)
--
-- There's no need to guard empty vector because we guard them for you,
-- so appending empty vectors are no-ops.
append :: Vec v a => v a -> v a -> v a
-- | Mapping between vectors (possiblely with two different vector types).
--
-- NOTE, the result vector contain thunks in lifted Vector case,
-- use map' if that's not desired.
--
-- For PrimVector, map and map' are same, since
-- PrimVectors never store thunks.
map :: forall u v a b. (Vec u a, Vec v b) => (a -> b) -> u a -> v b
-- | Mapping between vectors (possiblely with two different vector types).
--
-- This is the strict version map. Note that the Functor instance
-- of lifted Vector is defined with map to statisfy laws,
-- which this strict version breaks (map' id arrayContainsBottom /=
-- arrayContainsBottom ).
map' :: forall u v a b. (Vec u a, Vec v b) => (a -> b) -> u a -> v b
-- | Strict mapping with index.
imap' :: forall u v a b. (Vec u a, Vec v b) => (Int -> a -> b) -> u a -> v b
-- | Strict left to right fold.
foldl' :: Vec v a => (b -> a -> b) -> b -> v a -> b
-- | Strict left to right fold with index.
ifoldl' :: Vec v a => (b -> Int -> a -> b) -> b -> v a -> b
-- | Strict left to right fold using first element as the initial value.
--
-- Throw EmptyVector if vector is empty.
foldl1' :: forall v a. (Vec v a, HasCallStack) => (a -> a -> a) -> v a -> a
-- | Strict left to right fold using first element as the initial value.
-- return Nothing when vector is empty.
foldl1Maybe' :: forall v a. Vec v a => (a -> a -> a) -> v a -> Maybe a
-- | Strict right to left fold
foldr' :: Vec v a => (a -> b -> b) -> b -> v a -> b
-- | Strict right to left fold with index
--
-- NOTE: the index is counting from 0, not backwards
ifoldr' :: Vec v a => (Int -> a -> b -> b) -> b -> v a -> b
-- | Strict right to left fold using last element as the initial value.
--
-- Throw EmptyVector if vector is empty.
foldr1' :: forall v a. (Vec v a, HasCallStack) => (a -> a -> a) -> v a -> a
-- | Strict right to left fold using last element as the initial value,
-- return Nothing when vector is empty.
foldr1Maybe' :: forall v a. Vec v a => (a -> a -> a) -> v a -> Maybe a
-- | O(n) Concatenate a list of vector.
--
-- Note: concat have to force the entire list to filter out empty
-- vector and calculate the length for allocation.
concat :: forall v a. Vec v a => [v a] -> v a
-- | Map a function over a vector and concatenate the results
concatMap :: Vec v a => (a -> v a) -> v a -> v a
-- | O(n) maximum returns the maximum value from a vector
--
-- It's defined with foldl1', an EmptyVector exception will
-- be thrown in the case of an empty vector.
maximum :: (Vec v a, Ord a, HasCallStack) => v a -> a
-- | O(n) minimum returns the minimum value from a
-- vector
--
-- An EmptyVector exception will be thrown in the case of an empty
-- vector.
minimum :: (Vec v a, Ord a, HasCallStack) => v a -> a
-- | O(n) maximum returns the maximum value from a vector,
-- return Nothing in the case of an empty vector.
maximumMaybe :: (Vec v a, Ord a) => v a -> Maybe a
-- | O(n) minimum returns the minimum value from a vector,
-- return Nothing in the case of an empty vector.
minimumMaybe :: (Vec v a, Ord a) => v a -> Maybe a
-- | O(n) sum returns the sum value from a vector
sum :: (Vec v a, Num a) => v a -> a
-- | O(n) count returns count of an element from a
-- vector
count :: (Vec v a, Eq a) => a -> v a -> Int
-- | O(n) product returns the product value from a vector
product :: (Vec v a, Num a) => v a -> a
-- | O(n) product returns the product value from a vector
--
-- This function will shortcut on zero. Note this behavior change the
-- semantics for lifted vector: product [1,0,undefined] /= product'
-- [1,0,undefined].
product' :: (Vec v a, Num a, Eq a) => v a -> a
-- | O(n) Applied to a predicate and a vector, all determines
-- if all elements of the vector satisfy the predicate.
all :: Vec v a => (a -> Bool) -> v a -> Bool
-- | O(n) Applied to a predicate and a vector, any determines
-- if any elements of the vector satisfy the predicate.
any :: Vec v a => (a -> Bool) -> v a -> Bool
-- | The mapAccumL function behaves like a combination of map
-- and foldl; it applies a function to each element of a vector,
-- passing an accumulating parameter from left to right, and returning a
-- final value of this accumulator together with the new list.
--
-- Note, this function will only force the result tuple, not the elements
-- inside, to prevent creating thunks during mapAccumL, seq
-- your accumulator and result with the result tuple.
mapAccumL :: forall u v a b c. (Vec u b, Vec v c) => (a -> b -> (a, c)) -> a -> u b -> (a, v c)
-- | The mapAccumR function behaves like a combination of map
-- and foldr; it applies a function to each element of a vector,
-- passing an accumulating parameter from right to left, and returning a
-- final value of this accumulator together with the new vector.
--
-- The same strictness property with mapAccumL applys to
-- mapAccumR too.
mapAccumR :: forall u v a b c. (Vec u b, Vec v c) => (a -> b -> (a, c)) -> a -> u b -> (a, v c)
-- | O(n) replicate n x is a vector of length
-- n with x the value of every element.
--
-- Note: replicate will not force the element in boxed vector
-- case.
replicate :: Vec v a => Int -> a -> v a
-- | O(n*m) cycleN a vector n times.
cycleN :: forall v a. Vec v a => Int -> v a -> v a
-- | O(n), where n is the length of the result. The
-- unfoldr function is analogous to the List 'unfoldr'.
-- unfoldr builds a vector from a seed value. The function takes
-- the element and returns Nothing if it is done producing the
-- vector or returns Just (a,b), in which case,
-- a is the next byte in the string, and b is the seed
-- value for further production.
--
-- Examples:
--
--
-- unfoldr (\x -> if x <= 5 then Just (x, x + 1) else Nothing) 0
-- == pack [0, 1, 2, 3, 4, 5]
--
unfoldr :: Vec u b => (a -> Maybe (b, a)) -> a -> u b
-- | O(n) Like unfoldr, unfoldrN builds a vector from
-- a seed value. However, the length of the result is limited by the
-- first argument to unfoldrN. This function is more efficient
-- than unfoldr when the maximum length of the result is known.
--
-- The following equation relates unfoldrN and unfoldr:
--
--
-- fst (unfoldrN n f s) == take n (unfoldr f s)
--
unfoldrN :: forall v a b. Vec v b => Int -> (a -> Maybe (b, a)) -> a -> (v b, Maybe a)
-- | O(n) elem test if given element is in given vector.
elem :: (Vec v a, Eq a) => a -> v a -> Bool
-- | O(n) 'not . elem'
notElem :: (Vec v a, Eq a) => a -> v a -> Bool
-- | O(n) The elemIndex function returns the index of the
-- first element in the given vector which is equal to the query element,
-- or Nothing if there is no such element.
elemIndex :: (Vec v a, Eq a) => a -> v a -> Maybe Int
-- | Index pair type to help GHC unpack in some loops, useful when write
-- fast folds.
data IPair a
IPair :: {-# UNPACK #-} !Int -> a -> IPair a
-- | defaultInitSize = 30, used as initialize size when packing
-- list of unknown size.
defaultInitSize :: Int
-- | The memory management overhead. Currently this is tuned for GHC only.
chunkOverhead :: Int
-- | The chunk size used for I/O. Currently set to
-- 32k-chunkOverhead
defaultChunkSize :: Int
-- | The recommended chunk size. Currently set to 4k -
-- chunkOverhead.
smallChunkSize :: Int
data VectorException
IndexOutOfVectorRange :: {-# UNPACK #-} !Int -> CallStack -> VectorException
EmptyVector :: CallStack -> VectorException
errorEmptyVector :: HasCallStack => a
errorOutRange :: HasCallStack => Int -> a
-- | Cast between vectors
castVector :: (Vec v a, Cast a b) => v a -> v b
c_strcmp :: Addr# -> Addr# -> IO CInt
c_strlen :: Addr# -> IO CSize
c_ascii_validate_addr :: Addr# -> Int -> IO Int
c_fnv_hash_addr :: Addr# -> Int -> Int -> IO Int
c_fnv_hash_ba :: ByteArray# -> Int -> Int -> Int -> IO Int
instance GHC.Show.Show Std.Data.Vector.Base.VectorException
instance Data.Data.Data a => Data.Data.Data (Std.Data.Vector.Base.Vector a)
instance GHC.Exception.Type.Exception Std.Data.Vector.Base.VectorException
instance Data.CaseInsensitive.Internal.FoldCase Std.Data.Vector.Base.Bytes
instance Data.Primitive.Types.Prim a => Std.Data.Vector.Base.Vec Std.Data.Vector.Base.PrimVector a
instance (Data.Primitive.Types.Prim a, GHC.Classes.Eq a) => GHC.Classes.Eq (Std.Data.Vector.Base.PrimVector a)
instance (Data.Primitive.Types.Prim a, GHC.Classes.Ord a) => GHC.Classes.Ord (Std.Data.Vector.Base.PrimVector a)
instance GHC.Classes.Ord (Std.Data.Vector.Base.PrimVector GHC.Word.Word8)
instance Data.Primitive.Types.Prim a => GHC.Base.Semigroup (Std.Data.Vector.Base.PrimVector a)
instance Data.Primitive.Types.Prim a => GHC.Base.Monoid (Std.Data.Vector.Base.PrimVector a)
instance Control.DeepSeq.NFData (Std.Data.Vector.Base.PrimVector a)
instance (Data.Primitive.Types.Prim a, GHC.Show.Show a) => GHC.Show.Show (Std.Data.Vector.Base.PrimVector a)
instance (Data.Primitive.Types.Prim a, GHC.Read.Read a) => GHC.Read.Read (Std.Data.Vector.Base.PrimVector a)
instance (Data.Hashable.Class.Hashable a, Data.Primitive.Types.Prim a) => Data.Hashable.Class.Hashable (Std.Data.Vector.Base.PrimVector a)
instance Data.Hashable.Class.Hashable (Std.Data.Vector.Base.PrimVector GHC.Word.Word8)
instance (a Data.Type.Equality.~ GHC.Word.Word8) => Data.String.IsString (Std.Data.Vector.Base.PrimVector a)
instance Std.Data.Vector.Base.Vec Std.Data.Vector.Base.Vector a
instance GHC.Classes.Eq a => GHC.Classes.Eq (Std.Data.Vector.Base.Vector a)
instance GHC.Classes.Ord a => GHC.Classes.Ord (Std.Data.Vector.Base.Vector a)
instance GHC.Base.Semigroup (Std.Data.Vector.Base.Vector a)
instance GHC.Base.Monoid (Std.Data.Vector.Base.Vector a)
instance Control.DeepSeq.NFData a => Control.DeepSeq.NFData (Std.Data.Vector.Base.Vector a)
instance GHC.Show.Show a => GHC.Show.Show (Std.Data.Vector.Base.Vector a)
instance GHC.Read.Read a => GHC.Read.Read (Std.Data.Vector.Base.Vector a)
instance GHC.Base.Functor Std.Data.Vector.Base.Vector
instance Data.Foldable.Foldable Std.Data.Vector.Base.Vector
instance Data.Traversable.Traversable Std.Data.Vector.Base.Vector
instance Data.Hashable.Class.Hashable a => Data.Hashable.Class.Hashable (Std.Data.Vector.Base.Vector a)
instance Data.Hashable.Class.Hashable1 Std.Data.Vector.Base.Vector
-- | This module provides functions for writing vector literals using
-- QuasiQuote.
module Std.Data.Vector.QQ
ascii :: QuasiQuoter
vecW8 :: QuasiQuoter
vecW16 :: QuasiQuoter
vecW32 :: QuasiQuoter
vecW64 :: QuasiQuoter
vecWord :: QuasiQuoter
vecI8 :: QuasiQuoter
vecI16 :: QuasiQuoter
vecI32 :: QuasiQuoter
vecI64 :: QuasiQuoter
vecInt :: QuasiQuoter
-- | This module provides:
--
--
-- - Element-wise searching within vectors
-- - Fast sub-vector searching algorithm based on KMP string
-- searching.
-- - A hybrid sub-vector searching algorithm for Bytes.
-- - Rewrite rules to use Bytes specialized version if
-- possible.
--
module Std.Data.Vector.Search
-- | The findIndex function takes a predicate and a vector and
-- returns the index of the first element in the vector satisfying the
-- predicate.
findIndices :: Vec v a => (a -> Bool) -> v a -> [Int]
-- | O(n) The elemIndices function extends elemIndex,
-- by returning the indices of all elements equal to the query element,
-- in ascending order.
elemIndices :: (Vec v a, Eq a) => a -> v a -> [Int]
-- | O(n) find the first index and element matching the predicate in
-- a vector from left to right, if there isn't one, return (length of the
-- vector, Nothing).
find :: Vec v a => (a -> Bool) -> v a -> (Int, Maybe a)
-- | O(n) find the first index and element matching the predicate in
-- a vector from right to left, if there isn't one, return '(-1,
-- Nothing)'.
findR :: Vec v a => (a -> Bool) -> v a -> (Int, Maybe a)
-- |
-- findIndex f v = fst (find f v)
--
findIndex :: Vec v a => (a -> Bool) -> v a -> Int
-- |
-- findIndexR f v = fst (findR f v)
--
findIndexR :: Vec v a => (a -> Bool) -> v a -> Int
-- | O(n) filter, applied to a predicate and a vector,
-- returns a vector containing those elements that satisfy the predicate.
filter :: forall v a. Vec v a => (a -> Bool) -> v a -> v a
-- | O(n) The partition function takes a predicate, a vector,
-- returns a pair of vector with elements which do and do not satisfy the
-- predicate, respectively; i.e.,
--
--
-- partition p vs == (filter p vs, filter (not . p) vs)
--
partition :: forall v a. Vec v a => (a -> Bool) -> v a -> (v a, v a)
-- | O(n+m) Find the offsets of all indices (possibly overlapping)
-- of needle within haystack using KMP algorithm.
--
-- The KMP algorithm need pre-calculate a shift table in O(m) time
-- and space, the worst case time complexity is O(n+m). Partial
-- apply this function to reuse pre-calculated table between same
-- needles.
--
-- Chunked input are support via partial match argument, if set we will
-- return an extra negative index in case of partial match at the end of
-- input chunk, e.g.
--
--
-- indicesOverlapping [ascii|ada|] [ascii|adadad|] True == [0,2,-2]
--
--
-- Where -2 is the length of the partial match part ad
-- 's negation.
--
-- If an empty pattern is supplied, we will return every possible index
-- of haystack, e.g.
--
--
-- indicesOverlapping "" "abc" = [0,1,2]
--
--
-- References:
--
--
indicesOverlapping :: (Vec v a, Eq a) => v a -> v a -> Bool -> [Int]
-- | O(n+m) Find the offsets of all non-overlapping indices of
-- needle within haystack using KMP algorithm.
--
-- If an empty pattern is supplied, we will return every possible index
-- of haystack, e.g.
--
--
-- indicesOverlapping "" "abc" = [0,1,2]
--
indices :: (Vec v a, Eq a) => v a -> v a -> Bool -> [Int]
-- | O(n) Special elemIndices for Bytes using
-- memchr(3)
elemIndicesBytes :: Word8 -> Bytes -> [Int]
-- | O(n) Special findByte for Word8 using
-- memchr(3)
findByte :: Word8 -> Bytes -> (Int, Maybe Word8)
-- | O(n) Special findR for Bytes with handle roll bit
-- twiddling.
findByteR :: Word8 -> Bytes -> (Int, Maybe Word8)
-- | O(n/m) Find the offsets of all indices (possibly overlapping)
-- of needle within haystack using KMP algorithm,
-- combined with simplified sunday's rule to obtain O(n/m)
-- complexity in average use case.
--
-- The hybrid algorithm need pre-calculate a shift table in O(m)
-- time and space, and a bad character bloom filter in O(m) time
-- and O(1) space, the worst case time complexity is
-- O(n+m).
--
-- References:
--
--
-- - Frantisek FranekChristopher G. JenningsWilliam F. Smyth A Simple
-- Fast Hybrid Pattern-Matching Algorithm (2005)
-- - D. M. Sunday: A Very Fast Substring Search Algorithm.
-- Communications of the ACM, 33, 8, 132-142 (1990)
-- - F. Lundh: The Fast Search Algorithm.
-- http://effbot.org/zone/stringlib.htm (2006)
--
indicesOverlappingBytes :: Bytes -> Bytes -> Bool -> [Int]
-- | O(n/m) Find the offsets of all non-overlapping indices of
-- needle within haystack using KMP algorithm, combined
-- with simplified sunday's rule to obtain O(m/n) complexity in
-- average use case.
indicesBytes :: Bytes -> Bytes -> Bool -> [Int]
-- | O(m) Calculate the KMP next shift table.
--
-- The shifting rules is: when a mismatch between needle[j] and
-- haystack[i] is found, check if next[j] == -1, if so
-- next search continue with needle[0] and
-- haystack[i+1], otherwise continue with
-- needle[next[j]] and haystack[i].
kmpNextTable :: (Vec v a, Eq a) => v a -> PrimArray Int
-- | O(m) Calculate a simple bloom filter for simplified sunday's
-- rule.
--
-- The shifting rules is: when a mismatch between needle[j] and
-- haystack[i] is found, check if elemSundayBloom bloom
-- haystack[i+n-j], where n is the length of needle, if not then
-- next search can be safely continued with haystack[i+n-j+1]
-- and needle[0], otherwise next searh should continue with
-- haystack[i] and needle[0], or fallback to other
-- shifting rules such as KMP.
--
-- The algorithm is very simple: for a given Word8 w, we
-- set the bloom's bit at unsafeShiftL 0x01 (w .&. 0x3f), so
-- there're three false positives per bit. This's particularly suitable
-- for search UTF-8 bytes since the significant bits of a beginning byte
-- is usually the same.
sundayBloom :: Bytes -> Word64
-- | O(1) Test if a bloom filter contain a certain Word8.
elemSundayBloom :: Word64 -> Word8 -> Bool
-- | Various combinators works on Vec class instances.
module Std.Data.Vector.Extra
-- | O(n) cons is analogous to (:) for lists, but of
-- different complexity, as it requires making a copy.
cons :: Vec v a => a -> v a -> v a
-- | O(n) Append a byte to the end of a vector
snoc :: Vec v a => v a -> a -> v a
-- | O(1) Extract the head and tail of a vector, return
-- Nothing if it is empty.
uncons :: Vec v a => v a -> Maybe (a, v a)
-- | O(1) Extract the init and last of a vector, return
-- Nothing if vector is empty.
unsnoc :: Vec v a => v a -> Maybe (v a, a)
-- | O(1) Extract the first element of a vector.
headMaybe :: Vec v a => v a -> Maybe a
-- | O(1) Extract the elements after the head of a vector.
--
-- NOTE: tailMayEmpty return empty vector in the case of an empty
-- vector.
tailMayEmpty :: Vec v a => v a -> v a
-- | O(1) Extract the last element of a vector.
lastMaybe :: Vec v a => v a -> Maybe a
-- | O(1) Extract the elements before of the last one.
--
-- NOTE: initMayEmpty return empty vector in the case of an empty
-- vector.
initMayEmpty :: Vec v a => v a -> v a
-- | O(n) Return all initial segments of the given vector, empty
-- first.
inits :: Vec v a => v a -> [v a]
-- | O(n) Return all final segments of the given vector, whole
-- vector first.
tails :: Vec v a => v a -> [v a]
-- | O(1) take n, applied to a vector xs,
-- returns the prefix of xs of length n, or xs
-- itself if n > length xs.
take :: Vec v a => Int -> v a -> v a
-- | O(1) drop n xs returns the suffix of
-- xs after the first n elements, or [] if
-- n > length xs.
drop :: Vec v a => Int -> v a -> v a
-- | O(1) takeR n, applied to a vector xs,
-- returns the suffix of xs of length n, or xs
-- itself if n > length xs.
takeR :: Vec v a => Int -> v a -> v a
-- | O(1) dropR n xs returns the prefix of
-- xs before the last n elements, or [] if
-- n > length xs.
dropR :: Vec v a => Int -> v a -> v a
-- | O(1) Extract a sub-range vector with give start index and
-- length.
--
-- This function is a total function just like 'take/drop', index/length
-- exceeds range will be ingored, e.g.
--
--
-- slice 1 3 "hello" == "ell"
-- slice -1 -1 "hello" == ""
-- slice -2 2 "hello" == ""
-- slice 2 10 "hello" == "llo"
--
--
-- This holds for all x y: slice x y vs == drop x . take (x+y)
-- vs
slice :: Vec v a => Int -> Int -> v a -> v a
-- | O(1) splitAt n xs is equivalent to
-- (take n xs, drop n xs).
splitAt :: Vec v a => Int -> v a -> (v a, v a)
-- | O(n) Applied to a predicate p and a vector
-- vs, returns the longest prefix (possibly empty) of
-- vs of elements that satisfy p.
takeWhile :: Vec v a => (a -> Bool) -> v a -> v a
-- | O(n) Applied to a predicate p and a vector
-- vs, returns the longest suffix (possibly empty) of
-- vs of elements that satisfy p.
takeWhileR :: Vec v a => (a -> Bool) -> v a -> v a
-- | O(n) Applied to a predicate p and a vector
-- vs, returns the suffix (possibly empty) remaining after
-- takeWhile p vs.
dropWhile :: Vec v a => (a -> Bool) -> v a -> v a
-- | O(n) Applied to a predicate p and a vector
-- vs, returns the prefix (possibly empty) remaining before
-- takeWhileR p vs.
dropWhileR :: Vec v a => (a -> Bool) -> v a -> v a
-- | O(n) dropAround f = dropWhile f . dropWhileR f
dropAround :: Vec v a => (a -> Bool) -> v a -> v a
-- | O(n) Split the vector into the longest prefix of elements that
-- do not satisfy the predicate and the rest without copying.
break :: Vec v a => (a -> Bool) -> v a -> (v a, v a)
-- | O(n) Split the vector into the longest prefix of elements that
-- satisfy the predicate and the rest without copying.
span :: Vec v a => (a -> Bool) -> v a -> (v a, v a)
-- | breakR behaves like break but from the end of the
-- vector.
--
--
-- breakR p == spanR (not.p)
--
breakR :: Vec v a => (a -> Bool) -> v a -> (v a, v a)
-- | spanR behaves like span but from the end of the vector.
spanR :: Vec v a => (a -> Bool) -> v a -> (v a, v a)
-- | Break a vector on a subvector, returning a pair of the part of the
-- vector prior to the match, and the rest of the vector, e.g.
--
--
-- break "wor" "hello, world" = ("hello, ", "world")
--
breakOn :: (Vec v a, Eq a) => v a -> v a -> (v a, v a)
group :: (Vec v a, Eq a) => v a -> [v a]
groupBy :: Vec v a => (a -> a -> Bool) -> v a -> [v a]
-- | O(n) The stripPrefix function takes two vectors and
-- returns Just the remainder of the second iff the first is its
-- prefix, and otherwise Nothing.
stripPrefix :: (Vec v a, Eq (v a)) => v a -> v a -> Maybe (v a)
-- | O(n) The stripSuffix function takes two vectors and returns
-- Just the remainder of the second iff the first is its suffix, and
-- otherwise Nothing.
stripSuffix :: (Vec v a, Eq (v a)) => v a -> v a -> Maybe (v a)
-- | O(n) Break a vector into pieces separated by the delimiter
-- element consuming the delimiter. I.e.
--
--
-- split '\n' "a\nb\nd\ne" == ["a","b","d","e"]
-- split 'a' "aXaXaXa" == ["","X","X","X",""]
-- split 'x' "x" == ["",""]
--
--
-- and
--
--
-- intercalate [c] . split c == id
-- split == splitWith . (==)
--
--
-- NOTE, this function behavior different with bytestring's. see
-- #56.
split :: (Vec v a, Eq a) => a -> v a -> [v a]
-- | O(n) Splits a vector into components delimited by separators,
-- where the predicate returns True for a separator element. The
-- resulting components do not contain the separators. Two adjacent
-- separators result in an empty component in the output. eg.
--
--
-- splitWith (=='a') "aabbaca" == ["","","bb","c",""]
-- splitWith (=='a') [] == [""]
--
--
-- NOTE, this function behavior different with bytestring's. see
-- #56.
splitWith :: Vec v a => (a -> Bool) -> v a -> [v a]
-- | O(m+n) Break haystack into pieces separated by needle.
--
-- Note: An empty needle will essentially split haystack element by
-- element.
--
-- Examples:
--
--
-- >>> splitOn "\r\n" "a\r\nb\r\nd\r\ne"
-- ["a","b","d","e"]
--
--
--
-- >>> splitOn "aaa" "aaaXaaaXaaaXaaa"
-- ["","X","X","X",""]
--
--
--
-- >>> splitOn "x" "x"
-- ["",""]
--
--
-- and
--
--
-- intercalate s . splitOn s == id
-- splitOn (singleton c) == split (==c)
--
splitOn :: (Vec v a, Eq a) => v a -> v a -> [v a]
-- | The isPrefix function returns True if the first
-- argument is a prefix of the second.
isPrefixOf :: (Vec v a, Eq (v a)) => v a -> v a -> Bool
-- | O(n) The isSuffixOf function takes two vectors and
-- returns True if the first is a suffix of the second.
isSuffixOf :: (Vec v a, Eq (v a)) => v a -> v a -> Bool
-- | Check whether one vector is a subvector of another.
--
-- needle isInfixOf haystack === null haystack || indices
-- needle haystake /= [].
isInfixOf :: (Vec v a, Eq a) => v a -> v a -> Bool
-- | O(n) Find the longest non-empty common prefix of two strings
-- and return it, along with the suffixes of each string at which they no
-- longer match. e.g.
--
--
-- >>> commonPrefix "foobar" "fooquux"
-- ("foo","bar","quux")
--
--
--
-- >>> commonPrefix "veeble" "fetzer"
-- ("","veeble","fetzer")
--
commonPrefix :: (Vec v a, Eq a) => v a -> v a -> (v a, v a, v a)
-- | O(n) Breaks a Bytes up into a list of words, delimited
-- by ascii space.
words :: Bytes -> [Bytes]
-- | O(n) Breaks a Bytes up into a list of lines, delimited
-- by ascii n.
lines :: Bytes -> [Bytes]
-- | O(n) Joins words with ascii space.
unwords :: [Bytes] -> Bytes
-- | O(n) Joins lines with ascii n.
unlines :: [Bytes] -> Bytes
-- | Add padding to the left so that the whole vector's length is at least
-- n.
padLeft :: Vec v a => Int -> a -> v a -> v a
-- | Add padding to the right so that the whole vector's length is at least
-- n.
padRight :: Vec v a => Int -> a -> v a -> v a
-- | O(n) reverse vs efficiently returns the
-- elements of xs in reverse order.
reverse :: forall v a. Vec v a => v a -> v a
-- | O(n) The intersperse function takes an element and a
-- vector and `intersperses' that element between the elements of the
-- vector. It is analogous to the intersperse function on Lists.
intersperse :: forall v a. Vec v a => a -> v a -> v a
-- | O(n) The intercalate function takes a vector and a list
-- of vectors and concatenates the list after interspersing the first
-- argument between each element of the list.
--
-- Note: intercalate will force the entire vector list.
intercalate :: Vec v a => v a -> [v a] -> v a
-- | O(n) An efficient way to join vector with an element.
intercalateElem :: Vec v a => a -> [v a] -> v a
-- | The transpose function transposes the rows and columns of its
-- vector argument.
transpose :: Vec v a => [v a] -> [v a]
-- | zipWith' zip two vector with a zipping function.
--
-- For example, zipWith (+) is applied to two vector to
-- produce a vector of corresponding sums, the result will be evaluated
-- strictly.
zipWith' :: (Vec v a, Vec u b, Vec w c) => (a -> b -> c) -> v a -> u b -> w c
-- | unzipWith' disassemble a vector with a disassembling function,
--
-- The results inside tuple will be evaluated strictly.
unzipWith' :: (Vec v a, Vec u b, Vec w c) => (a -> (b, c)) -> v a -> (u b, w c)
-- | scanl' is similar to foldl, but returns a list of
-- successive reduced values from the left.
--
--
-- scanl' f z [x1, x2, ...] == [z, z `f` x1, (z `f` x1) `f` x2, ...]
--
--
-- Note that
--
--
-- lastM (scanl' f z xs) == Just (foldl f z xs).
--
scanl' :: forall v u a b. (Vec v a, Vec u b) => (b -> a -> b) -> b -> v a -> u b
-- | 'scanl1\'' is a variant of scanl that has no starting value
-- argument.
--
--
-- scanl1' f [x1, x2, ...] == [x1, x1 `f` x2, ...]
-- scanl1' f [] == []
--
scanl1' :: forall v a. Vec v a => (a -> a -> a) -> v a -> v a
-- | scanr' is the right-to-left dual of scanl'.
scanr' :: forall v u a b. (Vec v a, Vec u b) => (a -> b -> b) -> b -> v a -> u b
-- | scanr1' is a variant of scanr that has no starting value
-- argument.
scanr1' :: forall v a. Vec v a => (a -> a -> a) -> v a -> v a
-- | x' = rangeCut x min max limit x' 's range to
-- min ~ max.
rangeCut :: Int -> Int -> Int -> Int
-- | O(1) Extract the first element of a vector.
--
-- Throw EmptyVector if vector is empty.
head :: (Vec v a, HasCallStack) => v a -> a
-- | O(1) Extract the elements after the head of a vector.
--
-- Throw EmptyVector if vector is empty.
tail :: (Vec v a, HasCallStack) => v a -> v a
-- | O(1) Extract the elements before of the last one.
--
-- Throw EmptyVector if vector is empty.
init :: (Vec v a, HasCallStack) => v a -> v a
-- | O(1) Extract the last element of a vector.
--
-- Throw EmptyVector if vector is empty.
last :: (Vec v a, HasCallStack) => v a -> a
-- | O(1) Index array element.
--
-- Throw IndexOutOfVectorRange if index outside of the vector.
index :: (Vec v a, HasCallStack) => v a -> Int -> a
-- | O(1) Extract the first element of a vector.
--
-- Make sure vector is non-empty, otherwise segmentation fault await!
unsafeHead :: Vec v a => v a -> a
-- | O(1) Extract the elements after the head of a vector.
--
-- Make sure vector is non-empty, otherwise segmentation fault await!
unsafeTail :: Vec v a => v a -> v a
-- | O(1) Extract the elements before of the last one.
--
-- Make sure vector is non-empty, otherwise segmentation fault await!
unsafeInit :: Vec v a => v a -> v a
-- | O(1) Extract the last element of a vector.
--
-- Make sure vector is non-empty, otherwise segmentation fault await!
unsafeLast :: Vec v a => v a -> a
-- | O(1) Index array element.
--
-- Make sure index is in bound, otherwise segmentation fault await!
unsafeIndex :: Vec v a => v a -> Int -> a
-- | O(1) take n, applied to a vector xs,
-- returns the prefix of xs of length n.
--
-- Make sure n is smaller than vector's length, otherwise segmentation
-- fault await!
unsafeTake :: Vec v a => Int -> v a -> v a
-- | O(1) drop n xs returns the suffix of
-- xs after the first n elements.
--
-- Make sure n is smaller than vector's length, otherwise segmentation
-- fault await!
unsafeDrop :: Vec v a => Int -> v a -> v a
-- | This module provide three stable sorting algorithms, which are:
--
--
-- - mergeSort, a O(log(n)) general-purpose sorting
-- algorithms for all different size vectors.
-- - insertSort a O(n^2) sorting algorithms suitable for
-- very small vectors.
-- - radixSort a O(n) sorting algorithms based on
-- Radix instance, which is prefered on large vectors.
--
--
-- Sorting is always performed in ascending order. To reverse the order,
-- either use XXSortBy or use Down, RadixDown
-- newtypes. In general changing comparing functions can be done by
-- creating auxiliary newtypes and Ord instances (make sure you
-- inline instance's method for performence!). Or Radix instances
-- in radixSort case, for example:
--
--
-- data Foo = Foo { key :: Int16, ... }
--
-- instance Radix Foo where
-- -- You should add INLINE pragmas to following methods
-- bucketSize = bucketSize . key
-- passes = passes . key
-- radixLSB = radixLSB . key
-- radix i = radix i . key
-- radixMSB = radixMSB . key
--
module Std.Data.Vector.Sort
-- | O(n*log(n)) Sort vector based on element's Ord instance
-- with classic mergesort algorithm.
--
-- This is a stable sort, During sorting two O(n) worker arrays are
-- needed, one of them will be freezed into the result vector. The merge
-- sort only begin at tile size larger than mergeTileSize, each
-- tile will be sorted with insertSort, then iteratively merged
-- into larger array, until all elements are sorted.
mergeSort :: forall v a. (Vec v a, Ord a) => v a -> v a
mergeSortBy :: forall v a. Vec v a => (a -> a -> Ordering) -> v a -> v a
-- | The mergesort tile size, mergeTileSize = 16.
mergeTileSize :: Int
-- | O(n^2) Sort vector based on element's Ord instance with
-- simple insertion-sort algorithm.
--
-- This is a stable sort. O(n) extra space are needed, which will be
-- freezed into result vector.
insertSort :: (Vec v a, Ord a) => v a -> v a
insertSortBy :: Vec v a => (a -> a -> Ordering) -> v a -> v a
-- | The Down type allows you to reverse sort order conveniently. A
-- value of type Down a contains a value of type
-- a (represented as Down a). If a has
-- an Ord instance associated with it then comparing two
-- values thus wrapped will give you the opposite of their normal sort
-- order. This is particularly useful when sorting in generalised list
-- comprehensions, as in: then sortWith by Down x
newtype Down a
Down :: a -> Down a
-- | O(n) Sort vector based on element's Radix instance with
-- radix-sort, (Least significant digit radix sorts variation).
--
-- This is a stable sort, one or two extra O(n) worker array are need
-- depend on how many passes shall be performed, and a
-- bucketSize counting bucket are also needed. This sort
-- algorithms performed extremly well on small byte size types such as
-- Int8 or Word8, while on larger type, constant passes may
-- render this algorithm not suitable for small vectors (turning point
-- around 2^(2*passes)).
radixSort :: forall v a. (Vec v a, Radix a) => v a -> v a
-- | Types contain radixs, which can be inspected with radix during
-- different passes.
--
-- The default instances share a same bucketSize 256, which seems
-- to be a good default.
class Radix a
-- | The size of an auxiliary array, i.e. the counting bucket
bucketSize :: Radix a => a -> Int
-- | The number of passes necessary to sort an array of es, it equals to
-- the key's byte number.
passes :: Radix a => a -> Int
-- | The radix function used in the first pass, works on the least
-- significant bit.
radixLSB :: Radix a => a -> Int
-- | The radix function parameterized by the current pass (0 < pass <
-- passes e-1).
radix :: Radix a => Int -> a -> Int
-- | The radix function used in the last pass, works on the most
-- significant bit.
radixMSB :: Radix a => a -> Int
-- | Similar to Down newtype for Ord, this newtype can
-- inverse the order of a Radix instance when used in
-- radixSort.
newtype RadixDown a
RadixDown :: a -> RadixDown a
instance Data.Primitive.Types.Prim a => Data.Primitive.Types.Prim (Std.Data.Vector.Sort.RadixDown a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Std.Data.Vector.Sort.RadixDown a)
instance GHC.Show.Show a => GHC.Show.Show (Std.Data.Vector.Sort.RadixDown a)
instance Std.Data.Vector.Sort.Radix a => Std.Data.Vector.Sort.Radix (Std.Data.Vector.Sort.RadixDown a)
instance Std.Data.Vector.Sort.Radix GHC.Int.Int8
instance Std.Data.Vector.Sort.Radix GHC.Types.Int
instance Std.Data.Vector.Sort.Radix GHC.Int.Int16
instance Std.Data.Vector.Sort.Radix GHC.Int.Int32
instance Std.Data.Vector.Sort.Radix GHC.Int.Int64
instance Std.Data.Vector.Sort.Radix GHC.Word.Word8
instance Std.Data.Vector.Sort.Radix GHC.Types.Word
instance Std.Data.Vector.Sort.Radix GHC.Word.Word16
instance Std.Data.Vector.Sort.Radix GHC.Word.Word32
instance Std.Data.Vector.Sort.Radix GHC.Word.Word64
-- | This module provide fast boxed and unboxed vector with unified
-- interface. The API is similar to bytestring and vector. If you find
-- missing functions, please report!
--
-- Performance consideration:
--
--
--
-- Since all functions works on more general types, inlining and
-- specialization are the keys to achieve high performance, e.g. the
-- performance gap between running in GHCi and compiled binary may be
-- huge due to dictionary passing. If there're cases that GHC fail to
-- specialized these functions, it should be regarded as a bug either in
-- this library or GHC.
module Std.Data.Vector
-- | Typeclass for box and unboxed vectors, which are created by slicing
-- arrays.
class (Arr (MArray v) (IArray v) a) => Vec v a where {
-- | Vector's mutable array type
type family MArray v = (marr :: * -> * -> *) | marr -> v;
-- | Vector's immutable array type
type family IArray v = (iarr :: * -> *) | iarr -> v;
}
-- | Boxed vector
data Vector a
-- | Primitive vector
data PrimVector a
-- | Bytes is just primitive word8 vectors.
type Bytes = PrimVector Word8
packASCII :: String -> Bytes
-- | O(1). The empty vector.
empty :: Vec v a => v a
-- | O(1). Single element vector.
singleton :: Vec v a => a -> v a
-- | O(n). Copy a vector from slice.
copy :: Vec v a => v a -> v a
-- | O(n) Convert a list into a vector
--
-- Alias for packN defaultInitSize.
pack :: Vec v a => [a] -> v a
-- | O(n) Convert a list into a vector with an approximate size.
--
-- If the list's length is large than the size given, we simply double
-- the buffer size and continue building.
--
-- This function is a good consumer in the sense of build/foldr
-- fusion.
packN :: forall v a. Vec v a => Int -> [a] -> v a
-- | O(n) Alias for packRN defaultInitSize.
packR :: Vec v a => [a] -> v a
-- | O(n) packN in reverse order.
--
-- This function is a good consumer in the sense of build/foldr
-- fusion.
packRN :: forall v a. Vec v a => Int -> [a] -> v a
-- | O(n) Convert vector to a list.
--
-- Unpacking is done lazily. i.e. we will retain reference to the array
-- until all element are consumed.
--
-- This function is a good producer in the sense of build/foldr
-- fusion.
unpack :: Vec v a => v a -> [a]
-- | O(n) Convert vector to a list in reverse order.
--
-- This function is a good producer in the sense of build/foldr
-- fusion.
unpackR :: Vec v a => v a -> [a]
-- | O(1) Test whether a vector is empty.
null :: Vec v a => v a -> Bool
-- | O(1) The length of a vector.
length :: Vec v a => v a -> Int
-- | O(m+n)
--
-- There's no need to guard empty vector because we guard them for you,
-- so appending empty vectors are no-ops.
append :: Vec v a => v a -> v a -> v a
-- | Mapping between vectors (possiblely with two different vector types).
--
-- NOTE, the result vector contain thunks in lifted Vector case,
-- use map' if that's not desired.
--
-- For PrimVector, map and map' are same, since
-- PrimVectors never store thunks.
map :: forall u v a b. (Vec u a, Vec v b) => (a -> b) -> u a -> v b
-- | Mapping between vectors (possiblely with two different vector types).
--
-- This is the strict version map. Note that the Functor instance
-- of lifted Vector is defined with map to statisfy laws,
-- which this strict version breaks (map' id arrayContainsBottom /=
-- arrayContainsBottom ).
map' :: forall u v a b. (Vec u a, Vec v b) => (a -> b) -> u a -> v b
-- | Strict mapping with index.
imap' :: forall u v a b. (Vec u a, Vec v b) => (Int -> a -> b) -> u a -> v b
-- | Strict left to right fold.
foldl' :: Vec v a => (b -> a -> b) -> b -> v a -> b
-- | Strict left to right fold with index.
ifoldl' :: Vec v a => (b -> Int -> a -> b) -> b -> v a -> b
-- | Strict left to right fold using first element as the initial value.
--
-- Throw EmptyVector if vector is empty.
foldl1' :: forall v a. (Vec v a, HasCallStack) => (a -> a -> a) -> v a -> a
-- | Strict left to right fold using first element as the initial value.
-- return Nothing when vector is empty.
foldl1Maybe' :: forall v a. Vec v a => (a -> a -> a) -> v a -> Maybe a
-- | Strict right to left fold
foldr' :: Vec v a => (a -> b -> b) -> b -> v a -> b
-- | Strict right to left fold with index
--
-- NOTE: the index is counting from 0, not backwards
ifoldr' :: Vec v a => (Int -> a -> b -> b) -> b -> v a -> b
-- | Strict right to left fold using last element as the initial value.
--
-- Throw EmptyVector if vector is empty.
foldr1' :: forall v a. (Vec v a, HasCallStack) => (a -> a -> a) -> v a -> a
-- | Strict right to left fold using last element as the initial value,
-- return Nothing when vector is empty.
foldr1Maybe' :: forall v a. Vec v a => (a -> a -> a) -> v a -> Maybe a
-- | O(n) Concatenate a list of vector.
--
-- Note: concat have to force the entire list to filter out empty
-- vector and calculate the length for allocation.
concat :: forall v a. Vec v a => [v a] -> v a
-- | Map a function over a vector and concatenate the results
concatMap :: Vec v a => (a -> v a) -> v a -> v a
-- | O(n) maximum returns the maximum value from a vector,
-- return Nothing in the case of an empty vector.
maximumMaybe :: (Vec v a, Ord a) => v a -> Maybe a
-- | O(n) minimum returns the minimum value from a vector,
-- return Nothing in the case of an empty vector.
minimumMaybe :: (Vec v a, Ord a) => v a -> Maybe a
-- | O(n) sum returns the sum value from a vector
sum :: (Vec v a, Num a) => v a -> a
-- | O(n) count returns count of an element from a
-- vector
count :: (Vec v a, Eq a) => a -> v a -> Int
-- | O(n) product returns the product value from a vector
product :: (Vec v a, Num a) => v a -> a
-- | O(n) product returns the product value from a vector
--
-- This function will shortcut on zero. Note this behavior change the
-- semantics for lifted vector: product [1,0,undefined] /= product'
-- [1,0,undefined].
product' :: (Vec v a, Num a, Eq a) => v a -> a
-- | O(n) Applied to a predicate and a vector, all determines
-- if all elements of the vector satisfy the predicate.
all :: Vec v a => (a -> Bool) -> v a -> Bool
-- | O(n) Applied to a predicate and a vector, any determines
-- if any elements of the vector satisfy the predicate.
any :: Vec v a => (a -> Bool) -> v a -> Bool
-- | The mapAccumL function behaves like a combination of map
-- and foldl; it applies a function to each element of a vector,
-- passing an accumulating parameter from left to right, and returning a
-- final value of this accumulator together with the new list.
--
-- Note, this function will only force the result tuple, not the elements
-- inside, to prevent creating thunks during mapAccumL, seq
-- your accumulator and result with the result tuple.
mapAccumL :: forall u v a b c. (Vec u b, Vec v c) => (a -> b -> (a, c)) -> a -> u b -> (a, v c)
-- | The mapAccumR function behaves like a combination of map
-- and foldr; it applies a function to each element of a vector,
-- passing an accumulating parameter from right to left, and returning a
-- final value of this accumulator together with the new vector.
--
-- The same strictness property with mapAccumL applys to
-- mapAccumR too.
mapAccumR :: forall u v a b c. (Vec u b, Vec v c) => (a -> b -> (a, c)) -> a -> u b -> (a, v c)
-- | O(n) replicate n x is a vector of length
-- n with x the value of every element.
--
-- Note: replicate will not force the element in boxed vector
-- case.
replicate :: Vec v a => Int -> a -> v a
-- | O(n*m) cycleN a vector n times.
cycleN :: forall v a. Vec v a => Int -> v a -> v a
-- | O(n), where n is the length of the result. The
-- unfoldr function is analogous to the List 'unfoldr'.
-- unfoldr builds a vector from a seed value. The function takes
-- the element and returns Nothing if it is done producing the
-- vector or returns Just (a,b), in which case,
-- a is the next byte in the string, and b is the seed
-- value for further production.
--
-- Examples:
--
--
-- unfoldr (\x -> if x <= 5 then Just (x, x + 1) else Nothing) 0
-- == pack [0, 1, 2, 3, 4, 5]
--
unfoldr :: Vec u b => (a -> Maybe (b, a)) -> a -> u b
-- | O(n) Like unfoldr, unfoldrN builds a vector from
-- a seed value. However, the length of the result is limited by the
-- first argument to unfoldrN. This function is more efficient
-- than unfoldr when the maximum length of the result is known.
--
-- The following equation relates unfoldrN and unfoldr:
--
--
-- fst (unfoldrN n f s) == take n (unfoldr f s)
--
unfoldrN :: forall v a b. Vec v b => Int -> (a -> Maybe (b, a)) -> a -> (v b, Maybe a)
-- | O(n) elem test if given element is in given vector.
elem :: (Vec v a, Eq a) => a -> v a -> Bool
-- | O(n) 'not . elem'
notElem :: (Vec v a, Eq a) => a -> v a -> Bool
-- | O(n) The elemIndex function returns the index of the
-- first element in the given vector which is equal to the query element,
-- or Nothing if there is no such element.
elemIndex :: (Vec v a, Eq a) => a -> v a -> Maybe Int
-- | O(n) cons is analogous to (:) for lists, but of
-- different complexity, as it requires making a copy.
cons :: Vec v a => a -> v a -> v a
-- | O(n) Append a byte to the end of a vector
snoc :: Vec v a => v a -> a -> v a
-- | O(1) Extract the head and tail of a vector, return
-- Nothing if it is empty.
uncons :: Vec v a => v a -> Maybe (a, v a)
-- | O(1) Extract the init and last of a vector, return
-- Nothing if vector is empty.
unsnoc :: Vec v a => v a -> Maybe (v a, a)
-- | O(1) Extract the first element of a vector.
headMaybe :: Vec v a => v a -> Maybe a
-- | O(1) Extract the elements after the head of a vector.
--
-- NOTE: tailMayEmpty return empty vector in the case of an empty
-- vector.
tailMayEmpty :: Vec v a => v a -> v a
-- | O(1) Extract the last element of a vector.
lastMaybe :: Vec v a => v a -> Maybe a
-- | O(1) Extract the elements before of the last one.
--
-- NOTE: initMayEmpty return empty vector in the case of an empty
-- vector.
initMayEmpty :: Vec v a => v a -> v a
-- | O(n) Return all initial segments of the given vector, empty
-- first.
inits :: Vec v a => v a -> [v a]
-- | O(n) Return all final segments of the given vector, whole
-- vector first.
tails :: Vec v a => v a -> [v a]
-- | O(1) take n, applied to a vector xs,
-- returns the prefix of xs of length n, or xs
-- itself if n > length xs.
take :: Vec v a => Int -> v a -> v a
-- | O(1) drop n xs returns the suffix of
-- xs after the first n elements, or [] if
-- n > length xs.
drop :: Vec v a => Int -> v a -> v a
-- | O(1) takeR n, applied to a vector xs,
-- returns the suffix of xs of length n, or xs
-- itself if n > length xs.
takeR :: Vec v a => Int -> v a -> v a
-- | O(1) dropR n xs returns the prefix of
-- xs before the last n elements, or [] if
-- n > length xs.
dropR :: Vec v a => Int -> v a -> v a
-- | O(1) Extract a sub-range vector with give start index and
-- length.
--
-- This function is a total function just like 'take/drop', index/length
-- exceeds range will be ingored, e.g.
--
--
-- slice 1 3 "hello" == "ell"
-- slice -1 -1 "hello" == ""
-- slice -2 2 "hello" == ""
-- slice 2 10 "hello" == "llo"
--
--
-- This holds for all x y: slice x y vs == drop x . take (x+y)
-- vs
slice :: Vec v a => Int -> Int -> v a -> v a
-- | O(1) splitAt n xs is equivalent to
-- (take n xs, drop n xs).
splitAt :: Vec v a => Int -> v a -> (v a, v a)
-- | O(n) Applied to a predicate p and a vector
-- vs, returns the longest prefix (possibly empty) of
-- vs of elements that satisfy p.
takeWhile :: Vec v a => (a -> Bool) -> v a -> v a
-- | O(n) Applied to a predicate p and a vector
-- vs, returns the longest suffix (possibly empty) of
-- vs of elements that satisfy p.
takeWhileR :: Vec v a => (a -> Bool) -> v a -> v a
-- | O(n) Applied to a predicate p and a vector
-- vs, returns the suffix (possibly empty) remaining after
-- takeWhile p vs.
dropWhile :: Vec v a => (a -> Bool) -> v a -> v a
-- | O(n) Applied to a predicate p and a vector
-- vs, returns the prefix (possibly empty) remaining before
-- takeWhileR p vs.
dropWhileR :: Vec v a => (a -> Bool) -> v a -> v a
-- | O(n) dropAround f = dropWhile f . dropWhileR f
dropAround :: Vec v a => (a -> Bool) -> v a -> v a
-- | O(n) Split the vector into the longest prefix of elements that
-- do not satisfy the predicate and the rest without copying.
break :: Vec v a => (a -> Bool) -> v a -> (v a, v a)
-- | O(n) Split the vector into the longest prefix of elements that
-- satisfy the predicate and the rest without copying.
span :: Vec v a => (a -> Bool) -> v a -> (v a, v a)
-- | breakR behaves like break but from the end of the
-- vector.
--
--
-- breakR p == spanR (not.p)
--
breakR :: Vec v a => (a -> Bool) -> v a -> (v a, v a)
-- | spanR behaves like span but from the end of the vector.
spanR :: Vec v a => (a -> Bool) -> v a -> (v a, v a)
-- | Break a vector on a subvector, returning a pair of the part of the
-- vector prior to the match, and the rest of the vector, e.g.
--
--
-- break "wor" "hello, world" = ("hello, ", "world")
--
breakOn :: (Vec v a, Eq a) => v a -> v a -> (v a, v a)
group :: (Vec v a, Eq a) => v a -> [v a]
groupBy :: Vec v a => (a -> a -> Bool) -> v a -> [v a]
-- | O(n) The stripPrefix function takes two vectors and
-- returns Just the remainder of the second iff the first is its
-- prefix, and otherwise Nothing.
stripPrefix :: (Vec v a, Eq (v a)) => v a -> v a -> Maybe (v a)
-- | O(n) The stripSuffix function takes two vectors and returns
-- Just the remainder of the second iff the first is its suffix, and
-- otherwise Nothing.
stripSuffix :: (Vec v a, Eq (v a)) => v a -> v a -> Maybe (v a)
-- | O(n) Break a vector into pieces separated by the delimiter
-- element consuming the delimiter. I.e.
--
--
-- split '\n' "a\nb\nd\ne" == ["a","b","d","e"]
-- split 'a' "aXaXaXa" == ["","X","X","X",""]
-- split 'x' "x" == ["",""]
--
--
-- and
--
--
-- intercalate [c] . split c == id
-- split == splitWith . (==)
--
--
-- NOTE, this function behavior different with bytestring's. see
-- #56.
split :: (Vec v a, Eq a) => a -> v a -> [v a]
-- | O(n) Splits a vector into components delimited by separators,
-- where the predicate returns True for a separator element. The
-- resulting components do not contain the separators. Two adjacent
-- separators result in an empty component in the output. eg.
--
--
-- splitWith (=='a') "aabbaca" == ["","","bb","c",""]
-- splitWith (=='a') [] == [""]
--
--
-- NOTE, this function behavior different with bytestring's. see
-- #56.
splitWith :: Vec v a => (a -> Bool) -> v a -> [v a]
-- | O(m+n) Break haystack into pieces separated by needle.
--
-- Note: An empty needle will essentially split haystack element by
-- element.
--
-- Examples:
--
--
-- >>> splitOn "\r\n" "a\r\nb\r\nd\r\ne"
-- ["a","b","d","e"]
--
--
--
-- >>> splitOn "aaa" "aaaXaaaXaaaXaaa"
-- ["","X","X","X",""]
--
--
--
-- >>> splitOn "x" "x"
-- ["",""]
--
--
-- and
--
--
-- intercalate s . splitOn s == id
-- splitOn (singleton c) == split (==c)
--
splitOn :: (Vec v a, Eq a) => v a -> v a -> [v a]
-- | The isPrefix function returns True if the first
-- argument is a prefix of the second.
isPrefixOf :: (Vec v a, Eq (v a)) => v a -> v a -> Bool
-- | O(n) The isSuffixOf function takes two vectors and
-- returns True if the first is a suffix of the second.
isSuffixOf :: (Vec v a, Eq (v a)) => v a -> v a -> Bool
-- | Check whether one vector is a subvector of another.
--
-- needle isInfixOf haystack === null haystack || indices
-- needle haystake /= [].
isInfixOf :: (Vec v a, Eq a) => v a -> v a -> Bool
-- | O(n) Find the longest non-empty common prefix of two strings
-- and return it, along with the suffixes of each string at which they no
-- longer match. e.g.
--
--
-- >>> commonPrefix "foobar" "fooquux"
-- ("foo","bar","quux")
--
--
--
-- >>> commonPrefix "veeble" "fetzer"
-- ("","veeble","fetzer")
--
commonPrefix :: (Vec v a, Eq a) => v a -> v a -> (v a, v a, v a)
-- | O(n) Breaks a Bytes up into a list of words, delimited
-- by ascii space.
words :: Bytes -> [Bytes]
-- | O(n) Breaks a Bytes up into a list of lines, delimited
-- by ascii n.
lines :: Bytes -> [Bytes]
-- | O(n) Joins words with ascii space.
unwords :: [Bytes] -> Bytes
-- | O(n) Joins lines with ascii n.
unlines :: [Bytes] -> Bytes
-- | Add padding to the left so that the whole vector's length is at least
-- n.
padLeft :: Vec v a => Int -> a -> v a -> v a
-- | Add padding to the right so that the whole vector's length is at least
-- n.
padRight :: Vec v a => Int -> a -> v a -> v a
-- | O(n) reverse vs efficiently returns the
-- elements of xs in reverse order.
reverse :: forall v a. Vec v a => v a -> v a
-- | O(n) The intersperse function takes an element and a
-- vector and `intersperses' that element between the elements of the
-- vector. It is analogous to the intersperse function on Lists.
intersperse :: forall v a. Vec v a => a -> v a -> v a
-- | O(n) The intercalate function takes a vector and a list
-- of vectors and concatenates the list after interspersing the first
-- argument between each element of the list.
--
-- Note: intercalate will force the entire vector list.
intercalate :: Vec v a => v a -> [v a] -> v a
-- | O(n) An efficient way to join vector with an element.
intercalateElem :: Vec v a => a -> [v a] -> v a
-- | The transpose function transposes the rows and columns of its
-- vector argument.
transpose :: Vec v a => [v a] -> [v a]
-- | zipWith' zip two vector with a zipping function.
--
-- For example, zipWith (+) is applied to two vector to
-- produce a vector of corresponding sums, the result will be evaluated
-- strictly.
zipWith' :: (Vec v a, Vec u b, Vec w c) => (a -> b -> c) -> v a -> u b -> w c
-- | unzipWith' disassemble a vector with a disassembling function,
--
-- The results inside tuple will be evaluated strictly.
unzipWith' :: (Vec v a, Vec u b, Vec w c) => (a -> (b, c)) -> v a -> (u b, w c)
-- | scanl' is similar to foldl, but returns a list of
-- successive reduced values from the left.
--
--
-- scanl' f z [x1, x2, ...] == [z, z `f` x1, (z `f` x1) `f` x2, ...]
--
--
-- Note that
--
--
-- lastM (scanl' f z xs) == Just (foldl f z xs).
--
scanl' :: forall v u a b. (Vec v a, Vec u b) => (b -> a -> b) -> b -> v a -> u b
-- | 'scanl1\'' is a variant of scanl that has no starting value
-- argument.
--
--
-- scanl1' f [x1, x2, ...] == [x1, x1 `f` x2, ...]
-- scanl1' f [] == []
--
scanl1' :: forall v a. Vec v a => (a -> a -> a) -> v a -> v a
-- | scanr' is the right-to-left dual of scanl'.
scanr' :: forall v u a b. (Vec v a, Vec u b) => (a -> b -> b) -> b -> v a -> u b
-- | scanr1' is a variant of scanr that has no starting value
-- argument.
scanr1' :: forall v a. Vec v a => (a -> a -> a) -> v a -> v a
-- | O(n) find the first index and element matching the predicate in
-- a vector from left to right, if there isn't one, return (length of the
-- vector, Nothing).
find :: Vec v a => (a -> Bool) -> v a -> (Int, Maybe a)
-- | O(n) find the first index and element matching the predicate in
-- a vector from right to left, if there isn't one, return '(-1,
-- Nothing)'.
findR :: Vec v a => (a -> Bool) -> v a -> (Int, Maybe a)
-- | The findIndex function takes a predicate and a vector and
-- returns the index of the first element in the vector satisfying the
-- predicate.
findIndices :: Vec v a => (a -> Bool) -> v a -> [Int]
-- | O(n) The elemIndices function extends elemIndex,
-- by returning the indices of all elements equal to the query element,
-- in ascending order.
elemIndices :: (Vec v a, Eq a) => a -> v a -> [Int]
-- | O(n) filter, applied to a predicate and a vector,
-- returns a vector containing those elements that satisfy the predicate.
filter :: forall v a. Vec v a => (a -> Bool) -> v a -> v a
-- | O(n) The partition function takes a predicate, a vector,
-- returns a pair of vector with elements which do and do not satisfy the
-- predicate, respectively; i.e.,
--
--
-- partition p vs == (filter p vs, filter (not . p) vs)
--
partition :: forall v a. Vec v a => (a -> Bool) -> v a -> (v a, v a)
-- | O(n+m) Find the offsets of all indices (possibly overlapping)
-- of needle within haystack using KMP algorithm.
--
-- The KMP algorithm need pre-calculate a shift table in O(m) time
-- and space, the worst case time complexity is O(n+m). Partial
-- apply this function to reuse pre-calculated table between same
-- needles.
--
-- Chunked input are support via partial match argument, if set we will
-- return an extra negative index in case of partial match at the end of
-- input chunk, e.g.
--
--
-- indicesOverlapping [ascii|ada|] [ascii|adadad|] True == [0,2,-2]
--
--
-- Where -2 is the length of the partial match part ad
-- 's negation.
--
-- If an empty pattern is supplied, we will return every possible index
-- of haystack, e.g.
--
--
-- indicesOverlapping "" "abc" = [0,1,2]
--
--
-- References:
--
--
indicesOverlapping :: (Vec v a, Eq a) => v a -> v a -> Bool -> [Int]
-- | O(n+m) Find the offsets of all non-overlapping indices of
-- needle within haystack using KMP algorithm.
--
-- If an empty pattern is supplied, we will return every possible index
-- of haystack, e.g.
--
--
-- indicesOverlapping "" "abc" = [0,1,2]
--
indices :: (Vec v a, Eq a) => v a -> v a -> Bool -> [Int]
-- | O(n*log(n)) Sort vector based on element's Ord instance
-- with classic mergesort algorithm.
--
-- This is a stable sort, During sorting two O(n) worker arrays are
-- needed, one of them will be freezed into the result vector. The merge
-- sort only begin at tile size larger than mergeTileSize, each
-- tile will be sorted with insertSort, then iteratively merged
-- into larger array, until all elements are sorted.
mergeSort :: forall v a. (Vec v a, Ord a) => v a -> v a
mergeSortBy :: forall v a. Vec v a => (a -> a -> Ordering) -> v a -> v a
-- | The mergesort tile size, mergeTileSize = 16.
mergeTileSize :: Int
-- | O(n^2) Sort vector based on element's Ord instance with
-- simple insertion-sort algorithm.
--
-- This is a stable sort. O(n) extra space are needed, which will be
-- freezed into result vector.
insertSort :: (Vec v a, Ord a) => v a -> v a
insertSortBy :: Vec v a => (a -> a -> Ordering) -> v a -> v a
-- | The Down type allows you to reverse sort order conveniently. A
-- value of type Down a contains a value of type
-- a (represented as Down a). If a has
-- an Ord instance associated with it then comparing two
-- values thus wrapped will give you the opposite of their normal sort
-- order. This is particularly useful when sorting in generalised list
-- comprehensions, as in: then sortWith by Down x
newtype Down a
Down :: a -> Down a
-- | O(n) Sort vector based on element's Radix instance with
-- radix-sort, (Least significant digit radix sorts variation).
--
-- This is a stable sort, one or two extra O(n) worker array are need
-- depend on how many passes shall be performed, and a
-- bucketSize counting bucket are also needed. This sort
-- algorithms performed extremly well on small byte size types such as
-- Int8 or Word8, while on larger type, constant passes may
-- render this algorithm not suitable for small vectors (turning point
-- around 2^(2*passes)).
radixSort :: forall v a. (Vec v a, Radix a) => v a -> v a
-- | Types contain radixs, which can be inspected with radix during
-- different passes.
--
-- The default instances share a same bucketSize 256, which seems
-- to be a good default.
class Radix a
-- | The size of an auxiliary array, i.e. the counting bucket
bucketSize :: Radix a => a -> Int
-- | The number of passes necessary to sort an array of es, it equals to
-- the key's byte number.
passes :: Radix a => a -> Int
-- | The radix function used in the first pass, works on the least
-- significant bit.
radixLSB :: Radix a => a -> Int
-- | The radix function parameterized by the current pass (0 < pass <
-- passes e-1).
radix :: Radix a => Int -> a -> Int
-- | The radix function used in the last pass, works on the most
-- significant bit.
radixMSB :: Radix a => a -> Int
-- | Similar to Down newtype for Ord, this newtype can
-- inverse the order of a Radix instance when used in
-- radixSort.
newtype RadixDown a
RadixDown :: a -> RadixDown a
ascii :: QuasiQuoter
vecW8 :: QuasiQuoter
vecW16 :: QuasiQuoter
vecW32 :: QuasiQuoter
vecW64 :: QuasiQuoter
vecWord :: QuasiQuoter
vecI8 :: QuasiQuoter
vecI16 :: QuasiQuoter
vecI32 :: QuasiQuoter
vecI64 :: QuasiQuoter
vecInt :: QuasiQuoter
-- | Index pair type to help GHC unpack in some loops, useful when write
-- fast folds.
data IPair a
IPair :: {-# UNPACK #-} !Int -> a -> IPair a
data VectorException
IndexOutOfVectorRange :: {-# UNPACK #-} !Int -> CallStack -> VectorException
EmptyVector :: CallStack -> VectorException
-- | Cast between vectors
castVector :: (Vec v a, Cast a b) => v a -> v b
-- | This module provide low resolution (0.1s) timers using a timing wheel
-- of size 128 per capability, each timer thread will automatically
-- started or stopped based on demannd. register or cancel a timeout is
-- O(1), and each step only need scan n/128 items given timers are
-- registered in an even fashion.
--
-- This timer is particularly suitable for high concurrent approximated
-- IO timeout scheduling. You should not rely on it to provide timing
-- information since it's very inaccurate.
--
-- Reference:
--
--
module Std.IO.LowResTimer
-- | Register a new timer on current capability's timer manager, start the
-- timing wheel if it's not turning.
--
-- If the action could block, you may want to run it in another thread.
-- Example to kill a thread after 10s:
--
--
-- registerLowResTimer 100 (forkIO $ killThread tid)
--
registerLowResTimer :: Int -> IO () -> IO LowResTimer
-- | void (registerLowResTimer t action)
registerLowResTimer_ :: Int -> IO () -> IO ()
-- | Same as registerLowResTimer, but allow you choose timer
-- manager.
registerLowResTimerOn :: LowResTimerManager -> Int -> IO () -> IO LowResTimer
-- | Timer registered by registerLowResTimer or
-- registerLowResTimerOn.
data LowResTimer
-- | Query how many seconds remain before timer firing.
--
-- A return value <= 0 indictate the timer is firing or fired.
queryLowResTimer :: LowResTimer -> IO Int
-- | Cancel a timer, return the remaining ticks.
--
-- This function have no effect after the timer is fired.
cancelLowResTimer :: LowResTimer -> IO Int
-- |
-- void . cancelLowResTimer
--
cancelLowResTimer_ :: LowResTimer -> IO ()
-- | similar to timeout, this function put a limit on time which an
-- IO can consume.
--
-- Note timeoutLowRes is also implemented with Exception
-- underhood, which can have some surprising effects on some devices,
-- e.g. use timeoutLowRes with reading or writing on
-- UVStreams will close the UVStream once a reading or
-- writing is not able to be done in time.
timeoutLowRes :: Int -> IO a -> IO (Maybe a)
-- | Cache result of an IO action for give time t.
--
-- This combinator is useful when you want to share IO result within a
-- period, the action will be called on demand, and the result will be
-- cached for t milliseconds.
--
-- One common way to get a shared periodical updated value is to start a
-- seperate thread and do calculation periodically, but doing that will
-- stop system from being idle, which stop idle GC from running, and in
-- turn disable deadlock detection, which is too bad. This function
-- solves that.
throttle :: Int -> IO a -> IO (IO a)
-- | Debounce IO action without caching result.
--
-- The IO action will run at leading edge. i.e. once run, during
-- following (t/10)s throttled action will no-ops.
--
-- Note the action will run in the calling thread.
throttle_ :: Int -> IO () -> IO (IO ())
-- | Similar to throttle_ but run action in trailing edge
--
-- The IO action will run at trailing edge. i.e. no matter how many times
-- throttled action are called, original action will run only once after
-- (t/10)s.
--
-- Note the action will be run in a new created thread.
throttleTrailing_ :: Int -> IO () -> IO (IO ())
data LowResTimerManager
-- | Get a LowResTimerManager for current thread.
getLowResTimerManager :: IO LowResTimerManager
-- | Check if a timer manager's wheel is turning
--
-- This is mostly for testing purpose.
isLowResTimerManagerRunning :: LowResTimerManager -> IO Bool
-- | Create new low resolution timer manager on capability change.
--
-- Since low resolution timer manager is not hooked into RTS, you're
-- responsible to call this function after you call
-- setNumCapabilities to match timer manager array size with new
-- capability number.
--
-- This is not a must though, when we fetch timer manager we always take
-- a modulo.
lowResTimerManagerCapabilitiesChanged :: IO ()
instance GHC.Show.Show Std.IO.LowResTimer.TimeOutException
instance GHC.Exception.Type.Exception Std.IO.LowResTimer.TimeOutException
-- | INTERNAL MODULE, provides all libuv errno.
module Std.IO.UV.Errno
uvStdError :: CInt -> IO String
uv_strerror :: CInt -> IO CString
uvErrName :: CInt -> IO String
uv_err_name :: CInt -> IO CString
-- | argument list too long
-- | permission denied
-- | address already in use
-- | address not available
-- | address family not supported
-- | resource temporarily unavailable
-- | address family not supported
-- | temporary failure
-- | bad ai_flags value
-- | invalid value for hints
-- | request canceled
-- | permanent failure
-- | ai_family not supported
-- | out of memory
-- | no address
-- | unknown node or service
-- | argument buffer overflow
-- | resolved protocol is unknown
-- | service not available for socket type
-- | socket type not supported
-- | connection already in progress
-- | bad file descriptor
-- | resource busy or locked
-- | operation canceled
-- | invalid Unicode character
-- | software caused connection abort
-- | connection refused
-- | connection reset by peer
-- | destination address required
-- | file already exists
-- | bad address in system call argument
-- | file too large
-- | host is unreachable
-- | interrupted system call
-- | invalid argument
-- | i/o error
-- | socket is already connected
-- | illegal operation on a directory
-- | too many symbolic links encountered
-- | too many open files
-- | message too long
-- | name too long
-- | network is down
-- | network is unreachable
-- | file table overflow
-- | no buffer space available
-- | no such device
-- | no such file or directory
-- | not enough memory
-- | machine is not on the network
-- | protocol not available
-- | no space left on device
-- | function not implemented
-- | socket is not connected
-- | not a directory
-- | directory not empty
-- | socket operation on non-socket
-- | operation not supported on socket
-- | operation not permitted
-- | broken pipe
-- | protocol error
-- | protocol not supported
-- | protocol wrong type for socket
-- | result too large
-- | read-only file system
-- | cannot send after transport endpoint shutdown
-- | invalid seek
-- | no such process
-- | connection timed out
-- | text file is busy
-- | cross-device link not permitted
-- | unknown error
-- | end of file
-- | no such device or address
-- | too many links
-- | This module implemented extensible io exception following approach
-- described in /An Extensible Dynamically-Typed Hierarchy of Exceptions/
-- by Simon Marlow. The implementation in this module has simplified to
-- meet common need. User who want to catch certain type of exceptions
-- can directly use exception types this module provide, which are
-- modeled after IOErrorType from GHC.IO.Exception.
--
-- Functions from this package will throw exceptions from this module
-- only instead of the old IOError on IO exceptions. Exceptions
-- from this module contain IOEInfo which is pretty detailed, but
-- this also require user of this module do some extra work to keep error
-- message's quality(provide CallStack, device informations, etc.). New
-- defined IO exceptions are encouraged to include a IOEInfo,
-- since it helps a lot when debugging.
--
-- Example for library author defining new io exception:
--
--
-- data MyNetworkException = MyNetworkException IOEInfo ... deriving (Show, Typeable)
-- instance Exception MyNetworkException where
-- toException = ioExceptionToException
-- fromException = ioExceptionFromException
--
--
-- If you're dealing with OS's errno directly, you should convert the
-- errno to libuv's errno in C side with uv_translate_sys_error
-- from hs_uv.h, then use 'throwUVIfMinus/throwUVError' from
-- this module.
module Std.IO.Exception
-- | The root type of all io exceptions, you can catch all io exception by
-- catching this root type.
data SomeIOException
SomeIOException :: e -> SomeIOException
ioExceptionToException :: Exception e => e -> SomeException
ioExceptionFromException :: Exception e => SomeException -> Maybe e
-- | IO exceptions informations.
data IOEInfo
IOEInfo :: String -> String -> CallStack -> IOEInfo
-- | the errno name, e.g. EADDRINUSE, etc. empty if no errno.
[ioeName] :: IOEInfo -> String
-- | description for this io error, can be errno description, or some
-- custom description if no errno.
[ioeDescription] :: IOEInfo -> String
-- | lightweight partial call-stack
[ioeCallStack] :: IOEInfo -> CallStack
data AlreadyExists
AlreadyExists :: IOEInfo -> AlreadyExists
data NoSuchThing
NoSuchThing :: IOEInfo -> NoSuchThing
data ResourceBusy
ResourceBusy :: IOEInfo -> ResourceBusy
data ResourceExhausted
ResourceExhausted :: IOEInfo -> ResourceExhausted
data EOF
EOF :: IOEInfo -> EOF
data IllegalOperation
IllegalOperation :: IOEInfo -> IllegalOperation
data PermissionDenied
PermissionDenied :: IOEInfo -> PermissionDenied
data UnsatisfiedConstraints
UnsatisfiedConstraints :: IOEInfo -> UnsatisfiedConstraints
data SystemError
SystemError :: IOEInfo -> SystemError
data ProtocolError
ProtocolError :: IOEInfo -> ProtocolError
data OtherError
OtherError :: IOEInfo -> OtherError
data InvalidArgument
InvalidArgument :: IOEInfo -> InvalidArgument
data InappropriateType
InappropriateType :: IOEInfo -> InappropriateType
data HardwareFault
HardwareFault :: IOEInfo -> HardwareFault
data UnsupportedOperation
UnsupportedOperation :: IOEInfo -> UnsupportedOperation
data TimeExpired
TimeExpired :: IOEInfo -> TimeExpired
data ResourceVanished
ResourceVanished :: IOEInfo -> ResourceVanished
data Interrupted
Interrupted :: IOEInfo -> Interrupted
-- | Throw ResourceExhausted if allocation return a nullPtr.
throwOOMIfNull :: HasCallStack => IO (Ptr a) -> IO (Ptr a)
-- | Throw appropriate IO exception if return value < 0 (libuv's
-- convention).
throwUVIfMinus :: (HasCallStack, Integral a) => IO a -> IO a
-- | Throw appropriate IO exception if return value < 0, otherwise
-- ignore the result.
throwUVIfMinus_ :: (HasCallStack, Integral a) => IO a -> IO ()
-- | Throw ResourceVanished with name ECLOSED and
-- description 'resource is closed'.
throwECLOSED :: HasCallStack => IO a
throwECLOSEDSTM :: HasCallStack => STM a
throwUVError :: CInt -> IOEInfo -> IO a
-- | If the first argument evaluates to True, then the result is the
-- second argument. Otherwise an AssertionFailed exception is
-- raised, containing a String with the source file and line
-- number of the call to assert.
--
-- Assertions can normally be turned on or off with a compiler flag (for
-- GHC, assertions are normally on unless optimisation is turned on with
-- -O or the -fignore-asserts option is given). When
-- assertions are turned off, the first argument to assert is
-- ignored, and the second argument is returned as the result.
assert :: () => Bool -> a -> a
-- | When invoked inside mask, this function allows a masked
-- asynchronous exception to be raised, if one exists. It is equivalent
-- to performing an interruptible operation (see #interruptible), but
-- does not involve any actual blocking.
--
-- When called outside mask, or inside uninterruptibleMask,
-- this function has no effect.
allowInterrupt :: IO ()
-- | Sometimes you want to catch two different sorts of exception. You
-- could do something like
--
--
-- f = expr `catch` \ (ex :: ArithException) -> handleArith ex
-- `catch` \ (ex :: IOException) -> handleIO ex
--
--
-- However, there are a couple of problems with this approach. The first
-- is that having two exception handlers is inefficient. However, the
-- more serious issue is that the second exception handler will catch
-- exceptions in the first, e.g. in the example above, if
-- handleArith throws an IOException then the second
-- exception handler will catch it.
--
-- Instead, we provide a function catches, which would be used
-- thus:
--
--
-- f = expr `catches` [Handler (\ (ex :: ArithException) -> handleArith ex),
-- Handler (\ (ex :: IOException) -> handleIO ex)]
--
catches :: () => IO a -> [Handler a] -> IO a
-- | You need this when using catches.
data Handler a
[Handler] :: forall a e. Exception e => (e -> IO a) -> Handler a
-- | Like bracket, but only performs the final action if there was
-- an exception raised by the in-between computation.
bracketOnError :: () => IO a -> (a -> IO b) -> (a -> IO c) -> IO c
-- | A variant of bracket where the return value from the first
-- computation is not required.
bracket_ :: () => IO a -> IO b -> IO c -> IO c
-- | A specialised variant of bracket with just a computation to run
-- afterward.
finally :: () => IO a -> IO b -> IO a
-- | When you want to acquire a resource, do some work with it, and then
-- release the resource, it is a good idea to use bracket, because
-- bracket will install the necessary exception handler to release
-- the resource in the event that an exception is raised during the
-- computation. If an exception is raised, then bracket will
-- re-raise the exception (after performing the release).
--
-- A common example is opening a file:
--
--
-- bracket
-- (openFile "filename" ReadMode)
-- (hClose)
-- (\fileHandle -> do { ... })
--
--
-- The arguments to bracket are in this order so that we can
-- partially apply it, e.g.:
--
--
-- withFile name mode = bracket (openFile name mode) hClose
--
bracket :: () => IO a -> (a -> IO b) -> (a -> IO c) -> IO c
-- | Like finally, but only performs the final action if there was
-- an exception raised by the computation.
onException :: () => IO a -> IO b -> IO a
-- | A variant of try that takes an exception predicate to select
-- which exceptions are caught (c.f. catchJust). If the exception
-- does not match the predicate, it is re-thrown.
tryJust :: Exception e => (e -> Maybe b) -> IO a -> IO (Either b a)
-- | Similar to catch, but returns an Either result which is
-- (Right a) if no exception of type e was
-- raised, or (Left ex) if an exception of type
-- e was raised and its value is ex. If any other type
-- of exception is raised than it will be propogated up to the next
-- enclosing exception handler.
--
--
-- try a = catch (Right `liftM` a) (return . Left)
--
try :: Exception e => IO a -> IO (Either e a)
-- | This function maps one exception into another as proposed in the paper
-- "A semantics for imprecise exceptions".
mapException :: (Exception e1, Exception e2) => (e1 -> e2) -> a -> a
-- | A version of catchJust with the arguments swapped around (see
-- handle).
handleJust :: Exception e => (e -> Maybe b) -> (b -> IO a) -> IO a -> IO a
-- | A version of catch with the arguments swapped around; useful in
-- situations where the code for the handler is shorter. For example:
--
--
-- do handle (\NonTermination -> exitWith (ExitFailure 1)) $
-- ...
--
handle :: Exception e => (e -> IO a) -> IO a -> IO a
-- | The function catchJust is like catch, but it takes an
-- extra argument which is an exception predicate, a function
-- which selects which type of exceptions we're interested in.
--
--
-- catchJust (\e -> if isDoesNotExistErrorType (ioeGetErrorType e) then Just () else Nothing)
-- (readFile f)
-- (\_ -> do hPutStrLn stderr ("No such file: " ++ show f)
-- return "")
--
--
-- Any other exceptions which are not matched by the predicate are
-- re-raised, and may be caught by an enclosing catch,
-- catchJust, etc.
catchJust :: Exception e => (e -> Maybe b) -> IO a -> (b -> IO a) -> IO a
-- | A pattern match failed. The String gives information about
-- the source location of the pattern.
newtype PatternMatchFail
PatternMatchFail :: String -> PatternMatchFail
-- | A record selector was applied to a constructor without the appropriate
-- field. This can only happen with a datatype with multiple
-- constructors, where some fields are in one constructor but not
-- another. The String gives information about the source
-- location of the record selector.
newtype RecSelError
RecSelError :: String -> RecSelError
-- | An uninitialised record field was used. The String gives
-- information about the source location where the record was
-- constructed.
newtype RecConError
RecConError :: String -> RecConError
-- | A record update was performed on a constructor without the appropriate
-- field. This can only happen with a datatype with multiple
-- constructors, where some fields are in one constructor but not
-- another. The String gives information about the source
-- location of the record update.
newtype RecUpdError
RecUpdError :: String -> RecUpdError
-- | A class method without a definition (neither a default definition, nor
-- a definition in the appropriate instance) was called. The
-- String gives information about which method it was.
newtype NoMethodError
NoMethodError :: String -> NoMethodError
-- | An expression that didn't typecheck during compile time was called.
-- This is only possible with -fdefer-type-errors. The String
-- gives details about the failed type check.
newtype TypeError
TypeError :: String -> TypeError
-- | Thrown when the runtime system detects that the computation is
-- guaranteed not to terminate. Note that there is no guarantee that the
-- runtime system will notice whether any given computation is guaranteed
-- to terminate or not.
data NonTermination
NonTermination :: NonTermination
-- | Thrown when the program attempts to call atomically, from the
-- stm package, inside another call to atomically.
data NestedAtomically
NestedAtomically :: NestedAtomically
-- | throwTo raises an arbitrary exception in the target thread (GHC
-- only).
--
-- Exception delivery synchronizes between the source and target thread:
-- throwTo does not return until the exception has been raised in
-- the target thread. The calling thread can thus be certain that the
-- target thread has received the exception. Exception delivery is also
-- atomic with respect to other exceptions. Atomicity is a useful
-- property to have when dealing with race conditions: e.g. if there are
-- two threads that can kill each other, it is guaranteed that only one
-- of the threads will get to kill the other.
--
-- Whatever work the target thread was doing when the exception was
-- raised is not lost: the computation is suspended until required by
-- another thread.
--
-- If the target thread is currently making a foreign call, then the
-- exception will not be raised (and hence throwTo will not
-- return) until the call has completed. This is the case regardless of
-- whether the call is inside a mask or not. However, in GHC a
-- foreign call can be annotated as interruptible, in which case
-- a throwTo will cause the RTS to attempt to cause the call to
-- return; see the GHC documentation for more details.
--
-- Important note: the behaviour of throwTo differs from that
-- described in the paper "Asynchronous exceptions in Haskell"
-- (http://research.microsoft.com/~simonpj/Papers/asynch-exns.htm).
-- In the paper, throwTo is non-blocking; but the library
-- implementation adopts a more synchronous design in which
-- throwTo does not return until the exception is received by the
-- target thread. The trade-off is discussed in Section 9 of the paper.
-- Like any blocking operation, throwTo is therefore interruptible
-- (see Section 5.3 of the paper). Unlike other interruptible operations,
-- however, throwTo is always interruptible, even if it
-- does not actually block.
--
-- There is no guarantee that the exception will be delivered promptly,
-- although the runtime will endeavour to ensure that arbitrary delays
-- don't occur. In GHC, an exception can only be raised when a thread
-- reaches a safe point, where a safe point is where memory
-- allocation occurs. Some loops do not perform any memory allocation
-- inside the loop and therefore cannot be interrupted by a
-- throwTo.
--
-- If the target of throwTo is the calling thread, then the
-- behaviour is the same as throwIO, except that the exception is
-- thrown as an asynchronous exception. This means that if there is an
-- enclosing pure computation, which would be the case if the current IO
-- operation is inside unsafePerformIO or
-- unsafeInterleaveIO, that computation is not permanently
-- replaced by the exception, but is suspended as if it had received an
-- asynchronous exception.
--
-- Note that if throwTo is called with the current thread as the
-- target, the exception will be thrown even if the thread is currently
-- inside mask or uninterruptibleMask.
throwTo :: Exception e => ThreadId -> e -> IO ()
-- | Raise an IOException in the IO monad.
ioError :: () => IOError -> IO a
asyncExceptionFromException :: Exception e => SomeException -> Maybe e
asyncExceptionToException :: Exception e => e -> SomeException
-- | The thread is blocked on an MVar, but there are no other
-- references to the MVar so it can't ever continue.
data BlockedIndefinitelyOnMVar
BlockedIndefinitelyOnMVar :: BlockedIndefinitelyOnMVar
-- | The thread is waiting to retry an STM transaction, but there are no
-- other references to any TVars involved, so it can't ever
-- continue.
data BlockedIndefinitelyOnSTM
BlockedIndefinitelyOnSTM :: BlockedIndefinitelyOnSTM
-- | There are no runnable threads, so the program is deadlocked. The
-- Deadlock exception is raised in the main thread only.
data Deadlock
Deadlock :: Deadlock
-- | This thread has exceeded its allocation limit. See
-- setAllocationCounter and enableAllocationLimit.
data AllocationLimitExceeded
AllocationLimitExceeded :: AllocationLimitExceeded
-- | Compaction found an object that cannot be compacted. Functions cannot
-- be compacted, nor can mutable objects or pinned objects. See
-- compact.
newtype CompactionFailed
CompactionFailed :: String -> CompactionFailed
-- | assert was applied to False.
newtype AssertionFailed
AssertionFailed :: String -> AssertionFailed
-- | Superclass for asynchronous exceptions.
data SomeAsyncException
[SomeAsyncException] :: forall e. Exception e => e -> SomeAsyncException
-- | Asynchronous exceptions.
data AsyncException
-- | The current thread's stack exceeded its limit. Since an exception has
-- been raised, the thread's stack will certainly be below its limit
-- again, but the programmer should take remedial action immediately.
StackOverflow :: AsyncException
-- | The program's heap is reaching its limit, and the program should take
-- action to reduce the amount of live data it has. Notes:
--
--
-- - It is undefined which thread receives this exception. GHC
-- currently throws this to the same thread that receives
-- UserInterrupt, but this may change in the future.
-- - The GHC RTS currently can only recover from heap overflow if it
-- detects that an explicit memory limit (set via RTS flags). has been
-- exceeded. Currently, failure to allocate memory from the operating
-- system results in immediate termination of the program.
--
HeapOverflow :: AsyncException
-- | This exception is raised by another thread calling killThread,
-- or by the system if it needs to terminate the thread for some reason.
ThreadKilled :: AsyncException
-- | This exception is raised by default in the main thread of the program
-- when the user requests to terminate the program via the usual
-- mechanism(s) (e.g. Control-C in the console).
UserInterrupt :: AsyncException
-- | Exceptions generated by array operations
data ArrayException
-- | An attempt was made to index an array outside its declared bounds.
IndexOutOfBounds :: String -> ArrayException
-- | An attempt was made to evaluate an element of an array that had not
-- been initialized.
UndefinedElement :: String -> ArrayException
-- | Evaluate the argument to weak head normal form.
--
-- evaluate is typically used to uncover any exceptions that a
-- lazy value may contain, and possibly handle them.
--
-- evaluate only evaluates to weak head normal form. If
-- deeper evaluation is needed, the force function from
-- Control.DeepSeq may be handy:
--
--
-- evaluate $ force x
--
--
-- There is a subtle difference between evaluate x and
-- return $! x, analogous to the difference
-- between throwIO and throw. If the lazy value x
-- throws an exception, return $! x will fail to
-- return an IO action and will throw an exception instead.
-- evaluate x, on the other hand, always produces an
-- IO action; that action will throw an exception upon
-- execution iff x throws an exception upon
-- evaluation.
--
-- The practical implication of this difference is that due to the
-- imprecise exceptions semantics,
--
--
-- (return $! error "foo") >> error "bar"
--
--
-- may throw either "foo" or "bar", depending on the
-- optimizations performed by the compiler. On the other hand,
--
--
-- evaluate (error "foo") >> error "bar"
--
--
-- is guaranteed to throw "foo".
--
-- The rule of thumb is to use evaluate to force or handle
-- exceptions in lazy values. If, on the other hand, you are forcing a
-- lazy value for efficiency reasons only and do not care about
-- exceptions, you may use return $! x.
evaluate :: () => a -> IO a
-- | Like mask, but the masked computation is not interruptible (see
-- Control.Exception#interruptible). THIS SHOULD BE USED WITH
-- GREAT CARE, because if a thread executing in
-- uninterruptibleMask blocks for any reason, then the thread (and
-- possibly the program, if this is the main thread) will be unresponsive
-- and unkillable. This function should only be necessary if you need to
-- mask exceptions around an interruptible operation, and you can
-- guarantee that the interruptible operation will only block for a short
-- period of time.
uninterruptibleMask :: () => ((forall a. () => IO a -> IO a) -> IO b) -> IO b
-- | Like uninterruptibleMask, but does not pass a restore
-- action to the argument.
uninterruptibleMask_ :: () => IO a -> IO a
-- | Executes an IO computation with asynchronous exceptions masked.
-- That is, any thread which attempts to raise an exception in the
-- current thread with throwTo will be blocked until asynchronous
-- exceptions are unmasked again.
--
-- The argument passed to mask is a function that takes as its
-- argument another function, which can be used to restore the prevailing
-- masking state within the context of the masked computation. For
-- example, a common way to use mask is to protect the acquisition
-- of a resource:
--
--
-- mask $ \restore -> do
-- x <- acquire
-- restore (do_something_with x) `onException` release
-- release
--
--
-- This code guarantees that acquire is paired with
-- release, by masking asynchronous exceptions for the critical
-- parts. (Rather than write this code yourself, it would be better to
-- use bracket which abstracts the general pattern).
--
-- Note that the restore action passed to the argument to
-- mask does not necessarily unmask asynchronous exceptions, it
-- just restores the masking state to that of the enclosing context. Thus
-- if asynchronous exceptions are already masked, mask cannot be
-- used to unmask exceptions again. This is so that if you call a library
-- function with exceptions masked, you can be sure that the library call
-- will not be able to unmask exceptions again. If you are writing
-- library code and need to use asynchronous exceptions, the only way is
-- to create a new thread; see forkIOWithUnmask.
--
-- Asynchronous exceptions may still be received while in the masked
-- state if the masked thread blocks in certain ways; see
-- Control.Exception#interruptible.
--
-- Threads created by forkIO inherit the MaskingState from
-- the parent; that is, to start a thread in the
-- MaskedInterruptible state, use mask_ $ forkIO ....
-- This is particularly useful if you need to establish an exception
-- handler in the forked thread before any asynchronous exceptions are
-- received. To create a new thread in an unmasked state use
-- forkIOWithUnmask.
mask :: () => ((forall a. () => IO a -> IO a) -> IO b) -> IO b
-- | Like mask, but does not pass a restore action to the
-- argument.
mask_ :: () => IO a -> IO a
-- | Returns the MaskingState for the current thread.
getMaskingState :: IO MaskingState
-- | Allow asynchronous exceptions to be raised even inside mask,
-- making the operation interruptible (see the discussion of
-- "Interruptible operations" in Exception).
--
-- When called outside mask, or inside uninterruptibleMask,
-- this function has no effect.
interruptible :: () => IO a -> IO a
-- | A variant of throw that can only be used within the IO
-- monad.
--
-- Although throwIO has a type that is an instance of the type of
-- throw, the two functions are subtly different:
--
--
-- throw e `seq` x ===> throw e
-- throwIO e `seq` x ===> x
--
--
-- The first example will cause the exception e to be raised,
-- whereas the second one won't. In fact, throwIO will only cause
-- an exception to be raised when it is used within the IO monad.
-- The throwIO variant should be used in preference to
-- throw to raise an exception within the IO monad because
-- it guarantees ordering with respect to other IO operations,
-- whereas throw does not.
throwIO :: Exception e => e -> IO a
-- | This is the simplest of the exception-catching functions. It takes a
-- single argument, runs it, and if an exception is raised the "handler"
-- is executed, with the value of the exception passed as an argument.
-- Otherwise, the result is returned as normal. For example:
--
--
-- catch (readFile f)
-- (\e -> do let err = show (e :: IOException)
-- hPutStr stderr ("Warning: Couldn't open " ++ f ++ ": " ++ err)
-- return "")
--
--
-- Note that we have to give a type signature to e, or the
-- program will not typecheck as the type is ambiguous. While it is
-- possible to catch exceptions of any type, see the section "Catching
-- all exceptions" (in Control.Exception) for an explanation of
-- the problems with doing so.
--
-- For catching exceptions in pure (non-IO) expressions, see the
-- function evaluate.
--
-- Note that due to Haskell's unspecified evaluation order, an expression
-- may throw one of several possible exceptions: consider the expression
-- (error "urk") + (1 `div` 0). Does the expression throw
-- ErrorCall "urk", or DivideByZero?
--
-- The answer is "it might throw either"; the choice is
-- non-deterministic. If you are catching any type of exception then you
-- might catch either. If you are calling catch with type IO
-- Int -> (ArithException -> IO Int) -> IO Int then the
-- handler may get run with DivideByZero as an argument, or an
-- ErrorCall "urk" exception may be propogated further up. If
-- you call it again, you might get a the opposite behaviour. This is ok,
-- because catch is an IO computation.
catch :: Exception e => IO a -> (e -> IO a) -> IO a
-- | Describes the behaviour of a thread when an asynchronous exception is
-- received.
data MaskingState
-- | asynchronous exceptions are unmasked (the normal state)
Unmasked :: MaskingState
-- | the state during mask: asynchronous exceptions are masked, but
-- blocking operations may still be interrupted
MaskedInterruptible :: MaskingState
-- | the state during uninterruptibleMask: asynchronous exceptions
-- are masked, and blocking operations may not be interrupted
MaskedUninterruptible :: MaskingState
-- | Throw an exception. Exceptions may be thrown from purely functional
-- code, but may only be caught within the IO monad.
throw :: Exception e => e -> a
-- | This is thrown when the user calls error. The first
-- String is the argument given to error, second
-- String is the location.
data ErrorCall
ErrorCallWithLocation :: String -> String -> ErrorCall
-- | Any type that you wish to throw or catch as an exception must be an
-- instance of the Exception class. The simplest case is a new
-- exception type directly below the root:
--
--
-- data MyException = ThisException | ThatException
-- deriving Show
--
-- instance Exception MyException
--
--
-- The default method definitions in the Exception class do what
-- we need in this case. You can now throw and catch
-- ThisException and ThatException as exceptions:
--
--
-- *Main> throw ThisException `catch` \e -> putStrLn ("Caught " ++ show (e :: MyException))
-- Caught ThisException
--
--
-- In more complicated examples, you may wish to define a whole hierarchy
-- of exceptions:
--
--
-- ---------------------------------------------------------------------
-- -- Make the root exception type for all the exceptions in a compiler
--
-- data SomeCompilerException = forall e . Exception e => SomeCompilerException e
--
-- instance Show SomeCompilerException where
-- show (SomeCompilerException e) = show e
--
-- instance Exception SomeCompilerException
--
-- compilerExceptionToException :: Exception e => e -> SomeException
-- compilerExceptionToException = toException . SomeCompilerException
--
-- compilerExceptionFromException :: Exception e => SomeException -> Maybe e
-- compilerExceptionFromException x = do
-- SomeCompilerException a <- fromException x
-- cast a
--
-- ---------------------------------------------------------------------
-- -- Make a subhierarchy for exceptions in the frontend of the compiler
--
-- data SomeFrontendException = forall e . Exception e => SomeFrontendException e
--
-- instance Show SomeFrontendException where
-- show (SomeFrontendException e) = show e
--
-- instance Exception SomeFrontendException where
-- toException = compilerExceptionToException
-- fromException = compilerExceptionFromException
--
-- frontendExceptionToException :: Exception e => e -> SomeException
-- frontendExceptionToException = toException . SomeFrontendException
--
-- frontendExceptionFromException :: Exception e => SomeException -> Maybe e
-- frontendExceptionFromException x = do
-- SomeFrontendException a <- fromException x
-- cast a
--
-- ---------------------------------------------------------------------
-- -- Make an exception type for a particular frontend compiler exception
--
-- data MismatchedParentheses = MismatchedParentheses
-- deriving Show
--
-- instance Exception MismatchedParentheses where
-- toException = frontendExceptionToException
-- fromException = frontendExceptionFromException
--
--
-- We can now catch a MismatchedParentheses exception as
-- MismatchedParentheses, SomeFrontendException or
-- SomeCompilerException, but not other types, e.g.
-- IOException:
--
--
-- *Main> throw MismatchedParentheses `catch` \e -> putStrLn ("Caught " ++ show (e :: MismatchedParentheses))
-- Caught MismatchedParentheses
-- *Main> throw MismatchedParentheses `catch` \e -> putStrLn ("Caught " ++ show (e :: SomeFrontendException))
-- Caught MismatchedParentheses
-- *Main> throw MismatchedParentheses `catch` \e -> putStrLn ("Caught " ++ show (e :: SomeCompilerException))
-- Caught MismatchedParentheses
-- *Main> throw MismatchedParentheses `catch` \e -> putStrLn ("Caught " ++ show (e :: IOException))
-- *** Exception: MismatchedParentheses
--
class (Typeable e, Show e) => Exception e
toException :: Exception e => e -> SomeException
fromException :: Exception e => SomeException -> Maybe e
-- | Render this exception value in a human-friendly manner.
--
-- Default implementation: show.
displayException :: Exception e => e -> String
-- | Arithmetic exceptions.
data ArithException
Overflow :: ArithException
Underflow :: ArithException
LossOfPrecision :: ArithException
DivideByZero :: ArithException
Denormal :: ArithException
RatioZeroDenominator :: ArithException
-- | The SomeException type is the root of the exception type
-- hierarchy. When an exception of type e is thrown, behind the
-- scenes it is encapsulated in a SomeException.
data SomeException
[SomeException] :: forall e. Exception e => e -> SomeException
-- | Request a CallStack.
--
-- NOTE: The implicit parameter ?callStack :: CallStack is an
-- implementation detail and should not be considered part of the
-- CallStack API, we may decide to change the implementation in
-- the future.
type HasCallStack = ?callStack :: CallStack
-- | Return the current CallStack.
--
-- Does *not* include the call-site of callStack.
callStack :: HasCallStack -> CallStack
instance GHC.Show.Show Std.IO.Exception.AlreadyExists
instance GHC.Show.Show Std.IO.Exception.NoSuchThing
instance GHC.Show.Show Std.IO.Exception.ResourceBusy
instance GHC.Show.Show Std.IO.Exception.ResourceExhausted
instance GHC.Show.Show Std.IO.Exception.EOF
instance GHC.Show.Show Std.IO.Exception.IllegalOperation
instance GHC.Show.Show Std.IO.Exception.PermissionDenied
instance GHC.Show.Show Std.IO.Exception.UnsatisfiedConstraints
instance GHC.Show.Show Std.IO.Exception.SystemError
instance GHC.Show.Show Std.IO.Exception.ProtocolError
instance GHC.Show.Show Std.IO.Exception.OtherError
instance GHC.Show.Show Std.IO.Exception.InvalidArgument
instance GHC.Show.Show Std.IO.Exception.InappropriateType
instance GHC.Show.Show Std.IO.Exception.HardwareFault
instance GHC.Show.Show Std.IO.Exception.UnsupportedOperation
instance GHC.Show.Show Std.IO.Exception.TimeExpired
instance GHC.Show.Show Std.IO.Exception.ResourceVanished
instance GHC.Show.Show Std.IO.Exception.Interrupted
instance GHC.Exception.Type.Exception Std.IO.Exception.AlreadyExists
instance GHC.Exception.Type.Exception Std.IO.Exception.NoSuchThing
instance GHC.Exception.Type.Exception Std.IO.Exception.ResourceBusy
instance GHC.Exception.Type.Exception Std.IO.Exception.ResourceExhausted
instance GHC.Exception.Type.Exception Std.IO.Exception.EOF
instance GHC.Exception.Type.Exception Std.IO.Exception.IllegalOperation
instance GHC.Exception.Type.Exception Std.IO.Exception.PermissionDenied
instance GHC.Exception.Type.Exception Std.IO.Exception.UnsatisfiedConstraints
instance GHC.Exception.Type.Exception Std.IO.Exception.SystemError
instance GHC.Exception.Type.Exception Std.IO.Exception.ProtocolError
instance GHC.Exception.Type.Exception Std.IO.Exception.OtherError
instance GHC.Exception.Type.Exception Std.IO.Exception.InvalidArgument
instance GHC.Exception.Type.Exception Std.IO.Exception.InappropriateType
instance GHC.Exception.Type.Exception Std.IO.Exception.HardwareFault
instance GHC.Exception.Type.Exception Std.IO.Exception.UnsupportedOperation
instance GHC.Exception.Type.Exception Std.IO.Exception.TimeExpired
instance GHC.Exception.Type.Exception Std.IO.Exception.ResourceVanished
instance GHC.Exception.Type.Exception Std.IO.Exception.Interrupted
instance GHC.Show.Show Std.IO.Exception.IOEInfo
instance GHC.Show.Show Std.IO.Exception.SomeIOException
instance GHC.Exception.Type.Exception Std.IO.Exception.SomeIOException
-- | This module also implements Gabriel Gonzalez'd idea on Resource
-- applicative:
-- http://www.haskellforall.com/2013/06/the-resource-applicative.html.
-- The Applicative and Monad instance is especially useful
-- when you want safely combine multiple resources.
--
-- A high performance resource pool based on STM is also provided.
module Std.IO.Resource
-- | A Resource is an IO action which acquires some resource
-- of type a and also returns a finalizer of type IO () that releases the
-- resource.
--
-- The only safe way to use a Resource is withResource /
-- 'withResource\'', You should not use the acquire field
-- directly, unless you want to implement your own resource management.
-- In the later case, you should always use mask_ since some
-- resource initializations may assume async exceptions are masked.
--
-- MonadIO instance is provided so that you can lift IO
-- computation inside Resource, this is convenient for propagating
-- Resource around since many IO computations carry
-- finalizers.
--
-- A convention in stdio is that functions returning a Resource
-- should be named in initXXX format, users are strongly
-- recommended to follow this convention.
--
-- There're two additional guarantees we made in stdio:
--
--
-- - All resources in stdio can track its own liveness, throw
-- ResourceVanished exception using throwECLOSED or
-- throwECLOSEDSTM when used after resource is closed.
-- - All resources' clean up action in stdio is idempotent.
--
--
-- Library authors providing initXXX are also encouraged to
-- provide these guarantees.
newtype Resource a
Resource :: (HasCallStack => IO (a, IO ())) -> Resource a
[acquire] :: Resource a -> HasCallStack => IO (a, IO ())
-- | Create Resource from create and release action.
--
-- Note, resource doesn't open resource itself, resource is
-- created when you use with / with'.
initResource :: IO a -> (a -> IO ()) -> Resource a
-- | Create Resource from create and release action.
--
-- This function is useful when you want to add some initialization and
-- clean up action inside Resource monad.
initResource_ :: IO () -> IO () -> Resource ()
-- | Create a new resource and run some computation, resource is guarantee
-- to be closed.
--
-- Be care don't leak the resource through computation return value,
-- because after the computation finishes, the resource is closed
-- already.
withResource :: (MonadMask m, MonadIO m, HasCallStack) => Resource a -> (a -> m b) -> m b
-- | Create a new resource and run some computation, resource is guarantee
-- to be closed.
--
-- The difference from with is that the computation will receive
-- an extra close action, which can be used to close the resource early
-- before the whole computation finished, the close action can be called
-- multiple times, only the first call will clean up the resource.
withResource' :: (MonadMask m, MonadIO m, HasCallStack) => Resource a -> (a -> m () -> m b) -> m b
-- | A high performance resource pool based on STM.
--
-- We choose to not divide pool into strips due to the difficults in
-- resource balancing. If there is a high contention on resource (see
-- statPool), just increase the maximum number of resources can be
-- opened.
data Pool a
data PoolState
PoolClosed :: PoolState
PoolScanning :: PoolState
PoolEmpty :: PoolState
-- | Initialize a resource pool with given Resource
--
-- Like other initXXX functions, this function won't open a resource pool
-- until you use withResource. And this resource pool follow the
-- same resource management pattern like other resources.
initPool :: Resource a -> Int -> Int -> Resource (Pool a)
-- | Get a resource pool's PoolState
--
-- This function is useful when debug, under load lots of
-- PoolEmpty may indicate contention on resources, i.e. the limit
-- on maximum number of resources can be opened should be adjusted to a
-- higher number. On the otherhand, lots of PoolScanning may
-- indicate there're too much free resources.
statPool :: Pool a -> IO PoolState
-- | Obtain the pooled resource inside a given resource pool.
--
-- You shouldn't use withResource with this resource after you
-- closed the pool, an ResourceVanished with EPOOLCLOSED
-- name will be thrown.
initInPool :: Pool a -> Resource a
instance GHC.Show.Show Std.IO.Resource.PoolState
instance GHC.Classes.Eq Std.IO.Resource.PoolState
instance GHC.Base.Functor Std.IO.Resource.Resource
instance GHC.Base.Applicative Std.IO.Resource.Resource
instance GHC.Base.Monad Std.IO.Resource.Resource
instance Control.Monad.IO.Class.MonadIO Std.IO.Resource.Resource
-- | This module provide functions for using PrimArray and
-- PrimVector with GHC FFI(Foreign function interface). Since GHC
-- runtime is garbaged collected, we have a quite complex story when
-- passing primitive arrays to FFI. We have two types of primitive array
-- in GHC, with the objective to minimize overall memory management cost:
--
--
-- - Small primitive arrays created with newPrimArray are
-- directly allocated on GHC heap, which can be moved by GHC garbage
-- collector, we call these arrays unpinned. Allocating these
-- array is cheap, we only need to check heap limit and bump heap pointer
-- just like any other haskell heap objects. But we will pay GC cost ,
-- which is OK for small arrays.
-- - Large primitive array and those created with
-- newPinnedPrimArray are allocated on GHC managed memory blocks,
-- which is also traced by garbage collector, but will never moved before
-- freed, thus are called pinned. Allocating these arrays are
-- bit more expensive since it's more like how malloc works, but
-- we don't have to pay for GC cost.
--
--
-- Beside the pinned/unpinned difference, we also have two types
-- of FFI calls in GHC:
--
--
-- - Safe FFI call annotated with safe keyword. These calls
-- are executed on separated OS thread, which can be running concurrently
-- with GHC garbage collector, thus we want to make sure only pinned
-- arrays are passed. The main use case for safe FFIs are long
-- running functions, for example, doing IO polling. Since these calls
-- are running on separated OS thread, haskell thread on original OS
-- thread will not be affected.
-- - Unsafe FFI call annotated with unsafe keyword. These
-- calls are executed on the same OS thread which is running the haskell
-- side FFI code, which will in turn stop GHC from doing a garbage
-- collection. We can pass both pinned and unpinned
-- arrays in this case. The use case for unsafe FFIs are
-- short/small functions, which can be treated like a fat primitive
-- operations, such as memcpy, memcmp. Using
-- unsafe FFI with long running functions will effectively block
-- GHC runtime thread from running any other haskell thread, which is
-- dangerous. Even if you use threaded runtime and expect your haskell
-- thread can be stolen by other OS thread, but this will not work since
-- GHC garbage collector will refuse to run if one of the OS thread is
-- blocked by FFI calls.
--
--
-- Base on above analysis, we have following FFI strategy table.
--
-- TODO: table
--
-- In this module, we separate safe and unsafe FFI handling due to the
-- strategy difference: if the user can guarantee the FFI are unsafe, we
-- can save an extra copy and pinned allocation. Mistakenly using unsafe
-- function with safe FFI will result in segfault.
--
-- For convention you should always use `Ptr a` as the tagged pointer
-- type, and Addr as the raw address type, use
-- `addrToPtr/ptrToAddr` to cast between them if needed.
module Std.Foreign.PrimArray
-- | Pass primitive array to unsafe FFI as pointer.
--
-- Enable UnliftedFFITypes extension in your haskell code, use
-- proper pointer type and CSize/CSsize to marshall
-- ByteArray# and Int arguments on C side.
--
-- The second Int arguement is the element size not the bytes
-- size.
--
-- Don't cast ByteArray# to Addr# since the heap object
-- offset is hard-coded in code generator:
-- https://github.com/ghc/ghc/blob/master/compiler/codeGen/StgCmmForeign.hs#L520
--
-- In haskell side we use type system to distinguish immutable / mutable
-- arrays, but in C side we can't. So it's users' responsibility to make
-- sure the array content is not mutated (a const pointer type may help).
--
-- USE THIS FUNCTION WITH UNSAFE FFI CALL ONLY.
withPrimArrayUnsafe :: Prim a => PrimArray a -> (BA# a -> Int -> IO b) -> IO b
-- | Pass mutable primitive array to unsafe FFI as pointer.
--
-- The mutable version of withPrimArrayUnsafe.
--
-- USE THIS FUNCTION WITH UNSAFE FFI CALL ONLY.
withMutablePrimArrayUnsafe :: Prim a => MutablePrimArray RealWorld a -> (MBA# a -> Int -> IO b) -> IO b
withMutableByteArrayUnsafe :: Int -> (MBA# Word8 -> IO b) -> IO b
-- | Pass PrimVector to unsafe FFI as pointer
--
-- The PrimVector version of withPrimArrayUnsafe.
--
-- The second Int arguement is the first element offset, the third
-- Int argument is the element length.
--
-- USE THIS FUNCTION WITH UNSAFE FFI CALL ONLY.
withPrimVectorUnsafe :: Prim a => PrimVector a -> (BA# a -> Int -> Int -> IO b) -> IO 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 FFI CALL ONLY.
withPrimUnsafe :: Prim a => a -> (MBA# a -> IO b) -> IO (a, b)
withPrimUnsafe' :: Prim a => (MBA# a -> IO b) -> IO (a, b)
-- | Pass primitive array to safe FFI as pointer.
--
-- Use proper pointer type and CSize/CSsize to marshall Ptr
-- a and Int arguments on C side. The memory pointed by
-- 'Ptr a' will not moved.
--
-- The second Int arguement is the element size not the bytes
-- size.
--
-- Don't pass a forever loop to this function, see #14346.
withPrimArraySafe :: Prim a => PrimArray a -> (Ptr a -> Int -> IO b) -> IO b
-- | Pass mutable primitive array to unsafe FFI as pointer.
--
-- The mutable version of withPrimArraySafe.
--
-- Don't pass a forever loop to this function, see #14346.
withMutablePrimArraySafe :: Prim a => MutablePrimArray RealWorld a -> (Ptr a -> Int -> IO b) -> IO b
withMutableByteArraySafe :: Int -> (Ptr Word8 -> IO b) -> IO b
-- | Pass PrimVector to unsafe FFI as pointer
--
-- The PrimVector version of withPrimArraySafe. The
-- Ptr is already pointed to the first element, thus no offset is
-- provided.
--
-- Don't pass a forever loop to this function, see #14346.
withPrimVectorSafe :: forall a b. Prim a => PrimVector a -> (Ptr a -> Int -> IO b) -> IO b
-- | 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 #14346.
withPrimSafe :: forall a b. Prim a => a -> (Ptr a -> IO b) -> IO (a, b)
withPrimSafe' :: forall a b. Prim a => (Ptr a -> IO b) -> IO (a, b)
-- | Type alias for ByteArray#.
--
-- Since we can't newtype an unlifted type yet, type alias is the best we
-- can get to describe a ByteArray# which we are going to pass
-- across FFI. At C side you should use a proper const pointer type.
--
-- Don't cast BA# to Addr# since the heap object offset is
-- hard-coded in code generator:
-- https://github.com/ghc/ghc/blob/master/compiler/codeGen/StgCmmForeign.hs#L520
--
-- USE THIS TYPE WITH UNSAFE FFI CALL ONLY.
type BA# a = ByteArray#
-- | Type alias for MutableByteArray# RealWorld.
--
-- Since we can't newtype an unlifted type yet, type alias is the best we
-- can get to describe a MutableByteArray# which we are going to
-- pass across FFI. At C side you should use a proper pointer type.
--
-- Don't cast MBA# to Addr# since the heap object offset is
-- hard-coded in code generator:
-- https://github.com/ghc/ghc/blob/master/compiler/codeGen/StgCmmForeign.hs#L520
--
-- USE THIS TYPE WITH UNSAFE FFI CALL ONLY.
type MBA# a = MutableByteArray# RealWorld
-- | Zero a structure.
--
-- There's no Storable or Prim constraint on a
-- type, thus the length should be given in bytes.
clearPtr :: Ptr a -> Int -> IO ()
-- | Cast between raw address and tagged pointer.
addrToPtr :: Addr -> Ptr a
-- | Cast between tagged pointer and raw address.
ptrToAddr :: Ptr a -> Addr
-- | The castPtr function casts a pointer from one type to another.
castPtr :: () => Ptr a -> Ptr b
-- | A Text wrap a Bytes which will be interpreted using
-- UTF-8 encoding. User should always use validate to construt a
-- Text (instead of using construtor directly or coercing),
-- otherwise illegal UTF-8 encoded codepoints will cause undefined
-- behaviours.
module Std.Data.Text.Base
-- | Text represented as UTF-8 encoded Bytes
newtype Text
Text :: Bytes -> Text
-- | Extract UTF-8 encoded Bytes from Text
[getUTF8Bytes] :: Text -> Bytes
-- | O(n) Validate a sequence of bytes is UTF-8 encoded.
--
-- Throw error in case of invalid codepoint.
validate :: HasCallStack => Bytes -> Text
validateMaybe :: Bytes -> Maybe Text
-- | O(n) replicate char n time.
replicate :: Int -> Char -> Text
-- | O(n*m) cycleN a text n times.
cycleN :: Int -> Text -> Text
-- | O(n) Get the nth codepoint from Text.
indexMaybe :: Text -> Int -> Maybe Char
-- | O(n) Find the nth codepoint's byte index (pointing to the nth
-- char's begining byte).
--
-- The index is only meaningful to the whole byte slice, if there's less
-- than n codepoints, the index will point to next byte after the end.
charByteIndex :: Text -> Int -> Int
-- | O(n) Get the nth codepoint from Text counting from the
-- end.
indexMaybeR :: Text -> Int -> Maybe Char
-- | O(n) Find the nth codepoint's byte index from the end (pointing
-- to the previous char's ending byte).
--
-- The index is only meaningful to the whole byte slice, if there's less
-- than n codepoints, the index will point to previous byte before the
-- start.
charByteIndexR :: Text -> Int -> Int
-- | O(1). Empty text.
empty :: Text
-- | O(1). Single char text.
singleton :: Char -> Text
-- | O(n). Copy a text from slice.
copy :: Text -> Text
-- | O(n) Convert a string into a text
--
-- Alias for packN defaultInitSize.
pack :: String -> Text
-- | O(n) Convert a list into a text with an approximate size(in
-- bytes, not codepoints).
--
-- If the encoded bytes length is larger than the size given, we simply
-- double the buffer size and continue building.
--
-- This function is a good consumer in the sense of build/foldr
-- fusion.
packN :: Int -> String -> Text
-- | O(n) Alias for packRN defaultInitSize.
packR :: String -> Text
-- | O(n) packN in reverse order.
--
-- This function is a good consumer in the sense of build/foldr
-- fusion.
packRN :: Int -> String -> Text
-- | O(n) Convert text to a char list.
--
-- Unpacking is done lazily. i.e. we will retain reference to the array
-- until all element are consumed.
--
-- This function is a good producer in the sense of build/foldr
-- fusion.
unpack :: Text -> String
-- | O(n) Convert text to a list in reverse order.
--
-- This function is a good producer in the sense of build/foldr
-- fusion.
unpackR :: Text -> String
-- | O(n) convert from a char vector.
fromVector :: PrimVector Char -> Text
-- | O(n) convert to a char vector.
toVector :: Text -> PrimVector Char
-- | O(1) Test whether a text is empty.
null :: Text -> Bool
-- | O(n) The char length of a text.
length :: Text -> Int
-- | O(m+n)
--
-- There's no need to guard empty vector because we guard them for you,
-- so appending empty text are no-ops.
append :: Text -> Text -> Text
-- | O(n) map f t is the Text
-- obtained by applying f to each char of t. Performs
-- replacement on invalid scalar values.
map' :: (Char -> Char) -> Text -> Text
-- | Strict mapping with index.
imap' :: (Int -> Char -> Char) -> Text -> Text
-- | Strict left to right fold.
foldl' :: (b -> Char -> b) -> b -> Text -> b
-- | Strict left to right fold with index.
ifoldl' :: (b -> Int -> Char -> b) -> b -> Text -> b
-- | Strict right to left fold
foldr' :: (Char -> b -> b) -> b -> Text -> b
-- | Strict right to left fold with index
--
-- NOTE: the index is counting from 0, not backwards
ifoldr' :: (Int -> Char -> b -> b) -> b -> Text -> b
-- | O(n) Concatenate a list of text.
--
-- Note: concat have to force the entire list to filter out empty
-- text and calculate the length for allocation.
concat :: [Text] -> Text
-- | Map a function over a text and concatenate the results
concatMap :: (Char -> Text) -> Text -> Text
-- | O(n) count returns count of an element from a text.
count :: Char -> Text -> Int
-- | O(n) Applied to a predicate and text, all determines if
-- all chars of the text satisfy the predicate.
all :: (Char -> Bool) -> Text -> Bool
-- | O(n) Applied to a predicate and a text, any determines
-- if any chars of the text satisfy the predicate.
any :: (Char -> Bool) -> Text -> Bool
data NormalizationResult
NormalizedYes :: NormalizationResult
NormalizedMaybe :: NormalizationResult
NormalizedNo :: NormalizationResult
-- | These are the Unicode Normalization Forms:
--
--
-- Form | Description
-- ---------------------------- | ---------------------------------------------
-- Normalization Form D (NFD) | Canonical decomposition
-- Normalization Form C (NFC) | Canonical decomposition, followed by canonical composition
-- Normalization Form KD (NFKD) | Compatibility decomposition
-- Normalization Form KC (NFKC) | Compatibility decomposition, followed by canonical composition
--
data NormalizeMode
NFC :: NormalizeMode
NFKC :: NormalizeMode
NFD :: NormalizeMode
NFKD :: NormalizeMode
-- | Check if a string is stable in the NFC (Normalization Form C).
isNormalized :: Text -> NormalizationResult
-- | Check if a string is stable in the specified Unicode Normalization
-- Form.
--
-- This function can be used as a preprocessing step, before attempting
-- to normalize a string. Normalization is a very expensive process, it
-- is often cheaper to first determine if the string is unstable in the
-- requested normalization form.
--
-- The result of the check will be YES if the string is stable and MAYBE
-- or NO if it is unstable. If the result is MAYBE, the string does not
-- necessarily have to be normalized.
--
-- If the result is unstable, the offset parameter is set to the offset
-- for the first unstable code point. If the string is stable, the offset
-- is equivalent to the length of the string in bytes.
--
-- For more information, please review Unicode Standard Annex #15 -
-- Unicode Normalization Forms.
isNormalizedTo :: NormalizeMode -> Text -> NormalizationResult
-- | Normalize a string to NFC (Normalization Form C).
normalize :: Text -> Text
-- | Normalize a string to the specified Unicode Normalization Form.
--
-- The Unicode standard defines two standards for equivalence between
-- characters: canonical and compatibility equivalence. Canonically
-- equivalent characters and sequence represent the same abstract
-- character and must be rendered with the same appearance and behavior.
-- Compatibility equivalent characters have a weaker equivalence and may
-- be rendered differently.
--
-- Unicode Normalization Forms are formally defined standards that can be
-- used to test whether any two strings of characters are equivalent to
-- each other. This equivalence may be canonical or compatibility.
--
-- The algorithm puts all combining marks into a specified order and uses
-- the rules for decomposition and composition to transform the string
-- into one of four Unicode Normalization Forms. A binary comparison can
-- then be used to determine equivalence.
normalizeTo :: NormalizeMode -> Text -> Text
-- | Locale for case mapping.
data Locale
localeDefault :: Locale
localeLithuanian :: Locale
localeTurkishAndAzeriLatin :: Locale
-- | Remove case distinction from UTF-8 encoded text with default locale.
caseFold :: Text -> Text
-- | Remove case distinction from UTF-8 encoded text.
--
-- Case folding is the process of eliminating differences between code
-- points concerning case mapping. It is most commonly used for comparing
-- strings in a case-insensitive manner. Conversion is fully compliant
-- with the Unicode 7.0 standard.
--
-- Although similar to lowercasing text, there are significant
-- differences. For one, case folding does _not_ take locale into account
-- when converting. In some cases, case folding can be up to 20% faster
-- than lowercasing the same text, but the result cannot be treated as
-- correct lowercased text.
--
-- Only two locale-specific exception are made when case folding text. In
-- Turkish, U+0049 LATIN CAPITAL LETTER I maps to U+0131 LATIN SMALL
-- LETTER DOTLESS I and U+0130 LATIN CAPITAL LETTER I WITH DOT ABOVE maps
-- to U+0069 LATIN SMALL LETTER I.
--
-- Although most code points can be case folded without changing length,
-- there are notable exceptions. For example, U+0130 (LATIN CAPITAL
-- LETTER I WITH DOT ABOVE) maps to "U+0069 U+0307" (LATIN SMALL LETTER I
-- and COMBINING DOT ABOVE) when converted to lowercase.
--
-- Only a handful of scripts make a distinction between upper- and
-- lowercase. In addition to modern scripts, such as Latin, Greek,
-- Armenian and Cyrillic, a few historic or archaic scripts have case.
-- The vast majority of scripts do not have case distinctions.
caseFoldWith :: Locale -> Text -> Text
-- | Convert UTF-8 encoded text to lowercase with default locale.
toLower :: Text -> Text
-- | Convert UTF-8 encoded text to lowercase.
--
-- This function allows conversion of UTF-8 encoded strings to lowercase
-- without first changing the encoding to UTF-32. Conversion is fully
-- compliant with the Unicode 7.0 standard.
--
-- Although most code points can be converted to lowercase with changing
-- length, there are notable exceptions. For example, U+0130 (LATIN
-- CAPITAL LETTER I WITH DOT ABOVE) maps to "U+0069 U+0307" (LATIN SMALL
-- LETTER I and COMBINING DOT ABOVE) when converted to lowercase.
--
-- Only a handful of scripts make a distinction between upper- and
-- lowercase. In addition to modern scripts, such as Latin, Greek,
-- Armenian and Cyrillic, a few historic or archaic scripts have case.
-- The vast majority of scripts do not have case distinctions.
--
-- Case mapping is not reversible. That is, toUpper(toLower(x)) !=
-- toLower(toUpper(x)).
--
-- Certain code points (or combinations of code points) apply rules based
-- on the locale. For more information about these exceptional code
-- points, please refer to the Unicode standard:
-- ftp:/ftp.unicode.orgPublicUNIDATASpecialCasing.txt
toLowerWith :: Locale -> Text -> Text
-- | Convert UTF-8 encoded text to uppercase with default locale.
toUpper :: Text -> Text
-- | Convert UTF-8 encoded text to uppercase.
--
-- Conversion is fully compliant with the Unicode 7.0 standard.
--
-- Although most code points can be converted without changing length,
-- there are notable exceptions. For example, U+00DF (LATIN SMALL LETTER
-- SHARP S) maps to "U+0053 U+0053" (LATIN CAPITAL LETTER S and LATIN
-- CAPITAL LETTER S) when converted to uppercase.
--
-- Only a handful of scripts make a distinction between upper and
-- lowercase. In addition to modern scripts, such as Latin, Greek,
-- Armenian and Cyrillic, a few historic or archaic scripts have case.
-- The vast majority of scripts do not have case distinctions.
--
-- Case mapping is not reversible. That is, toUpper(toLower(x)) !=
-- toLower(toUpper(x)).
--
-- Certain code points (or combinations of code points) apply rules based
-- on the locale. For more information about these exceptional code
-- points, please refer to the Unicode standard:
-- ftp:/ftp.unicode.orgPublicUNIDATASpecialCasing.txt
toUpperWith :: Locale -> Text -> Text
-- | Convert UTF-8 encoded text to titlecase with default locale.
toTitle :: Text -> Text
-- | Convert UTF-8 encoded text to titlecase.
--
-- This function allows conversion of UTF-8 encoded strings to titlecase.
-- Conversion is fully compliant with the Unicode 7.0 standard.
--
-- Titlecase requires a bit more explanation than uppercase and
-- lowercase, because it is not a common text transformation. Titlecase
-- uses uppercase for the first letter of each word and lowercase for the
-- rest. Words are defined as "collections of code points with general
-- category Lu, Ll, Lt, Lm or Lo according to the Unicode database".
--
-- Effectively, any type of punctuation can break up a word, even if this
-- is not grammatically valid. This happens because the titlecasing
-- algorithm does not and cannot take grammar rules into account.
--
--
-- Text | Titlecase
-- -------------------------------------|-------------------------------------
-- The running man | The Running Man
-- NATO Alliance | Nato Alliance
-- You're amazing at building libraries | You'Re Amazing At Building Libraries
--
--
-- Although most code points can be converted to titlecase without
-- changing length, there are notable exceptions. For example, U+00DF
-- (LATIN SMALL LETTER SHARP S) maps to "U+0053 U+0073" (LATIN CAPITAL
-- LETTER S and LATIN SMALL LETTER S) when converted to titlecase.
--
-- Certain code points (or combinations of code points) apply rules based
-- on the locale. For more information about these exceptional code
-- points, please refer to the Unicode standard:
-- ftp:/ftp.unicode.orgPublicUNIDATASpecialCasing.txt
toTitleWith :: Locale -> Text -> Text
-- | Check if the input string conforms to the category specified by the
-- flags.
--
-- This function can be used to check if the code points in a string are
-- part of a category. Valid flags are members of the "list of
-- categories". The category for a code point is defined as part of the
-- entry in UnicodeData.txt, the data file for the Unicode code point
-- database.
--
-- By default, the function will treat grapheme clusters as a single code
-- point. This means that the following string:
--
--
-- Code point | Canonical combining class | General category | Name
-- ---------- | ------------------------- | --------------------- | ----------------------
-- U+0045 | 0 | Lu (Uppercase letter) | LATIN CAPITAL LETTER E
-- U+0300 | 230 | Mn (Non-spacing mark) | COMBINING GRAVE ACCENT
--
--
-- Will match with categoryLetterUppercase in its entirety,
-- because the COMBINING GRAVE ACCENT is treated as part of the grapheme
-- cluster. This is useful when e.g. creating a text parser, because you
-- do not have to normalize the text first.
--
-- If this is undesired behavior, specify the
-- UTF8_CATEGORY_IGNORE_GRAPHEME_CLUSTER flag.
--
-- In order to maintain backwards compatibility with POSIX functions like
-- isdigit and isspace, compatibility flags have been
-- provided. Note, however, that the result is only guaranteed to be
-- correct for code points in the Basic Latin range, between U+0000 and
-- 0+007F. Combining a compatibility flag with a regular category flag
-- will result in undefined behavior.
isCategory :: Category -> Text -> Bool
-- | Try to match as many code points with the matching category flags as
-- possible and return the prefix and suffix.
spanCategory :: Category -> Text -> (Text, Text)
-- | Unicode categories. See isCategory, you can combine categories
-- with bitwise or.
data Category
categoryLetterUppercase :: Category
categoryLetterLowercase :: Category
categoryLetterTitlecase :: Category
categoryLetterOther :: Category
categoryLetter :: Category
categoryCaseMapped :: Category
categoryMarkNonSpacing :: Category
categoryMarkSpacing :: Category
categoryMarkEnclosing :: Category
categoryMark :: Category
categoryNumberDecimal :: Category
categoryNumberLetter :: Category
categoryNumberOther :: Category
categoryNumber :: Category
categoryPunctuationConnector :: Category
categoryPunctuationDash :: Category
categoryPunctuationOpen :: Category
categoryPunctuationClose :: Category
categoryPunctuationInitial :: Category
categoryPunctuationFinal :: Category
categoryPunctuationOther :: Category
categoryPunctuation :: Category
categorySymbolMath :: Category
categorySymbolCurrency :: Category
categorySymbolModifier :: Category
categorySymbolOther :: Category
categorySymbol :: Category
categorySeparatorSpace :: Category
categorySeparatorLine :: Category
categorySeparatorParagraph :: Category
categorySeparator :: Category
categoryControl :: Category
categoryFormat :: Category
categorySurrogate :: Category
categoryPrivateUse :: Category
categoryUnassigned :: Category
categoryCompatibility :: Category
categoryIgnoreGraphemeCluste :: Category
categoryIscntrl :: Category
categoryIsprint :: Category
categoryIsspace :: Category
categoryIsblank :: Category
categoryIsgraph :: Category
categoryIspunct :: Category
categoryIsalnum :: Category
categoryIsalpha :: Category
categoryIsupper :: Category
categoryIslower :: Category
categoryIsdigit :: Category
categoryIsxdigit :: Category
c_utf8_validate_ba :: BA# Word8 -> Int# -> Int# -> Int
c_utf8_validate_addr :: Addr# -> Int -> IO Int
instance GHC.Classes.Eq Std.Data.Text.Base.Text
instance GHC.Classes.Ord Std.Data.Text.Base.Text
instance GHC.Show.Show Std.Data.Text.Base.Text
instance GHC.Read.Read Std.Data.Text.Base.Text
instance Control.DeepSeq.NFData Std.Data.Text.Base.Text
instance Data.Hashable.Class.Hashable Std.Data.Text.Base.Text
instance Data.String.IsString Std.Data.Text.Base.Text
module Std.Data.Text.Search
-- | O(n) elem test if given char is in given text.
elem :: Char -> Text -> Bool
-- | O(n) not . elem
notElem :: Char -> Text -> Bool
findIndices :: (Char -> Bool) -> Text -> [Int]
-- | O(n) find the first char matching the predicate in a text from
-- left to right, if there isn't one, return the index point to the end
-- of the byte slice.
find :: (Char -> Bool) -> Text -> (Int, Int, Maybe Char)
-- | O(n) find the first char matching the predicate in a text from
-- right to left, if there isn't one, return the index point to the end
-- of the byte slice.
findR :: (Char -> Bool) -> Text -> (Int, Int, Maybe Char)
-- | O(n) find the index of the byte slice.
findIndex :: (Char -> Bool) -> Text -> Int
-- | O(n) find the index of the byte slice in reverse order.
findIndexR :: (Char -> Bool) -> Text -> Int
-- | O(n) filter, applied to a predicate and a text, returns
-- a text containing those chars that satisfy the predicate.
filter :: (Char -> Bool) -> Text -> Text
-- | O(n) The partition function takes a predicate, a text,
-- returns a pair of text with codepoints which do and do not satisfy the
-- predicate, respectively; i.e.,
--
--
-- partition p txt == (filter p txt, filter (not . p) txt)
--
partition :: (Char -> Bool) -> Text -> (Text, Text)
-- | Various combinators works on Texts.
module Std.Data.Text.Extra
-- | O(n) cons is analogous to (:) for lists, but of
-- different complexity, as it requires making a copy.
cons :: Char -> Text -> Text
-- | O(n) Append a char to the end of a text.
snoc :: Text -> Char -> Text
-- | O(1) Extract the head and tail of a text, return Nothing
-- if it is empty.
uncons :: Text -> Maybe (Char, Text)
-- | O(1) Extract the init and last of a text, return Nothing
-- if text is empty.
unsnoc :: Text -> Maybe (Text, Char)
-- | O(1) Extract the first char of a text.
headMaybe :: Text -> Maybe Char
-- | O(1) Extract the chars after the head of a text.
--
-- NOTE: tailMayEmpty return empty text in the case of an empty
-- text.
tailMayEmpty :: Text -> Text
-- | O(1) Extract the last char of a text.
lastMaybe :: Text -> Maybe Char
-- | O(1) Extract the chars before of the last one.
--
-- NOTE: initMayEmpty return empty text in the case of an empty
-- text.
initMayEmpty :: Text -> Text
-- | O(n) Return all initial segments of the given text, empty
-- first.
inits :: Text -> [Text]
-- | O(n) Return all final segments of the given text, whole text
-- first.
tails :: Text -> [Text]
-- | O(1) take n, applied to a text xs,
-- returns the prefix of xs of length n, or xs
-- itself if n > length xs.
take :: Int -> Text -> Text
-- | O(1) drop n xs returns the suffix of
-- xs after the first n char, or [] if n
-- > length xs.
drop :: Int -> Text -> Text
-- | O(1) takeR n, applied to a text xs,
-- returns the suffix of xs of length n, or xs
-- itself if n > length xs.
takeR :: Int -> Text -> Text
-- | O(1) dropR n xs returns the prefix of
-- xs before the last n char, or [] if n
-- > length xs.
dropR :: Int -> Text -> Text
-- | O(1) Extract a sub-range text with give start index and length.
--
-- This function is a total function just like 'take/drop', index/length
-- exceeds range will be ingored, e.g.
--
--
-- slice 1 3 "hello" == "ell"
-- slice -1 -1 "hello" == ""
-- slice -2 2 "hello" == ""
-- slice 2 10 "hello" == "llo"
--
--
-- This holds for all x y: slice x y vs == drop x . take (x+y)
-- vs
slice :: Int -> Int -> Text -> Text
-- | O(n) splitAt n xs is equivalent to
-- (take n xs, drop n xs).
splitAt :: Int -> Text -> (Text, Text)
-- | O(n) Applied to a predicate p and a text t,
-- returns the longest prefix (possibly empty) of t of elements
-- that satisfy p.
takeWhile :: (Char -> Bool) -> Text -> Text
-- | O(n) Applied to a predicate p and a text t,
-- returns the longest suffix (possibly empty) of t of elements
-- that satisfy p.
takeWhileR :: (Char -> Bool) -> Text -> Text
-- | O(n) Applied to a predicate p and a text vs,
-- returns the suffix (possibly empty) remaining after takeWhile
-- p vs.
dropWhile :: (Char -> Bool) -> Text -> Text
-- | O(n) Applied to a predicate p and a text vs,
-- returns the prefix (possibly empty) remaining before takeWhileR
-- p vs.
dropWhileR :: (Char -> Bool) -> Text -> Text
-- | O(n) dropAround f = dropWhile f . dropWhileR f
dropAround :: (Char -> Bool) -> Text -> Text
-- | O(n) Split the text into the longest prefix of elements that do
-- not satisfy the predicate and the rest without copying.
break :: (Char -> Bool) -> Text -> (Text, Text)
-- | O(n) Split the text into the longest prefix of elements that
-- satisfy the predicate and the rest without copying.
span :: (Char -> Bool) -> Text -> (Text, Text)
-- | breakR behaves like break but from the end of the text.
--
--
-- breakR p == spanR (not.p)
--
breakR :: (Char -> Bool) -> Text -> (Text, Text)
-- | spanR behaves like span but from the end of the text.
spanR :: (Char -> Bool) -> Text -> (Text, Text)
-- | Break a text on a subtext, returning a pair of the part of the text
-- prior to the match, and the rest of the text, e.g.
--
--
-- break "wor" "hello, world" = ("hello, ", "world")
--
breakOn :: Text -> Text -> (Text, Text)
-- | O(n+m) Find all non-overlapping instances of needle in haystack. Each
-- element of the returned list consists of a pair:
--
--
-- - The entire string prior to the kth match (i.e. the prefix)
-- - The kth match, followed by the remainder of the string
--
--
-- Examples:
--
--
-- breakOnAll "::" ""
-- ==> []
-- breakOnAll "" "abc"
-- ==> [("a", "bc"), ("ab", "c"), ("abc", "/")]
--
--
-- The result list is lazy, search is performed when you force the list.
breakOnAll :: Text -> Text -> [(Text, Text)]
-- | Overlapping version of breakOnAll.
breakOnAllOverlapping :: Text -> Text -> [(Text, Text)]
-- | The group function takes a text and returns a list of texts such that
-- the concatenation of the result is equal to the argument. Moreover,
-- each sublist in the result contains only equal elements. For example,
--
--
-- group Mississippi = [M,"i","ss","i","ss","i","pp","i"]
--
--
-- It is a special case of groupBy, which allows the programmer to
-- supply their own equality test.
group :: Text -> [Text]
-- | The groupBy function is the non-overloaded version of
-- group.
groupBy :: (Char -> Char -> Bool) -> Text -> [Text]
-- | O(n) The stripPrefix function takes two texts and
-- returns Just the remainder of the second iff the first is its
-- prefix, and otherwise Nothing.
stripPrefix :: Text -> Text -> Maybe Text
-- | O(n) The stripSuffix function takes two texts and returns Just
-- the remainder of the second iff the first is its suffix, and otherwise
-- Nothing.
stripSuffix :: Text -> Text -> Maybe Text
-- | O(n) Break a text into pieces separated by the delimiter
-- element consuming the delimiter. I.e.
--
--
-- split '\n' "a\nb\nd\ne" == ["a","b","d","e"]
-- split 'a' "aXaXaXa" == ["","X","X","X",""]
-- split 'x' "x" == ["",""]
--
--
-- and
--
--
-- intercalate [c] . split c == id
-- split == splitWith . (==)
--
--
-- NOTE, this function behavior different with bytestring's. see
-- #56.
split :: Char -> Text -> [Text]
-- | O(n) Splits a text into components delimited by separators,
-- where the predicate returns True for a separator char. The resulting
-- components do not contain the separators. Two adjacent separators
-- result in an empty component in the output. eg.
--
--
-- splitWith (=='a') "aabbaca" == ["","","bb","c",""]
-- splitWith (=='a') [] == [""]
--
splitWith :: (Char -> Bool) -> Text -> [Text]
-- | O(m+n) Break haystack into pieces separated by needle.
--
-- Note: An empty needle will essentially split haystack element by
-- element.
--
-- Examples:
--
--
-- >>> splitOn "\r\n" "a\r\nb\r\nd\r\ne"
-- ["a","b","d","e"]
--
--
--
-- >>> splitOn "aaa" "aaaXaaaXaaaXaaa"
-- ["","X","X","X",""]
--
--
--
-- >>> splitOn "x" "x"
-- ["",""]
--
--
-- and
--
--
-- intercalate s . splitOn s == id
-- splitOn (singleton c) == split (==c)
--
splitOn :: Text -> Text -> [Text]
-- | The isPrefix function returns True if the first
-- argument is a prefix of the second.
isPrefixOf :: Text -> Text -> Bool
-- | O(n) The isSuffixOf function takes two text and returns
-- True if the first is a suffix of the second.
isSuffixOf :: Text -> Text -> Bool
-- | Check whether one text is a subtext of another.
--
-- needle isInfixOf haystack === null haystack || indices
-- needle haystake /= [].
isInfixOf :: Text -> Text -> Bool
-- | O(n) Find the longest non-empty common prefix of two strings
-- and return it, along with the suffixes of each string at which they no
-- longer match. e.g.
--
--
-- >>> commonPrefix "foobar" "fooquux"
-- ("foo","bar","quux")
--
--
--
-- >>> commonPrefix "veeble" "fetzer"
-- ("","veeble","fetzer")
--
commonPrefix :: Text -> Text -> (Text, Text, Text)
-- | O(n) Breaks a Bytes up into a list of words, delimited
-- by unicode space.
words :: Text -> [Text]
-- | O(n) Breaks a text up into a list of lines, delimited by ascii
-- n.
lines :: Text -> [Text]
-- | O(n) Joins words with ascii space.
unwords :: [Text] -> Text
-- | O(n) Joins lines with ascii n.
unlines :: [Text] -> Text
-- | Add padding to the left so that the whole text's length is at least n.
padLeft :: Int -> Char -> Text -> Text
-- | Add padding to the right so that the whole text's length is at least
-- n.
padRight :: Int -> Char -> Text -> Text
-- | O(n) Reverse the characters of a string.
reverse :: Text -> Text
-- | O(n) The intersperse function takes a character and
-- places it between the characters of a Text. Performs
-- replacement on invalid scalar values.
intersperse :: Char -> Text -> Text
-- | O(n) The intercalate function takes a Text and a
-- list of Texts and concatenates the list after interspersing the
-- first argument between each element of the list.
intercalate :: Text -> [Text] -> Text
intercalateElem :: Char -> [Text] -> Text
-- | The transpose function transposes the rows and columns of its
-- text argument.
transpose :: [Text] -> [Text]
-- | A Text simply wraps a Bytes that are UTF-8 encoded
-- codepoints, you can use validate / validateMaybe to
-- construct a Text.
module Std.Data.Text
-- | Text represented as UTF-8 encoded Bytes
data Text
-- | Extract UTF-8 encoded Bytes from Text
getUTF8Bytes :: Text -> Bytes
-- | O(n) Validate a sequence of bytes is UTF-8 encoded.
--
-- Throw error in case of invalid codepoint.
validate :: HasCallStack => Bytes -> Text
validateMaybe :: Bytes -> Maybe Text
-- | O(1). Empty text.
empty :: Text
-- | O(1). Single char text.
singleton :: Char -> Text
-- | O(n). Copy a text from slice.
copy :: Text -> Text
-- | O(n) replicate char n time.
replicate :: Int -> Char -> Text
-- | O(n*m) cycleN a text n times.
cycleN :: Int -> Text -> Text
-- | O(n) Convert a string into a text
--
-- Alias for packN defaultInitSize.
pack :: String -> Text
-- | O(n) Convert a list into a text with an approximate size(in
-- bytes, not codepoints).
--
-- If the encoded bytes length is larger than the size given, we simply
-- double the buffer size and continue building.
--
-- This function is a good consumer in the sense of build/foldr
-- fusion.
packN :: Int -> String -> Text
-- | O(n) Alias for packRN defaultInitSize.
packR :: String -> Text
-- | O(n) packN in reverse order.
--
-- This function is a good consumer in the sense of build/foldr
-- fusion.
packRN :: Int -> String -> Text
-- | O(n) Convert text to a char list.
--
-- Unpacking is done lazily. i.e. we will retain reference to the array
-- until all element are consumed.
--
-- This function is a good producer in the sense of build/foldr
-- fusion.
unpack :: Text -> String
-- | O(n) Convert text to a list in reverse order.
--
-- This function is a good producer in the sense of build/foldr
-- fusion.
unpackR :: Text -> String
-- | O(n) convert from a char vector.
fromVector :: PrimVector Char -> Text
-- | O(n) convert to a char vector.
toVector :: Text -> PrimVector Char
-- | O(1) Test whether a text is empty.
null :: Text -> Bool
-- | O(n) The char length of a text.
length :: Text -> Int
-- | O(m+n)
--
-- There's no need to guard empty vector because we guard them for you,
-- so appending empty text are no-ops.
append :: Text -> Text -> Text
-- | O(n) map f t is the Text
-- obtained by applying f to each char of t. Performs
-- replacement on invalid scalar values.
map' :: (Char -> Char) -> Text -> Text
-- | Strict mapping with index.
imap' :: (Int -> Char -> Char) -> Text -> Text
-- | Strict left to right fold.
foldl' :: (b -> Char -> b) -> b -> Text -> b
-- | Strict left to right fold with index.
ifoldl' :: (b -> Int -> Char -> b) -> b -> Text -> b
-- | Strict right to left fold
foldr' :: (Char -> b -> b) -> b -> Text -> b
-- | Strict right to left fold with index
--
-- NOTE: the index is counting from 0, not backwards
ifoldr' :: (Int -> Char -> b -> b) -> b -> Text -> b
-- | O(n) Concatenate a list of text.
--
-- Note: concat have to force the entire list to filter out empty
-- text and calculate the length for allocation.
concat :: [Text] -> Text
-- | Map a function over a text and concatenate the results
concatMap :: (Char -> Text) -> Text -> Text
-- | O(n) count returns count of an element from a text.
count :: Char -> Text -> Int
-- | O(n) Applied to a predicate and text, all determines if
-- all chars of the text satisfy the predicate.
all :: (Char -> Bool) -> Text -> Bool
-- | O(n) Applied to a predicate and a text, any determines
-- if any chars of the text satisfy the predicate.
any :: (Char -> Bool) -> Text -> Bool
-- | O(n) elem test if given char is in given text.
elem :: Char -> Text -> Bool
-- | O(n) not . elem
notElem :: Char -> Text -> Bool
-- | O(n) cons is analogous to (:) for lists, but of
-- different complexity, as it requires making a copy.
cons :: Char -> Text -> Text
-- | O(n) Append a char to the end of a text.
snoc :: Text -> Char -> Text
-- | O(1) Extract the head and tail of a text, return Nothing
-- if it is empty.
uncons :: Text -> Maybe (Char, Text)
-- | O(1) Extract the init and last of a text, return Nothing
-- if text is empty.
unsnoc :: Text -> Maybe (Text, Char)
-- | O(1) Extract the first char of a text.
headMaybe :: Text -> Maybe Char
-- | O(1) Extract the chars after the head of a text.
--
-- NOTE: tailMayEmpty return empty text in the case of an empty
-- text.
tailMayEmpty :: Text -> Text
-- | O(1) Extract the last char of a text.
lastMaybe :: Text -> Maybe Char
-- | O(1) Extract the chars before of the last one.
--
-- NOTE: initMayEmpty return empty text in the case of an empty
-- text.
initMayEmpty :: Text -> Text
-- | O(n) Return all initial segments of the given text, empty
-- first.
inits :: Text -> [Text]
-- | O(n) Return all final segments of the given text, whole text
-- first.
tails :: Text -> [Text]
-- | O(1) take n, applied to a text xs,
-- returns the prefix of xs of length n, or xs
-- itself if n > length xs.
take :: Int -> Text -> Text
-- | O(1) drop n xs returns the suffix of
-- xs after the first n char, or [] if n
-- > length xs.
drop :: Int -> Text -> Text
-- | O(1) takeR n, applied to a text xs,
-- returns the suffix of xs of length n, or xs
-- itself if n > length xs.
takeR :: Int -> Text -> Text
-- | O(1) dropR n xs returns the prefix of
-- xs before the last n char, or [] if n
-- > length xs.
dropR :: Int -> Text -> Text
-- | O(1) Extract a sub-range text with give start index and length.
--
-- This function is a total function just like 'take/drop', index/length
-- exceeds range will be ingored, e.g.
--
--
-- slice 1 3 "hello" == "ell"
-- slice -1 -1 "hello" == ""
-- slice -2 2 "hello" == ""
-- slice 2 10 "hello" == "llo"
--
--
-- This holds for all x y: slice x y vs == drop x . take (x+y)
-- vs
slice :: Int -> Int -> Text -> Text
-- | O(n) splitAt n xs is equivalent to
-- (take n xs, drop n xs).
splitAt :: Int -> Text -> (Text, Text)
-- | O(n) Applied to a predicate p and a text t,
-- returns the longest prefix (possibly empty) of t of elements
-- that satisfy p.
takeWhile :: (Char -> Bool) -> Text -> Text
-- | O(n) Applied to a predicate p and a text t,
-- returns the longest suffix (possibly empty) of t of elements
-- that satisfy p.
takeWhileR :: (Char -> Bool) -> Text -> Text
-- | O(n) Applied to a predicate p and a text vs,
-- returns the suffix (possibly empty) remaining after takeWhile
-- p vs.
dropWhile :: (Char -> Bool) -> Text -> Text
-- | O(n) Applied to a predicate p and a text vs,
-- returns the prefix (possibly empty) remaining before takeWhileR
-- p vs.
dropWhileR :: (Char -> Bool) -> Text -> Text
-- | O(n) dropAround f = dropWhile f . dropWhileR f
dropAround :: (Char -> Bool) -> Text -> Text
-- | O(n) Split the text into the longest prefix of elements that do
-- not satisfy the predicate and the rest without copying.
break :: (Char -> Bool) -> Text -> (Text, Text)
-- | O(n) Split the text into the longest prefix of elements that
-- satisfy the predicate and the rest without copying.
span :: (Char -> Bool) -> Text -> (Text, Text)
-- | breakR behaves like break but from the end of the text.
--
--
-- breakR p == spanR (not.p)
--
breakR :: (Char -> Bool) -> Text -> (Text, Text)
-- | spanR behaves like span but from the end of the text.
spanR :: (Char -> Bool) -> Text -> (Text, Text)
-- | Break a text on a subtext, returning a pair of the part of the text
-- prior to the match, and the rest of the text, e.g.
--
--
-- break "wor" "hello, world" = ("hello, ", "world")
--
breakOn :: Text -> Text -> (Text, Text)
-- | O(n+m) Find all non-overlapping instances of needle in haystack. Each
-- element of the returned list consists of a pair:
--
--
-- - The entire string prior to the kth match (i.e. the prefix)
-- - The kth match, followed by the remainder of the string
--
--
-- Examples:
--
--
-- breakOnAll "::" ""
-- ==> []
-- breakOnAll "" "abc"
-- ==> [("a", "bc"), ("ab", "c"), ("abc", "/")]
--
--
-- The result list is lazy, search is performed when you force the list.
breakOnAll :: Text -> Text -> [(Text, Text)]
-- | The group function takes a text and returns a list of texts such that
-- the concatenation of the result is equal to the argument. Moreover,
-- each sublist in the result contains only equal elements. For example,
--
--
-- group Mississippi = [M,"i","ss","i","ss","i","pp","i"]
--
--
-- It is a special case of groupBy, which allows the programmer to
-- supply their own equality test.
group :: Text -> [Text]
-- | The groupBy function is the non-overloaded version of
-- group.
groupBy :: (Char -> Char -> Bool) -> Text -> [Text]
-- | O(n) The stripPrefix function takes two texts and
-- returns Just the remainder of the second iff the first is its
-- prefix, and otherwise Nothing.
stripPrefix :: Text -> Text -> Maybe Text
-- | O(n) The stripSuffix function takes two texts and returns Just
-- the remainder of the second iff the first is its suffix, and otherwise
-- Nothing.
stripSuffix :: Text -> Text -> Maybe Text
-- | O(n) Break a text into pieces separated by the delimiter
-- element consuming the delimiter. I.e.
--
--
-- split '\n' "a\nb\nd\ne" == ["a","b","d","e"]
-- split 'a' "aXaXaXa" == ["","X","X","X",""]
-- split 'x' "x" == ["",""]
--
--
-- and
--
--
-- intercalate [c] . split c == id
-- split == splitWith . (==)
--
--
-- NOTE, this function behavior different with bytestring's. see
-- #56.
split :: Char -> Text -> [Text]
-- | O(n) Splits a text into components delimited by separators,
-- where the predicate returns True for a separator char. The resulting
-- components do not contain the separators. Two adjacent separators
-- result in an empty component in the output. eg.
--
--
-- splitWith (=='a') "aabbaca" == ["","","bb","c",""]
-- splitWith (=='a') [] == [""]
--
splitWith :: (Char -> Bool) -> Text -> [Text]
-- | O(m+n) Break haystack into pieces separated by needle.
--
-- Note: An empty needle will essentially split haystack element by
-- element.
--
-- Examples:
--
--
-- >>> splitOn "\r\n" "a\r\nb\r\nd\r\ne"
-- ["a","b","d","e"]
--
--
--
-- >>> splitOn "aaa" "aaaXaaaXaaaXaaa"
-- ["","X","X","X",""]
--
--
--
-- >>> splitOn "x" "x"
-- ["",""]
--
--
-- and
--
--
-- intercalate s . splitOn s == id
-- splitOn (singleton c) == split (==c)
--
splitOn :: Text -> Text -> [Text]
-- | The isPrefix function returns True if the first
-- argument is a prefix of the second.
isPrefixOf :: Text -> Text -> Bool
-- | O(n) The isSuffixOf function takes two text and returns
-- True if the first is a suffix of the second.
isSuffixOf :: Text -> Text -> Bool
-- | Check whether one text is a subtext of another.
--
-- needle isInfixOf haystack === null haystack || indices
-- needle haystake /= [].
isInfixOf :: Text -> Text -> Bool
-- | O(n) Find the longest non-empty common prefix of two strings
-- and return it, along with the suffixes of each string at which they no
-- longer match. e.g.
--
--
-- >>> commonPrefix "foobar" "fooquux"
-- ("foo","bar","quux")
--
--
--
-- >>> commonPrefix "veeble" "fetzer"
-- ("","veeble","fetzer")
--
commonPrefix :: Text -> Text -> (Text, Text, Text)
-- | O(n) Breaks a Bytes up into a list of words, delimited
-- by unicode space.
words :: Text -> [Text]
-- | O(n) Breaks a text up into a list of lines, delimited by ascii
-- n.
lines :: Text -> [Text]
-- | O(n) Joins words with ascii space.
unwords :: [Text] -> Text
-- | O(n) Joins lines with ascii n.
unlines :: [Text] -> Text
-- | Add padding to the left so that the whole text's length is at least n.
padLeft :: Int -> Char -> Text -> Text
-- | Add padding to the right so that the whole text's length is at least
-- n.
padRight :: Int -> Char -> Text -> Text
-- | O(n) Reverse the characters of a string.
reverse :: Text -> Text
-- | O(n) The intersperse function takes a character and
-- places it between the characters of a Text. Performs
-- replacement on invalid scalar values.
intersperse :: Char -> Text -> Text
-- | O(n) The intercalate function takes a Text and a
-- list of Texts and concatenates the list after interspersing the
-- first argument between each element of the list.
intercalate :: Text -> [Text] -> Text
intercalateElem :: Char -> [Text] -> Text
-- | The transpose function transposes the rows and columns of its
-- text argument.
transpose :: [Text] -> [Text]
-- | O(n) find the first char matching the predicate in a text from
-- left to right, if there isn't one, return the index point to the end
-- of the byte slice.
find :: (Char -> Bool) -> Text -> (Int, Int, Maybe Char)
-- | O(n) find the first char matching the predicate in a text from
-- right to left, if there isn't one, return the index point to the end
-- of the byte slice.
findR :: (Char -> Bool) -> Text -> (Int, Int, Maybe Char)
-- | O(n) filter, applied to a predicate and a text, returns
-- a text containing those chars that satisfy the predicate.
filter :: (Char -> Bool) -> Text -> Text
-- | O(n) The partition function takes a predicate, a text,
-- returns a pair of text with codepoints which do and do not satisfy the
-- predicate, respectively; i.e.,
--
--
-- partition p txt == (filter p txt, filter (not . p) txt)
--
partition :: (Char -> Bool) -> Text -> (Text, Text)
data NormalizationResult
NormalizedYes :: NormalizationResult
NormalizedMaybe :: NormalizationResult
NormalizedNo :: NormalizationResult
-- | These are the Unicode Normalization Forms:
--
--
-- Form | Description
-- ---------------------------- | ---------------------------------------------
-- Normalization Form D (NFD) | Canonical decomposition
-- Normalization Form C (NFC) | Canonical decomposition, followed by canonical composition
-- Normalization Form KD (NFKD) | Compatibility decomposition
-- Normalization Form KC (NFKC) | Compatibility decomposition, followed by canonical composition
--
data NormalizeMode
NFC :: NormalizeMode
NFKC :: NormalizeMode
NFD :: NormalizeMode
NFKD :: NormalizeMode
-- | Check if a string is stable in the NFC (Normalization Form C).
isNormalized :: Text -> NormalizationResult
-- | Check if a string is stable in the specified Unicode Normalization
-- Form.
--
-- This function can be used as a preprocessing step, before attempting
-- to normalize a string. Normalization is a very expensive process, it
-- is often cheaper to first determine if the string is unstable in the
-- requested normalization form.
--
-- The result of the check will be YES if the string is stable and MAYBE
-- or NO if it is unstable. If the result is MAYBE, the string does not
-- necessarily have to be normalized.
--
-- If the result is unstable, the offset parameter is set to the offset
-- for the first unstable code point. If the string is stable, the offset
-- is equivalent to the length of the string in bytes.
--
-- For more information, please review Unicode Standard Annex #15 -
-- Unicode Normalization Forms.
isNormalizedTo :: NormalizeMode -> Text -> NormalizationResult
-- | Normalize a string to NFC (Normalization Form C).
normalize :: Text -> Text
-- | Normalize a string to the specified Unicode Normalization Form.
--
-- The Unicode standard defines two standards for equivalence between
-- characters: canonical and compatibility equivalence. Canonically
-- equivalent characters and sequence represent the same abstract
-- character and must be rendered with the same appearance and behavior.
-- Compatibility equivalent characters have a weaker equivalence and may
-- be rendered differently.
--
-- Unicode Normalization Forms are formally defined standards that can be
-- used to test whether any two strings of characters are equivalent to
-- each other. This equivalence may be canonical or compatibility.
--
-- The algorithm puts all combining marks into a specified order and uses
-- the rules for decomposition and composition to transform the string
-- into one of four Unicode Normalization Forms. A binary comparison can
-- then be used to determine equivalence.
normalizeTo :: NormalizeMode -> Text -> Text
-- | Locale for case mapping.
data Locale
localeDefault :: Locale
localeLithuanian :: Locale
localeTurkishAndAzeriLatin :: Locale
-- | Remove case distinction from UTF-8 encoded text with default locale.
caseFold :: Text -> Text
-- | Remove case distinction from UTF-8 encoded text.
--
-- Case folding is the process of eliminating differences between code
-- points concerning case mapping. It is most commonly used for comparing
-- strings in a case-insensitive manner. Conversion is fully compliant
-- with the Unicode 7.0 standard.
--
-- Although similar to lowercasing text, there are significant
-- differences. For one, case folding does _not_ take locale into account
-- when converting. In some cases, case folding can be up to 20% faster
-- than lowercasing the same text, but the result cannot be treated as
-- correct lowercased text.
--
-- Only two locale-specific exception are made when case folding text. In
-- Turkish, U+0049 LATIN CAPITAL LETTER I maps to U+0131 LATIN SMALL
-- LETTER DOTLESS I and U+0130 LATIN CAPITAL LETTER I WITH DOT ABOVE maps
-- to U+0069 LATIN SMALL LETTER I.
--
-- Although most code points can be case folded without changing length,
-- there are notable exceptions. For example, U+0130 (LATIN CAPITAL
-- LETTER I WITH DOT ABOVE) maps to "U+0069 U+0307" (LATIN SMALL LETTER I
-- and COMBINING DOT ABOVE) when converted to lowercase.
--
-- Only a handful of scripts make a distinction between upper- and
-- lowercase. In addition to modern scripts, such as Latin, Greek,
-- Armenian and Cyrillic, a few historic or archaic scripts have case.
-- The vast majority of scripts do not have case distinctions.
caseFoldWith :: Locale -> Text -> Text
-- | Convert UTF-8 encoded text to lowercase with default locale.
toLower :: Text -> Text
-- | Convert UTF-8 encoded text to lowercase.
--
-- This function allows conversion of UTF-8 encoded strings to lowercase
-- without first changing the encoding to UTF-32. Conversion is fully
-- compliant with the Unicode 7.0 standard.
--
-- Although most code points can be converted to lowercase with changing
-- length, there are notable exceptions. For example, U+0130 (LATIN
-- CAPITAL LETTER I WITH DOT ABOVE) maps to "U+0069 U+0307" (LATIN SMALL
-- LETTER I and COMBINING DOT ABOVE) when converted to lowercase.
--
-- Only a handful of scripts make a distinction between upper- and
-- lowercase. In addition to modern scripts, such as Latin, Greek,
-- Armenian and Cyrillic, a few historic or archaic scripts have case.
-- The vast majority of scripts do not have case distinctions.
--
-- Case mapping is not reversible. That is, toUpper(toLower(x)) !=
-- toLower(toUpper(x)).
--
-- Certain code points (or combinations of code points) apply rules based
-- on the locale. For more information about these exceptional code
-- points, please refer to the Unicode standard:
-- ftp:/ftp.unicode.orgPublicUNIDATASpecialCasing.txt
toLowerWith :: Locale -> Text -> Text
-- | Convert UTF-8 encoded text to uppercase with default locale.
toUpper :: Text -> Text
-- | Convert UTF-8 encoded text to uppercase.
--
-- Conversion is fully compliant with the Unicode 7.0 standard.
--
-- Although most code points can be converted without changing length,
-- there are notable exceptions. For example, U+00DF (LATIN SMALL LETTER
-- SHARP S) maps to "U+0053 U+0053" (LATIN CAPITAL LETTER S and LATIN
-- CAPITAL LETTER S) when converted to uppercase.
--
-- Only a handful of scripts make a distinction between upper and
-- lowercase. In addition to modern scripts, such as Latin, Greek,
-- Armenian and Cyrillic, a few historic or archaic scripts have case.
-- The vast majority of scripts do not have case distinctions.
--
-- Case mapping is not reversible. That is, toUpper(toLower(x)) !=
-- toLower(toUpper(x)).
--
-- Certain code points (or combinations of code points) apply rules based
-- on the locale. For more information about these exceptional code
-- points, please refer to the Unicode standard:
-- ftp:/ftp.unicode.orgPublicUNIDATASpecialCasing.txt
toUpperWith :: Locale -> Text -> Text
-- | Convert UTF-8 encoded text to titlecase with default locale.
toTitle :: Text -> Text
-- | Convert UTF-8 encoded text to titlecase.
--
-- This function allows conversion of UTF-8 encoded strings to titlecase.
-- Conversion is fully compliant with the Unicode 7.0 standard.
--
-- Titlecase requires a bit more explanation than uppercase and
-- lowercase, because it is not a common text transformation. Titlecase
-- uses uppercase for the first letter of each word and lowercase for the
-- rest. Words are defined as "collections of code points with general
-- category Lu, Ll, Lt, Lm or Lo according to the Unicode database".
--
-- Effectively, any type of punctuation can break up a word, even if this
-- is not grammatically valid. This happens because the titlecasing
-- algorithm does not and cannot take grammar rules into account.
--
--
-- Text | Titlecase
-- -------------------------------------|-------------------------------------
-- The running man | The Running Man
-- NATO Alliance | Nato Alliance
-- You're amazing at building libraries | You'Re Amazing At Building Libraries
--
--
-- Although most code points can be converted to titlecase without
-- changing length, there are notable exceptions. For example, U+00DF
-- (LATIN SMALL LETTER SHARP S) maps to "U+0053 U+0073" (LATIN CAPITAL
-- LETTER S and LATIN SMALL LETTER S) when converted to titlecase.
--
-- Certain code points (or combinations of code points) apply rules based
-- on the locale. For more information about these exceptional code
-- points, please refer to the Unicode standard:
-- ftp:/ftp.unicode.orgPublicUNIDATASpecialCasing.txt
toTitleWith :: Locale -> Text -> Text
-- | Check if the input string conforms to the category specified by the
-- flags.
--
-- This function can be used to check if the code points in a string are
-- part of a category. Valid flags are members of the "list of
-- categories". The category for a code point is defined as part of the
-- entry in UnicodeData.txt, the data file for the Unicode code point
-- database.
--
-- By default, the function will treat grapheme clusters as a single code
-- point. This means that the following string:
--
--
-- Code point | Canonical combining class | General category | Name
-- ---------- | ------------------------- | --------------------- | ----------------------
-- U+0045 | 0 | Lu (Uppercase letter) | LATIN CAPITAL LETTER E
-- U+0300 | 230 | Mn (Non-spacing mark) | COMBINING GRAVE ACCENT
--
--
-- Will match with categoryLetterUppercase in its entirety,
-- because the COMBINING GRAVE ACCENT is treated as part of the grapheme
-- cluster. This is useful when e.g. creating a text parser, because you
-- do not have to normalize the text first.
--
-- If this is undesired behavior, specify the
-- UTF8_CATEGORY_IGNORE_GRAPHEME_CLUSTER flag.
--
-- In order to maintain backwards compatibility with POSIX functions like
-- isdigit and isspace, compatibility flags have been
-- provided. Note, however, that the result is only guaranteed to be
-- correct for code points in the Basic Latin range, between U+0000 and
-- 0+007F. Combining a compatibility flag with a regular category flag
-- will result in undefined behavior.
isCategory :: Category -> Text -> Bool
-- | Try to match as many code points with the matching category flags as
-- possible and return the prefix and suffix.
spanCategory :: Category -> Text -> (Text, Text)
-- | Unicode categories. See isCategory, you can combine categories
-- with bitwise or.
data Category
categoryLetterUppercase :: Category
categoryLetterLowercase :: Category
categoryLetterTitlecase :: Category
categoryLetterOther :: Category
categoryLetter :: Category
categoryCaseMapped :: Category
categoryMarkNonSpacing :: Category
categoryMarkSpacing :: Category
categoryMarkEnclosing :: Category
categoryMark :: Category
categoryNumberDecimal :: Category
categoryNumberLetter :: Category
categoryNumberOther :: Category
categoryNumber :: Category
categoryPunctuationConnector :: Category
categoryPunctuationDash :: Category
categoryPunctuationOpen :: Category
categoryPunctuationClose :: Category
categoryPunctuationInitial :: Category
categoryPunctuationFinal :: Category
categoryPunctuationOther :: Category
categoryPunctuation :: Category
categorySymbolMath :: Category
categorySymbolCurrency :: Category
categorySymbolModifier :: Category
categorySymbolOther :: Category
categorySymbol :: Category
categorySeparatorSpace :: Category
categorySeparatorLine :: Category
categorySeparatorParagraph :: Category
categorySeparator :: Category
categoryControl :: Category
categoryFormat :: Category
categorySurrogate :: Category
categoryPrivateUse :: Category
categoryUnassigned :: Category
categoryCompatibility :: Category
categoryIgnoreGraphemeCluste :: Category
categoryIscntrl :: Category
categoryIsprint :: Category
categoryIsspace :: Category
categoryIsblank :: Category
categoryIsgraph :: Category
categoryIspunct :: Category
categoryIsalnum :: Category
categoryIsalpha :: Category
categoryIsupper :: Category
categoryIslower :: Category
categoryIsdigit :: Category
categoryIsxdigit :: Category
-- | This module provide a simple resumable Parser, which is
-- suitable for binary protocol and simple textual protocol parsing.
--
-- You can use Alternative instance to do backtracking, each
-- branch will either succeed and may consume some input, or fail without
-- consume anything. It's recommend to use peek to avoid
-- backtracking if possible to get high performance.
module Std.Data.Parser.Base
-- | Simple parsing result, that represent respectively:
--
--
-- - success: the remaining unparsed data and the parsed value
-- - failure: the remaining unparsed data and the error message
-- - partial: that need for more input data, supply empty bytes to
-- indicate endOfInput
--
data Result a
Success :: !Bytes -> a -> Result a
Failure :: !Bytes -> String -> Result a
Partial :: (Bytes -> Result a) -> Result a
type ParseStep r = Bytes -> Result r
-- | Simple CPSed parser
newtype Parser a
Parser :: (forall r. (a -> ParseStep r) -> ParseStep r) -> Parser a
[runParser] :: Parser a -> forall r. (a -> ParseStep r) -> ParseStep r
-- | Parse the complete input, without resupplying
parse :: Parser a -> Bytes -> Either String a
-- | Parse the complete input, without resupplying, return the rest bytes
parse' :: Parser a -> Bytes -> (Bytes, Either String a)
-- | Parse an input chunk
parseChunk :: Parser a -> Bytes -> Result a
-- | Run a parser with an initial input string, and a monadic action that
-- can supply more input if needed.
--
-- Note, once the monadic action return empty bytes, parsers will stop
-- drawing more bytes (take it as endOfInput).
parseChunks :: Monad m => m Bytes -> Parser a -> Bytes -> m (Bytes, Either String a)
-- | Finish parsing and fetch result, feed empty bytes if it's
-- Partial result.
finishParsing :: Result a -> (Bytes, Either String a)
-- | Run a parser and keep track of all the input it consumes. Once it's
-- finished, return the final result (always Success or
-- Failure) and all consumed chunks.
runAndKeepTrack :: Parser a -> Parser (Result a, [Bytes])
-- | Ensure that there are at least n bytes available. If not, the
-- computation will escape with Partial.
ensureN :: Int -> Parser ()
-- | Test whether all input has been consumed, i.e. there are no remaining
-- undecoded bytes.
endOfInput :: Parser Bool
decodePrim :: forall a. UnalignedAccess a => Parser a
decodePrimLE :: forall a. UnalignedAccess (LE a) => Parser a
decodePrimBE :: forall a. UnalignedAccess (BE a) => Parser a
-- | A stateful scanner. The predicate consumes and transforms a state
-- argument, and each transformed state is passed to successive
-- invocations of the predicate on each byte of the input until one
-- returns Nothing or the input ends.
--
-- This parser does not fail. It will return an empty string if the
-- predicate returns Nothing on the first byte of input.
scan :: s -> (s -> Word8 -> Maybe s) -> Parser Bytes
-- | Similar to scan, but working on Bytes chunks, The
-- predicate consumes a Bytes chunk and transforms a state
-- argument, and each transformed state is passed to successive
-- invocations of the predicate on each chunk of the input until one
-- chunk got splited to Right (V.Bytes, V.Bytes) or the input
-- ends.
scanChunks :: s -> (s -> Bytes -> Either s (Bytes, Bytes)) -> Parser Bytes
-- | Match any byte, to perform lookahead. Returns Nothing if end of
-- input has been reached. Does not consume any input.
peekMaybe :: Parser (Maybe Word8)
-- | Match any byte, to perform lookahead. Does not consume any input, but
-- will fail if end of input has been reached.
peek :: Parser Word8
-- | The parser satisfy p succeeds for any byte for which the
-- predicate p returns True. Returns the byte that is
-- actually parsed.
--
--
-- digit = satisfy isDigit
-- where isDigit w = w >= 48 && w <= 57
--
satisfy :: (Word8 -> Bool) -> Parser Word8
-- | The parser satisfyWith f p transforms a byte, and succeeds if
-- the predicate p returns True on the transformed value.
-- The parser returns the transformed byte that was parsed.
satisfyWith :: (Word8 -> a) -> (a -> Bool) -> Parser a
-- | Match a specific byte.
word8 :: Word8 -> Parser ()
-- | Match a specific 8bit char.
char8 :: Char -> Parser ()
-- | Match any byte.
anyWord8 :: Parser Word8
-- | Match either a single newline byte '\n', or a carriage return
-- followed by a newline byte "\r\n".
endOfLine :: Parser ()
-- | skip N bytes.
skip :: Int -> Parser ()
-- | Skip past input for as long as the predicate returns True.
skipWhile :: (Word8 -> Bool) -> Parser ()
-- | Skip over white space using isSpace.
skipSpaces :: Parser ()
take :: Int -> Parser Bytes
-- | Consume input as long as the predicate returns False or reach
-- the end of input, and return the consumed input.
takeTill :: (Word8 -> Bool) -> Parser Bytes
-- | Consume input as long as the predicate returns True or reach
-- the end of input, and return the consumed input.
takeWhile :: (Word8 -> Bool) -> Parser Bytes
-- | Similar to takeWhile, but requires the predicate to succeed on
-- at least one byte of input: it will fail if the predicate never
-- returns True or reach the end of input
takeWhile1 :: (Word8 -> Bool) -> Parser Bytes
-- | bytes s parses a sequence of bytes that identically match
-- s.
bytes :: Bytes -> Parser ()
-- | Same as bytes but ignoring case.
bytesCI :: Bytes -> Parser ()
-- | text s parses a sequence of UTF8 bytes that identically match
-- s.
text :: Text -> Parser ()
instance GHC.Base.Functor Std.Data.Parser.Base.Parser
instance GHC.Base.Applicative Std.Data.Parser.Base.Parser
instance GHC.Base.Monad Std.Data.Parser.Base.Parser
instance Control.Monad.Fail.MonadFail Std.Data.Parser.Base.Parser
instance GHC.Base.MonadPlus Std.Data.Parser.Base.Parser
instance GHC.Base.Alternative Std.Data.Parser.Base.Parser
instance GHC.Base.Functor Std.Data.Parser.Base.Result
instance GHC.Show.Show a => GHC.Show.Show (Std.Data.Parser.Base.Result a)
-- | Textual numeric parsers.
module Std.Data.Parser.Numeric
-- | Parse and decode an unsigned decimal number.
uint :: Integral a => Parser a
-- | Parse a decimal number with an optional leading '+' or
-- '-' sign character.
int :: Integral a => Parser a
-- | Parse and decode an unsigned hex number. The hex digits 'a'
-- through 'f' may be upper or lower case.
--
-- This parser does not accept a leading "0x" string, and
-- consider sign bit part of the binary hex nibbles, i.e. 'parse hex
-- "0xFF" == Right (-1 :: Int8)'
hex :: (Integral a, Bits a) => Parser a
-- | Parse a rational number.
--
-- The syntax accepted by this parser is the same as for double.
--
-- Note: this parser is not safe for use with inputs from
-- untrusted sources. An input with a suitably large exponent such as
-- "1e1000000000" will cause a huge Integer to be
-- allocated, resulting in what is effectively a denial-of-service
-- attack.
--
-- In most cases, it is better to use double or scientific
-- instead.
rational :: Fractional a => Parser a
-- | Parse a rational number and round to Float.
--
-- Single precision version of double.
float :: Parser Float
-- | Parse a rational number and round to Double.
--
-- This parser accepts an optional leading sign character, followed by at
-- least one decimal digit. The syntax similar to that accepted by the
-- read function, with the exception that a trailing '.'
-- or 'e' not followed by a number is not consumed.
--
-- Examples with behaviour identical to read:
--
--
-- parseOnly double "3" == Right ("",1,3.0)
-- parseOnly double "3.1" == Right ("",3,3.1)
-- parseOnly double "3e4" == Right ("",3,30000.0)
-- parseOnly double "3.1e4" == Right ("",5,31000.0)
--
--
--
-- parseOnly double ".3" == Left (".3",0,"takeWhile1")
-- parseOnly double "e3" == Left ("e3",0,"takeWhile1")
--
--
-- Examples of differences from read:
--
--
-- parseOnly double "3.foo" == Right (".foo",1,3.0)
-- parseOnly double "3e" == Right ("e",1,3.0)
--
--
-- This function does not accept string representations of "NaN" or
-- "Infinity".
double :: Parser Double
-- | Parse a scientific number.
--
-- The syntax accepted by this parser is the same as for double.
scientific :: Parser Scientific
-- | Parse a scientific number and convert to result using a user supply
-- function.
--
-- The syntax accepted by this parser is the same as for double.
scientifically :: (Scientific -> a) -> Parser a
-- | This module provide a simple resumable Parser, which is
-- suitable for binary protocol and simple textual protocol parsing.
--
-- You can use Alternative instance to do backtracking, each
-- branch will either succeed and may consume some input, or fail without
-- consume anything. It's recommend to use peek to avoid
-- backtracking if possible to get high performance.
module Std.Data.Parser
-- | Simple parsing result, that represent respectively:
--
--
-- - success: the remaining unparsed data and the parsed value
-- - failure: the remaining unparsed data and the error message
-- - partial: that need for more input data, supply empty bytes to
-- indicate endOfInput
--
data Result a
Success :: !Bytes -> a -> Result a
Failure :: !Bytes -> String -> Result a
Partial :: (Bytes -> Result a) -> Result a
-- | Simple CPSed parser
data Parser a
-- | Parse the complete input, without resupplying
parse :: Parser a -> Bytes -> Either String a
-- | Parse the complete input, without resupplying, return the rest bytes
parse' :: Parser a -> Bytes -> (Bytes, Either String a)
-- | Parse an input chunk
parseChunk :: Parser a -> Bytes -> Result a
-- | Run a parser with an initial input string, and a monadic action that
-- can supply more input if needed.
--
-- Note, once the monadic action return empty bytes, parsers will stop
-- drawing more bytes (take it as endOfInput).
parseChunks :: Monad m => m Bytes -> Parser a -> Bytes -> m (Bytes, Either String a)
-- | Finish parsing and fetch result, feed empty bytes if it's
-- Partial result.
finishParsing :: Result a -> (Bytes, Either String a)
-- | Run a parser and keep track of all the input it consumes. Once it's
-- finished, return the final result (always Success or
-- Failure) and all consumed chunks.
runAndKeepTrack :: Parser a -> Parser (Result a, [Bytes])
-- | Ensure that there are at least n bytes available. If not, the
-- computation will escape with Partial.
ensureN :: Int -> Parser ()
-- | Test whether all input has been consumed, i.e. there are no remaining
-- undecoded bytes.
endOfInput :: Parser Bool
decodePrim :: forall a. UnalignedAccess a => Parser a
decodePrimLE :: forall a. UnalignedAccess (LE a) => Parser a
decodePrimBE :: forall a. UnalignedAccess (BE a) => Parser a
-- | A stateful scanner. The predicate consumes and transforms a state
-- argument, and each transformed state is passed to successive
-- invocations of the predicate on each byte of the input until one
-- returns Nothing or the input ends.
--
-- This parser does not fail. It will return an empty string if the
-- predicate returns Nothing on the first byte of input.
scan :: s -> (s -> Word8 -> Maybe s) -> Parser Bytes
-- | Similar to scan, but working on Bytes chunks, The
-- predicate consumes a Bytes chunk and transforms a state
-- argument, and each transformed state is passed to successive
-- invocations of the predicate on each chunk of the input until one
-- chunk got splited to Right (V.Bytes, V.Bytes) or the input
-- ends.
scanChunks :: s -> (s -> Bytes -> Either s (Bytes, Bytes)) -> Parser Bytes
-- | Match any byte, to perform lookahead. Returns Nothing if end of
-- input has been reached. Does not consume any input.
peekMaybe :: Parser (Maybe Word8)
-- | Match any byte, to perform lookahead. Does not consume any input, but
-- will fail if end of input has been reached.
peek :: Parser Word8
-- | The parser satisfy p succeeds for any byte for which the
-- predicate p returns True. Returns the byte that is
-- actually parsed.
--
--
-- digit = satisfy isDigit
-- where isDigit w = w >= 48 && w <= 57
--
satisfy :: (Word8 -> Bool) -> Parser Word8
-- | The parser satisfyWith f p transforms a byte, and succeeds if
-- the predicate p returns True on the transformed value.
-- The parser returns the transformed byte that was parsed.
satisfyWith :: (Word8 -> a) -> (a -> Bool) -> Parser a
-- | Match a specific byte.
word8 :: Word8 -> Parser ()
-- | Match any byte.
anyWord8 :: Parser Word8
-- | Match either a single newline byte '\n', or a carriage return
-- followed by a newline byte "\r\n".
endOfLine :: Parser ()
-- | skip N bytes.
skip :: Int -> Parser ()
-- | Skip past input for as long as the predicate returns True.
skipWhile :: (Word8 -> Bool) -> Parser ()
-- | Skip over white space using isSpace.
skipSpaces :: Parser ()
take :: Int -> Parser Bytes
-- | Consume input as long as the predicate returns False or reach
-- the end of input, and return the consumed input.
takeTill :: (Word8 -> Bool) -> Parser Bytes
-- | Consume input as long as the predicate returns True or reach
-- the end of input, and return the consumed input.
takeWhile :: (Word8 -> Bool) -> Parser Bytes
-- | Similar to takeWhile, but requires the predicate to succeed on
-- at least one byte of input: it will fail if the predicate never
-- returns True or reach the end of input
takeWhile1 :: (Word8 -> Bool) -> Parser Bytes
-- | bytes s parses a sequence of bytes that identically match
-- s.
bytes :: Bytes -> Parser ()
-- | Same as bytes but ignoring case.
bytesCI :: Bytes -> Parser ()
-- | text s parses a sequence of UTF8 bytes that identically match
-- s.
text :: Text -> Parser ()
-- | Parse and decode an unsigned decimal number.
uint :: Integral a => Parser a
-- | Parse a decimal number with an optional leading '+' or
-- '-' sign character.
int :: Integral a => Parser a
-- | Parse and decode an unsigned hex number. The hex digits 'a'
-- through 'f' may be upper or lower case.
--
-- This parser does not accept a leading "0x" string, and
-- consider sign bit part of the binary hex nibbles, i.e. 'parse hex
-- "0xFF" == Right (-1 :: Int8)'
hex :: (Integral a, Bits a) => Parser a
-- | Parse a rational number.
--
-- The syntax accepted by this parser is the same as for double.
--
-- Note: this parser is not safe for use with inputs from
-- untrusted sources. An input with a suitably large exponent such as
-- "1e1000000000" will cause a huge Integer to be
-- allocated, resulting in what is effectively a denial-of-service
-- attack.
--
-- In most cases, it is better to use double or scientific
-- instead.
rational :: Fractional a => Parser a
-- | Parse a rational number and round to Float.
--
-- Single precision version of double.
float :: Parser Float
-- | Parse a rational number and round to Double.
--
-- This parser accepts an optional leading sign character, followed by at
-- least one decimal digit. The syntax similar to that accepted by the
-- read function, with the exception that a trailing '.'
-- or 'e' not followed by a number is not consumed.
--
-- Examples with behaviour identical to read:
--
--
-- parseOnly double "3" == Right ("",1,3.0)
-- parseOnly double "3.1" == Right ("",3,3.1)
-- parseOnly double "3e4" == Right ("",3,30000.0)
-- parseOnly double "3.1e4" == Right ("",5,31000.0)
--
--
--
-- parseOnly double ".3" == Left (".3",0,"takeWhile1")
-- parseOnly double "e3" == Left ("e3",0,"takeWhile1")
--
--
-- Examples of differences from read:
--
--
-- parseOnly double "3.foo" == Right (".foo",1,3.0)
-- parseOnly double "3e" == Right ("e",1,3.0)
--
--
-- This function does not accept string representations of "NaN" or
-- "Infinity".
double :: Parser Double
-- | Parse a scientific number.
--
-- The syntax accepted by this parser is the same as for double.
scientific :: Parser Scientific
-- | Parse a scientific number and convert to result using a user supply
-- function.
--
-- The syntax accepted by this parser is the same as for double.
scientifically :: (Scientific -> a) -> Parser a
-- | A Builder records a buffer writing function, which can be
-- mappend in O(1) via composition. In stdio a Builder are
-- designed to deal with different AllocateStrategy, it affects
-- how Builder react when writing across buffer boundaries:
--
--
-- - When building a short strict Bytes with
-- 'buildBytes/buildByteswith', we do a DoubleBuffer.
-- - When building a large lazy [Bytes] with
-- 'buildBytesList/buildBytesListwith', we do an InsertChunk.
-- - When building and consuming are interlaced with
-- 'buildAndRun/buildAndRunWith', we do an OneShotAction.
--
--
-- Most of the time using combinators from this module to build
-- Builder s is enough, but in case of rolling something shining
-- from the ground, keep an eye on correct AllocateStrategy
-- handling.
module Std.Data.Builder.Base
-- | AllocateStrategy will decide how each BuildStep proceed
-- when previous buffer is not enough.
data AllocateStrategy s
DoubleBuffer :: AllocateStrategy s
InsertChunk :: {-# UNPACK #-} !Int -> AllocateStrategy s
OneShotAction :: (Bytes -> ST s ()) -> AllocateStrategy s
-- | Helper type to help ghc unpack
data Buffer s
Buffer :: {-# UNPACK #-} !MutablePrimArray s Word8 -> {-# UNPACK #-} !Int -> Buffer s
-- | BuilderStep is a function that fill buffer under given
-- conditions.
type BuildStep s = Buffer s -> ST s [Bytes]
-- | Builder is a monad to help compose BuilderStep. With
-- next BuilderStep continuation, we can do interesting things
-- like perform some action, or interleave the build process.
--
-- Notes on IsString instance: Builder ()'s
-- IsString instance use stringModifiedUTF8, which is
-- different from stringUTF8 in that it DOES NOT PROVIDE UTF8
-- GUARANTEES! :
--
--
-- - NUL will be written as xC0 x80.
-- - xD800 ~ xDFFF will be encoded in three bytes as
-- normal UTF-8 codepoints.
--
newtype Builder a
Builder :: (forall s. AllocateStrategy s -> (a -> BuildStep s) -> BuildStep s) -> Builder a
[runBuilder] :: Builder a -> forall s. AllocateStrategy s -> (a -> BuildStep s) -> BuildStep s
append :: Builder a -> Builder b -> Builder b
-- | shortcut to buildBytesWith defaultInitSize.
buildBytes :: Builder a -> Bytes
-- | run Builder with DoubleBuffer strategy, which is suitable for
-- building short bytes.
buildBytesWith :: Int -> Builder a -> Bytes
-- | shortcut to buildBytesListWith defaultChunkSize.
buildBytesList :: Builder a -> [Bytes]
-- | run Builder with InsertChunk strategy, which is suitable for
-- building lazy bytes chunks.
buildBytesListWith :: Int -> Int -> Builder a -> [Bytes]
-- | shortcut to buildAndRunWith defaultChunkSize.
buildAndRun :: (Bytes -> IO ()) -> Builder a -> IO ()
-- | run Builder with OneShotAction strategy, which is suitable for
-- doing effects while building.
buildAndRunWith :: Int -> (Bytes -> IO ()) -> Builder a -> IO ()
-- | Write a Bytes.
bytes :: Bytes -> Builder ()
-- | Ensure that there are at least n many elements available.
ensureN :: Int -> Builder ()
atMost :: Int -> (forall s. MutablePrimArray s Word8 -> Int -> ST s Int) -> Builder ()
writeN :: Int -> (forall s. MutablePrimArray s Word8 -> Int -> ST s ()) -> Builder ()
doubleBuffer :: Int -> BuildStep s -> BuildStep s
insertChunk :: Int -> Int -> BuildStep s -> BuildStep s
oneShotAction :: (Bytes -> ST s ()) -> Int -> BuildStep s -> BuildStep s
-- | write primitive types in host byte order.
encodePrim :: forall a. UnalignedAccess a => a -> Builder ()
-- | write primitive types with little endianess.
encodePrimLE :: forall a. UnalignedAccess (LE a) => a -> Builder ()
-- | write primitive types with big endianess.
encodePrimBE :: forall a. UnalignedAccess (BE a) => a -> Builder ()
-- | Encode string with modified UTF-8 encoding, will be rewritten to a
-- memcpy if possible.
stringModifiedUTF8 :: String -> Builder ()
-- | Turn Char into Builder with Modified UTF8 encoding
--
-- '\NUL' is encoded as two bytes C0 80 , '\xD800' ~ '\xDFFF' is
-- encoded as a three bytes normal UTF-8 codepoint.
charModifiedUTF8 :: Char -> Builder ()
-- | Turn String into Builder with UTF8 encoding
--
-- Illegal codepoints will be written as replacementChars.
--
-- Note, if you're trying to write string literals builders, and you know
-- it doen't contain '\NUL' or surrgate codepoints, then you can open
-- OverloadedStrings and use Builder's IsString
-- instance, it can save an extra UTF-8 validation.
--
-- This function will be rewritten into a memcpy if possible, (running a
-- fast UTF-8 validation at runtime first).
stringUTF8 :: String -> Builder ()
-- | Turn Char into Builder with UTF8 encoding
--
-- Illegal codepoints will be written as replacementChars.
charUTF8 :: Char -> Builder ()
-- | Turn String into Builder with ASCII7 encoding
--
-- Codepoints beyond '\x7F' will be chopped.
string7 :: String -> Builder ()
-- | Turn Char into Builder with ASCII7 encoding
--
-- Codepoints beyond '\x7F' will be chopped.
char7 :: Char -> Builder ()
-- | Turn String into Builder with ASCII8 encoding
--
-- Codepoints beyond '\xFF' will be chopped. Note, this encoding
-- is NOT compatible with UTF8 encoding, i.e. bytes written by this
-- builder may not be legal UTF8 encoding bytes.
string8 :: String -> Builder ()
-- | Turn Char into Builder with ASCII8 encoding
--
-- Codepoints beyond '\xFF' will be chopped. Note, this encoding
-- is NOT compatible with UTF8 encoding, i.e. bytes written by this
-- builder may not be legal UTF8 encoding bytes.
char8 :: Char -> Builder ()
-- | Write UTF8 encoded Text using Builder.
--
-- Note, if you're trying to write string literals builders, please open
-- OverloadedStrings and use Builders IsString
-- instance, it will be rewritten into a memcpy.
text :: Text -> Builder ()
instance GHC.Base.Functor Std.Data.Builder.Base.Builder
instance GHC.Base.Applicative Std.Data.Builder.Base.Builder
instance GHC.Base.Monad Std.Data.Builder.Base.Builder
instance GHC.Base.Semigroup (Std.Data.Builder.Base.Builder ())
instance GHC.Base.Monoid (Std.Data.Builder.Base.Builder ())
instance (a Data.Type.Equality.~ ()) => Data.String.IsString (Std.Data.Builder.Base.Builder a)
-- | This module provide buffered IO interface.
module Std.IO.Buffered
-- | Input device
--
-- Laws: readInput should return 0 on EOF.
--
-- Note: readInput is considered not thread-safe, e.g. A
-- Input device can only be used with a single
-- BufferedInput, If multiple BufferedInput s are opened on
-- a same Input device, the behaviour will be undefined.
class Input i
readInput :: (Input i, HasCallStack) => i -> Ptr Word8 -> Int -> IO Int
-- | Output device
--
-- Laws: writeOutput should not return until all data are written
-- (may not necessarily flushed to hardware, that should be done in
-- device specific way).
class Output o
writeOutput :: (Output o, HasCallStack) => o -> Ptr Word8 -> Int -> IO ()
-- | Input device with buffer, NOT THREAD SAFE!
data BufferedInput i
newBufferedInput :: input -> Int -> IO (BufferedInput input)
-- | Request bytes from BufferedInput.
--
-- The buffering logic is quite simple:
--
-- If we have pushed back bytes, directly return it, otherwise we read
-- using buffer size. If we read N bytes, and N is larger than half of
-- the buffer size, then we freeze buffer and return, otherwise we copy
-- buffer into result and reuse buffer afterward.
readBuffer :: (HasCallStack, Input i) => BufferedInput i -> IO Bytes
-- | Push bytes back into buffer
unReadBuffer :: (HasCallStack, Input i) => Bytes -> BufferedInput i -> IO ()
-- | Read buffer and parse with Parser.
readParser :: (HasCallStack, Input i) => Parser a -> BufferedInput i -> IO (ReadResult a)
-- | Read exactly N bytes
--
-- If EOF reached before N bytes read, a ShortReadException will
-- be thrown
readExactly :: (HasCallStack, Input i) => Int -> BufferedInput i -> IO Bytes
-- | Read until reach a magic bytes
--
-- If EOF is reached before meet a magic byte, partial bytes are
-- returned.
readToMagic :: (HasCallStack, Input i) => Word8 -> BufferedInput i -> IO Bytes
-- | Read until reach a magic bytes
--
-- If EOF is reached before meet a magic byte, a
-- ShortReadException will be thrown.
readToMagic' :: (HasCallStack, Input i) => Word8 -> BufferedInput i -> IO Bytes
-- | Read to a linefeed ('\n' or '\r\n'), return Bytes before it.
--
-- If EOF is reached before meet a magic byte, partial line is returned.
readLine :: (HasCallStack, Input i) => BufferedInput i -> IO Bytes
-- | Read to a linefeed ('\n' or '\r\n'), return Bytes before it.
--
-- If EOF reached before meet a magic byte, a ShortReadException
-- will be thrown.
readLine' :: (HasCallStack, Input i) => BufferedInput i -> IO Bytes
-- | Output device with buffer, NOT THREAD SAFE!
data BufferedOutput o
newBufferedOutput :: output -> Int -> IO (BufferedOutput output)
-- | Write Bytes into buffered handle.
--
-- Copy Bytes to buffer if it can hold, otherwise write both
-- buffer(if not empty) and Bytes.
writeBuffer :: Output o => BufferedOutput o -> Bytes -> IO ()
-- | Write Bytes into buffered handle.
--
-- Copy Bytes to buffer if it can hold, otherwise write both
-- buffer(if not empty) and Bytes.
writeBuilder :: Output o => BufferedOutput o -> Builder a -> IO ()
-- | Flush the buffer(if not empty).
flushBuffer :: Output f => BufferedOutput f -> IO ()
data ShortReadException
ShortReadException :: IOEInfo -> ShortReadException
instance GHC.Show.Show a => GHC.Show.Show (Std.IO.Buffered.ReadResult a)
instance GHC.Show.Show Std.IO.Buffered.ShortReadException
instance GHC.Exception.Type.Exception Std.IO.Buffered.ShortReadException
-- | Textual numeric builders.
module Std.Data.Builder.Numeric
-- | Integral formatting options.
data IFormat
IFormat :: Int -> Padding -> Bool -> IFormat
-- | total width, only effective with padding options
[width] :: IFormat -> Int
-- | padding options
[padding] :: IFormat -> Padding
-- | show + when the number is positive
[postiveSign] :: IFormat -> Bool
-- |
-- defaultIFormat = IFormat 0 NoPadding False Decimal
--
defaultIFormat :: IFormat
data Padding
NoPadding :: Padding
ZeroPadding :: Padding
LeftSpacePadding :: Padding
RightSpacePadding :: Padding
-- |
-- int = intWith defaultIFormat
--
int :: (Integral a, Bounded a) => a -> Builder ()
-- | Format a Bounded Integral type like Int or
-- Word16 into decimal ASCII digits.
intWith :: (Integral a, Bounded a) => IFormat -> a -> Builder ()
-- | Format a Integer into decimal ASCII digits.
integer :: Integer -> Builder ()
-- | Format a FiniteBits Integral type into hex nibbles.
hex :: forall a. (FiniteBits a, Integral a) => a -> Builder ()
-- | The UPPERCASED version of hex.
heX :: forall a. (FiniteBits a, Integral a) => a -> Builder ()
-- | Control the rendering of floating point numbers.
data FFormat
-- | Scientific notation (e.g. 2.3e123).
Exponent :: FFormat
-- | Standard decimal notation.
Fixed :: FFormat
-- | Use decimal notation for values between 0.1 and
-- 9,999,999, and scientific notation otherwise.
Generic :: FFormat
-- | Decimal encoding of an IEEE Double.
--
-- Using standard decimal notation for arguments whose absolute value
-- lies between 0.1 and 9,999,999, and scientific
-- notation otherwise.
double :: Double -> Builder ()
-- | Format double-precision float using drisu3 with dragon4 fallback.
doubleWith :: FFormat -> Maybe Int -> Double -> Builder ()
-- | Decimal encoding of an IEEE Float.
--
-- Using standard decimal notation for arguments whose absolute value
-- lies between 0.1 and 9,999,999, and scientific
-- notation otherwise.
float :: Float -> Builder ()
-- | Format single-precision float using drisu3 with dragon4 fallback.
floatWith :: FFormat -> Maybe Int -> Float -> Builder ()
-- | A Builder which renders a scientific number to full
-- precision, using standard decimal notation for arguments whose
-- absolute value lies between 0.1 and 9,999,999, and
-- scientific notation otherwise.
scientific :: Scientific -> Builder ()
-- | Like scientific but provides rendering options.
scientificWith :: FFormat -> Maybe Int -> Scientific -> Builder ()
-- | Decimal encoding of a Double.
grisu3 :: Double -> Maybe ([Int], Int)
-- | Decimal encoding of a Float.
grisu3_sp :: Float -> Maybe ([Int], Int)
-- | Decimal digit to ASCII digit.
i2wDec :: Integral a => a -> Word8
-- | Hexadecimal digit to ASCII char.
i2wHex :: Integral a => a -> Word8
-- | Hexadecimal digit to UPPERCASED ASCII char.
i2wHeX :: Integral a => a -> Word8
-- | Count how many decimal digits an integer has.
countDigits :: Integral a => a -> Int
instance GHC.Show.Show Std.Data.Builder.Numeric.FFormat
instance GHC.Read.Read Std.Data.Builder.Numeric.FFormat
instance GHC.Enum.Enum Std.Data.Builder.Numeric.FFormat
instance GHC.Classes.Ord Std.Data.Builder.Numeric.IFormat
instance GHC.Classes.Eq Std.Data.Builder.Numeric.IFormat
instance GHC.Show.Show Std.Data.Builder.Numeric.IFormat
instance GHC.Classes.Ord Std.Data.Builder.Numeric.Padding
instance GHC.Classes.Eq Std.Data.Builder.Numeric.Padding
instance GHC.Show.Show Std.Data.Builder.Numeric.Padding
-- | UTF8 compatible textual builders.
module Std.Data.TextBuilder
-- | Buidlers which guarantee UTF-8 encoding, thus can be used to build
-- text directly.
--
-- Notes on IsString instance: It's recommended to use
-- IsString instance instead of stringUTF8 or
-- string7 since there's a rewrite rule to turn encoding loop into
-- a memcpy, which is much faster.
--
-- Different from 'Builder ()', 'TextBuilder ()''s IsString
-- instance will gives desired UTF8 guarantees:
--
--
-- - "NUL" will be written directly as x00.
-- - xD800 ~ xDFFF will be replaced by replacement
-- char.
--
newtype TextBuilder a
TextBuilder :: Builder a -> TextBuilder a
[toBuilder] :: TextBuilder a -> Builder a
buildText :: TextBuilder a -> Text
-- | Turn String into TextBuilder with UTF8 encoding
--
-- Illegal codepoints will be written as replacementChars. This
-- function will be rewritten into a memcpy if possible, (running a fast
-- UTF-8 validation at runtime first).
stringUTF8 :: String -> TextBuilder ()
-- | Turn Char into TextBuilder with UTF8 encoding
--
-- Illegal codepoints will be written as replacementChars.
charUTF8 :: Char -> TextBuilder ()
-- | Turn String into TextBuilder with ASCII7 encoding
--
-- Codepoints beyond '\x7F' will be chopped.
string7 :: String -> TextBuilder ()
-- | Turn Char into TextBuilder with ASCII7 encoding
--
-- Codepoints beyond '\x7F' will be chopped.
char7 :: Char -> TextBuilder ()
-- | Write UTF8 encoded Text using Builder.
--
-- Note, if you're trying to write string literals builders, please open
-- OverloadedStrings and use Builders IsString
-- instance, it will be rewritten into a memcpy.
text :: Text -> TextBuilder ()
-- | Integral formatting options.
data IFormat
IFormat :: Int -> Padding -> Bool -> IFormat
-- | total width, only effective with padding options
[width] :: IFormat -> Int
-- | padding options
[padding] :: IFormat -> Padding
-- | show + when the number is positive
[postiveSign] :: IFormat -> Bool
-- |
-- defaultIFormat = IFormat 0 NoPadding False Decimal
--
defaultIFormat :: IFormat
data Padding
NoPadding :: Padding
ZeroPadding :: Padding
LeftSpacePadding :: Padding
RightSpacePadding :: Padding
-- |
-- int = intWith defaultIFormat
--
int :: (Integral a, Bounded a) => a -> TextBuilder ()
-- | Format a Bounded Integral type like Int or
-- Word16 into decimal ascii digits.
intWith :: (Integral a, Bounded a) => IFormat -> a -> TextBuilder ()
-- | Format a Integer into decimal ascii digits.
integer :: Integer -> TextBuilder ()
-- | Format a FiniteBits Integral type into hex nibbles.
hex :: (FiniteBits a, Integral a) => a -> TextBuilder ()
-- | The UPPERCASED version of hex.
heX :: (FiniteBits a, Integral a) => a -> TextBuilder ()
-- | Control the rendering of floating point numbers.
data FFormat
-- | Scientific notation (e.g. 2.3e123).
Exponent :: FFormat
-- | Standard decimal notation.
Fixed :: FFormat
-- | Use decimal notation for values between 0.1 and
-- 9,999,999, and scientific notation otherwise.
Generic :: FFormat
-- | Decimal encoding of an IEEE Double.
--
-- Using standard decimal notation for arguments whose absolute value
-- lies between 0.1 and 9,999,999, and scientific
-- notation otherwise.
double :: Double -> TextBuilder ()
-- | Format double-precision float using drisu3 with dragon4 fallback.
doubleWith :: FFormat -> Maybe Int -> Double -> TextBuilder ()
-- | Decimal encoding of an IEEE Float.
--
-- Using standard decimal notation for arguments whose absolute value
-- lies between 0.1 and 9,999,999, and scientific
-- notation otherwise.
float :: Float -> TextBuilder ()
-- | Format single-precision float using drisu3 with dragon4 fallback.
floatWith :: FFormat -> Maybe Int -> Float -> TextBuilder ()
-- | A Builder which renders a scientific number to full
-- precision, using standard decimal notation for arguments whose
-- absolute value lies between 0.1 and 9,999,999, and
-- scientific notation otherwise.
scientific :: Scientific -> TextBuilder ()
-- | Like scientific but provides rendering options.
scientificWith :: FFormat -> Maybe Int -> Scientific -> TextBuilder ()
instance GHC.Base.Monad Std.Data.TextBuilder.TextBuilder
instance GHC.Base.Applicative Std.Data.TextBuilder.TextBuilder
instance GHC.Base.Functor Std.Data.TextBuilder.TextBuilder
instance GHC.Base.Semigroup (Std.Data.TextBuilder.TextBuilder ())
instance GHC.Base.Monoid (Std.Data.TextBuilder.TextBuilder ())
instance (a Data.Type.Equality.~ ()) => Data.String.IsString (Std.Data.TextBuilder.TextBuilder a)
-- | A Builder records a buffer writing function, which can be
-- mappend in O(1) via composition. This module provides many
-- functions to turn basic data types into Builders, which can
-- used to build strict Bytes or list of Bytes chunks.
module Std.Data.Builder
-- | Builder is a monad to help compose BuilderStep. With
-- next BuilderStep continuation, we can do interesting things
-- like perform some action, or interleave the build process.
--
-- Notes on IsString instance: Builder ()'s
-- IsString instance use stringModifiedUTF8, which is
-- different from stringUTF8 in that it DOES NOT PROVIDE UTF8
-- GUARANTEES! :
--
--
-- - NUL will be written as xC0 x80.
-- - xD800 ~ xDFFF will be encoded in three bytes as
-- normal UTF-8 codepoints.
--
data Builder a
append :: Builder a -> Builder b -> Builder b
-- | shortcut to buildBytesWith defaultInitSize.
buildBytes :: Builder a -> Bytes
-- | run Builder with DoubleBuffer strategy, which is suitable for
-- building short bytes.
buildBytesWith :: Int -> Builder a -> Bytes
-- | shortcut to buildBytesListWith defaultChunkSize.
buildBytesList :: Builder a -> [Bytes]
-- | run Builder with InsertChunk strategy, which is suitable for
-- building lazy bytes chunks.
buildBytesListWith :: Int -> Int -> Builder a -> [Bytes]
-- | shortcut to buildAndRunWith defaultChunkSize.
buildAndRun :: (Bytes -> IO ()) -> Builder a -> IO ()
-- | run Builder with OneShotAction strategy, which is suitable for
-- doing effects while building.
buildAndRunWith :: Int -> (Bytes -> IO ()) -> Builder a -> IO ()
-- | Write a Bytes.
bytes :: Bytes -> Builder ()
-- | Ensure that there are at least n many elements available.
ensureN :: Int -> Builder ()
atMost :: Int -> (forall s. MutablePrimArray s Word8 -> Int -> ST s Int) -> Builder ()
writeN :: Int -> (forall s. MutablePrimArray s Word8 -> Int -> ST s ()) -> Builder ()
-- | write primitive types in host byte order.
encodePrim :: forall a. UnalignedAccess a => a -> Builder ()
-- | write primitive types with little endianess.
encodePrimLE :: forall a. UnalignedAccess (LE a) => a -> Builder ()
-- | write primitive types with big endianess.
encodePrimBE :: forall a. UnalignedAccess (BE a) => a -> Builder ()
-- | Turn String into Builder with UTF8 encoding
--
-- Illegal codepoints will be written as replacementChars.
--
-- Note, if you're trying to write string literals builders, and you know
-- it doen't contain '\NUL' or surrgate codepoints, then you can open
-- OverloadedStrings and use Builder's IsString
-- instance, it can save an extra UTF-8 validation.
--
-- This function will be rewritten into a memcpy if possible, (running a
-- fast UTF-8 validation at runtime first).
stringUTF8 :: String -> Builder ()
-- | Turn Char into Builder with UTF8 encoding
--
-- Illegal codepoints will be written as replacementChars.
charUTF8 :: Char -> Builder ()
-- | Turn String into Builder with ASCII7 encoding
--
-- Codepoints beyond '\x7F' will be chopped.
string7 :: String -> Builder ()
-- | Turn Char into Builder with ASCII7 encoding
--
-- Codepoints beyond '\x7F' will be chopped.
char7 :: Char -> Builder ()
-- | Turn String into Builder with ASCII8 encoding
--
-- Codepoints beyond '\xFF' will be chopped. Note, this encoding
-- is NOT compatible with UTF8 encoding, i.e. bytes written by this
-- builder may not be legal UTF8 encoding bytes.
string8 :: String -> Builder ()
-- | Turn Char into Builder with ASCII8 encoding
--
-- Codepoints beyond '\xFF' will be chopped. Note, this encoding
-- is NOT compatible with UTF8 encoding, i.e. bytes written by this
-- builder may not be legal UTF8 encoding bytes.
char8 :: Char -> Builder ()
-- | Write UTF8 encoded Text using Builder.
--
-- Note, if you're trying to write string literals builders, please open
-- OverloadedStrings and use Builders IsString
-- instance, it will be rewritten into a memcpy.
text :: Text -> Builder ()
-- | Integral formatting options.
data IFormat
IFormat :: Int -> Padding -> Bool -> IFormat
-- | total width, only effective with padding options
[width] :: IFormat -> Int
-- | padding options
[padding] :: IFormat -> Padding
-- | show + when the number is positive
[postiveSign] :: IFormat -> Bool
-- |
-- defaultIFormat = IFormat 0 NoPadding False Decimal
--
defaultIFormat :: IFormat
data Padding
NoPadding :: Padding
ZeroPadding :: Padding
LeftSpacePadding :: Padding
RightSpacePadding :: Padding
-- |
-- int = intWith defaultIFormat
--
int :: (Integral a, Bounded a) => a -> Builder ()
-- | Format a Bounded Integral type like Int or
-- Word16 into decimal ASCII digits.
intWith :: (Integral a, Bounded a) => IFormat -> a -> Builder ()
-- | Format a Integer into decimal ASCII digits.
integer :: Integer -> Builder ()
-- | Format a FiniteBits Integral type into hex nibbles.
hex :: forall a. (FiniteBits a, Integral a) => a -> Builder ()
-- | The UPPERCASED version of hex.
heX :: forall a. (FiniteBits a, Integral a) => a -> Builder ()
-- | Control the rendering of floating point numbers.
data FFormat
-- | Scientific notation (e.g. 2.3e123).
Exponent :: FFormat
-- | Standard decimal notation.
Fixed :: FFormat
-- | Use decimal notation for values between 0.1 and
-- 9,999,999, and scientific notation otherwise.
Generic :: FFormat
-- | Decimal encoding of an IEEE Double.
--
-- Using standard decimal notation for arguments whose absolute value
-- lies between 0.1 and 9,999,999, and scientific
-- notation otherwise.
double :: Double -> Builder ()
-- | Format double-precision float using drisu3 with dragon4 fallback.
doubleWith :: FFormat -> Maybe Int -> Double -> Builder ()
-- | Decimal encoding of an IEEE Float.
--
-- Using standard decimal notation for arguments whose absolute value
-- lies between 0.1 and 9,999,999, and scientific
-- notation otherwise.
float :: Float -> Builder ()
-- | Format single-precision float using drisu3 with dragon4 fallback.
floatWith :: FFormat -> Maybe Int -> Float -> Builder ()
-- | A Builder which renders a scientific number to full
-- precision, using standard decimal notation for arguments whose
-- absolute value lies between 0.1 and 9,999,999, and
-- scientific notation otherwise.
scientific :: Scientific -> Builder ()
-- | Like scientific but provides rendering options.
scientificWith :: FFormat -> Maybe Int -> Scientific -> Builder ()
-- | This module provide CBytes with some useful instances /
-- functions, A CBytes is a wrapper for immutable null-terminated
-- string. The main design target of this type is to ease the bridging of
-- C FFI APIs, since most of the unix APIs use null-terminated string. On
-- windows you're encouraged to use a compatibility layer like
-- 'WideCharToMultiByte/MultiByteToWideChar' and keep the same interface,
-- e.g. libuv do this when deal with file paths.
--
-- We neither guarantee to store length info, nor support O(1) slice for
-- CBytes: This will defeat the purpose of null-terminated string
-- which is to save memory, We do save the length if it's created on GHC
-- heap though. If you need advance editing, convert a CBytes to
-- Bytes with toBytes and use vector combinators. Use
-- fromBytes to convert it back.
--
-- It can be used with OverloadedString, literal encoding is
-- UTF-8 with some modifications: NUL char is encoded to 'C0
-- 80', and '\xD800' ~ '\xDFFF' is encoded as a three bytes normal utf-8
-- codepoint. This is also how ghc compile string literal into binaries,
-- thus we can use rewrite-rules to construct CBytes value in O(1)
-- without wasting runtime heap.
--
-- Note most of the unix API is not unicode awared though, you may find a
-- scandir call return a filename which is not proper encoded in
-- any unicode encoding at all. But still, UTF-8 is recommanded to be
-- used everywhere, and we use UTF-8 assumption in various places, such
-- as displaying CBytes and literals encoding above.
module Std.Data.CBytes
-- | A efficient wrapper for immutable null-terminated string which can be
-- automatically freed by ghc garbage collector.
data CBytes
-- | Create a CBytes with IO action.
--
-- User only have to do content initialization and return the content
-- length, create takes the responsibility to add the '\NUL'
-- ternimator.
create :: HasCallStack => Int -> (CString -> IO Int) -> IO CBytes
-- | Pack a String into null-terminated CBytes.
--
-- '\NUL' is encoded as two bytes C0 80 , '\xD800' ~ '\xDFFF' is
-- encoded as a three bytes normal UTF-8 codepoint.
pack :: String -> CBytes
unpack :: CBytes -> String
null :: CBytes -> Bool
length :: CBytes -> Int
empty :: CBytes
append :: CBytes -> CBytes -> CBytes
concat :: [CBytes] -> CBytes
-- | O(1), (O(n) in case of literal), convert to
-- Bytes, which can be processed by vector combinators.
--
-- NOTE: the '\NUL' ternimator is not included.
toBytes :: CBytes -> Bytes
-- | O(n), convert from Bytes, allocate pinned memory and add
-- the '\NUL' ternimator
fromBytes :: Bytes -> CBytes
-- | O(n), convert from Text, allocate pinned memory and add
-- the '\NUL' ternimator
fromText :: Text -> CBytes
-- | Copy a CString type into a CBytes, return Nothing if the
-- pointer is NULL.
--
-- After copying you're free to free the CString 's memory.
fromCStringMaybe :: HasCallStack => CString -> IO (Maybe CBytes)
-- | Same with fromCStringMaybe, but throw InvalidArgument
-- when meet a null pointer.
fromCString :: HasCallStack => CString -> IO CBytes
-- | Same with fromCString, but only take N bytes (and append a null
-- byte as terminator).
fromCStringN :: HasCallStack => CString -> Int -> IO CBytes
-- | Pass CBytes to foreign function as a const char*.
--
-- Don't pass a forever loop to this function, see #14346.
withCBytes :: CBytes -> (CString -> IO a) -> IO a
instance GHC.Show.Show Std.Data.CBytes.CBytes
instance GHC.Read.Read Std.Data.CBytes.CBytes
instance GHC.Classes.Eq Std.Data.CBytes.CBytes
instance GHC.Classes.Ord Std.Data.CBytes.CBytes
instance GHC.Base.Semigroup Std.Data.CBytes.CBytes
instance GHC.Base.Monoid Std.Data.CBytes.CBytes
instance Data.Hashable.Class.Hashable Std.Data.CBytes.CBytes
instance Data.String.IsString Std.Data.CBytes.CBytes
-- | This module provides necessary types and constant for low level socket
-- operation.
module Std.IO.SockAddr
-- | IPv4 or IPv6 socket address, i.e. the sockaddr_in or
-- sockaddr_in6 struct.
data SockAddr
SockAddrInet :: {-# UNPACK #-} !PortNumber -> {-# UNPACK #-} !InetAddr -> SockAddr
SockAddrInet6 :: {-# UNPACK #-} !PortNumber -> {-# UNPACK #-} !FlowInfo -> {-# UNPACK #-} !Inet6Addr -> {-# UNPACK #-} !ScopeID -> SockAddr
sockAddrFamily :: SockAddr -> SocketFamily
peekSockAddr :: HasCallStack => Ptr SockAddr -> IO SockAddr
withSockAddr :: SockAddr -> (Ptr SockAddr -> IO a) -> IO a
-- | Independent of endianness. For example 127.0.0.1 is stored as
-- (127, 0, 0, 1).
--
-- For direct manipulation prefer inetAddrToTuple and
-- tupleToInetAddr.
data InetAddr
-- |
-- 0.0.0.0
--
inetAny :: InetAddr
-- |
-- 255.255.255.255
--
inetBroadcast :: InetAddr
-- |
-- 255.255.255.255
--
inetNone :: InetAddr
-- |
-- 127.0.0.1
--
inetLoopback :: InetAddr
-- |
-- 224.0.0.0
--
inetUnspecificGroup :: InetAddr
-- |
-- 224.0.0.1
--
inetAllHostsGroup :: InetAddr
-- |
-- 224.0.0.255
--
inetMaxLocalGroup :: InetAddr
-- | Converts HostAddress to representation-independent IPv4
-- quadruple. For example for 127.0.0.1 the function will return
-- (127, 0, 0, 1) regardless of host endianness.
inetAddrToTuple :: InetAddr -> (Word8, Word8, Word8, Word8)
-- | Converts IPv4 quadruple to HostAddress.
tupleToInetAddr :: (Word8, Word8, Word8, Word8) -> InetAddr
-- | Independent of endianness. For example ::1 is stored as
-- (0, 0, 0, 1).
--
-- For direct manipulation prefer inet6AddrToTuple and
-- tupleToInet6Addr.
data Inet6Addr
-- |
-- ::
--
inet6Any :: Inet6Addr
-- |
-- ::1
--
inet6Loopback :: Inet6Addr
inet6AddrToTuple :: Inet6Addr -> (Word16, Word16, Word16, Word16, Word16, Word16, Word16, Word16)
tupleToInet6Addr :: (Word16, Word16, Word16, Word16, Word16, Word16, Word16, Word16) -> Inet6Addr
type FlowInfo = Word32
type ScopeID = Word32
-- | Use the Num instance (i.e. use a literal or
-- fromIntegral) to create a PortNumber value with the
-- correct network-byte-ordering.
--
--
-- >>> 1 :: PortNumber
-- 1
--
-- >>> read "1" :: PortNumber
-- 1
--
data PortNumber
aNY_PORT :: PortNumber
htons :: Word16 -> Word16
ntohs :: Word16 -> Word16
ntohl :: Word32 -> Word32
htonl :: Word32 -> Word32
newtype SocketFamily
SocketFamily :: CInt -> SocketFamily
-- | unspecified
-- | internetwork: UDP, TCP, etc
-- | Internet Protocol version 6
newtype SocketType
SocketType :: CInt -> SocketType
newtype SocketProtocol
SocketProtocol :: CInt -> SocketProtocol
instance GHC.Classes.Ord Std.IO.SockAddr.SocketProtocol
instance GHC.Classes.Eq Std.IO.SockAddr.SocketProtocol
instance GHC.Read.Read Std.IO.SockAddr.SocketProtocol
instance GHC.Show.Show Std.IO.SockAddr.SocketProtocol
instance GHC.Classes.Ord Std.IO.SockAddr.SocketType
instance GHC.Classes.Eq Std.IO.SockAddr.SocketType
instance GHC.Read.Read Std.IO.SockAddr.SocketType
instance GHC.Show.Show Std.IO.SockAddr.SocketType
instance GHC.Classes.Ord Std.IO.SockAddr.SocketFamily
instance GHC.Classes.Eq Std.IO.SockAddr.SocketFamily
instance GHC.Read.Read Std.IO.SockAddr.SocketFamily
instance GHC.Show.Show Std.IO.SockAddr.SocketFamily
instance GHC.Classes.Ord Std.IO.SockAddr.SockAddr
instance GHC.Classes.Eq Std.IO.SockAddr.SockAddr
instance GHC.Show.Show Std.IO.SockAddr.SockAddr
instance GHC.Classes.Ord Std.IO.SockAddr.PortNumber
instance GHC.Classes.Eq Std.IO.SockAddr.PortNumber
instance GHC.Classes.Ord Std.IO.SockAddr.Inet6Addr
instance GHC.Classes.Eq Std.IO.SockAddr.Inet6Addr
instance GHC.Classes.Ord Std.IO.SockAddr.InetAddr
instance GHC.Classes.Eq Std.IO.SockAddr.InetAddr
instance Foreign.Storable.Storable Std.IO.SockAddr.SocketProtocol
instance Foreign.Storable.Storable Std.IO.SockAddr.SocketType
instance Foreign.Storable.Storable Std.IO.SockAddr.SocketFamily
instance GHC.Show.Show Std.IO.SockAddr.PortNumber
instance GHC.Read.Read Std.IO.SockAddr.PortNumber
instance GHC.Enum.Enum Std.IO.SockAddr.PortNumber
instance GHC.Num.Num Std.IO.SockAddr.PortNumber
instance GHC.Real.Real Std.IO.SockAddr.PortNumber
instance GHC.Real.Integral Std.IO.SockAddr.PortNumber
instance Foreign.Storable.Storable Std.IO.SockAddr.PortNumber
instance GHC.Show.Show Std.IO.SockAddr.Inet6Addr
instance Foreign.Storable.Storable Std.IO.SockAddr.Inet6Addr
instance GHC.Show.Show Std.IO.SockAddr.InetAddr
instance Foreign.Storable.Storable Std.IO.SockAddr.InetAddr
-- | LEON (Little Endian first Object Notation)
-- is an efficiently serialization using simple binary encoding. As
-- suggested by its name, default instances use little endian encoding,
-- i.e. "Intel convention". We do provide instances for BE type
-- which explicitly write wrapped value in big endian though. encoded
-- data should be portable across machine endianness, word size, or
-- compiler version within one major version. For example, data encoded
-- using the LEON class could be written on any machine, and read
-- back on any another using stdio packages with the same major
-- version.
module Std.Data.LEON
-- | LEON, Little Endian Object Notation.
class LEON a
encode :: LEON a => a -> Builder ()
decode :: LEON a => Parser a
encode :: (LEON a, Generic a, GLEONEncode (Rep a)) => a -> Builder ()
decode :: (LEON a, Generic a, GLEONDecode (Rep a)) => Parser a
-- | big endianess wrapper
newtype BE a
BE :: a -> BE a
[getBE] :: BE a -> a
instance (Std.Data.LEON.GSumEncode a, Std.Data.LEON.GSumEncode b, Std.Data.LEON.SumSize a, Std.Data.LEON.SumSize b) => Std.Data.LEON.GLEONEncode (a GHC.Generics.:+: b)
instance (Std.Data.LEON.GSumDecode a, Std.Data.LEON.GSumDecode b, Std.Data.LEON.SumSize a, Std.Data.LEON.SumSize b) => Std.Data.LEON.GLEONDecode (a GHC.Generics.:+: b)
instance (Std.Data.LEON.SumSize a, Std.Data.LEON.SumSize b) => Std.Data.LEON.SumSize (a GHC.Generics.:+: b)
instance Std.Data.LEON.SumSize (GHC.Generics.C1 c a)
instance (Std.Data.LEON.GSumEncode a, Std.Data.LEON.GSumEncode b) => Std.Data.LEON.GSumEncode (a GHC.Generics.:+: b)
instance Std.Data.LEON.GLEONEncode a => Std.Data.LEON.GSumEncode (GHC.Generics.C1 c a)
instance (Std.Data.LEON.GSumDecode a, Std.Data.LEON.GSumDecode b) => Std.Data.LEON.GSumDecode (a GHC.Generics.:+: b)
instance Std.Data.LEON.GLEONDecode a => Std.Data.LEON.GSumDecode (GHC.Generics.C1 c a)
instance Std.Data.LEON.LEON GHC.Natural.Natural
instance Std.Data.LEON.LEON GHC.Integer.Type.Integer
instance Std.Data.LEON.LEON GHC.Word.Word8
instance Std.Data.LEON.LEON GHC.Types.Word
instance Std.Data.LEON.LEON (Std.Data.PrimArray.UnalignedAccess.BE GHC.Types.Word)
instance Std.Data.LEON.LEON GHC.Int.Int8
instance Std.Data.LEON.LEON GHC.Types.Int
instance Std.Data.LEON.LEON (Std.Data.PrimArray.UnalignedAccess.BE GHC.Types.Int)
instance Std.Data.LEON.LEON GHC.Types.Bool
instance Std.Data.LEON.LEON GHC.Types.Ordering
instance Std.Data.LEON.LEON GHC.Word.Word16
instance Std.Data.LEON.LEON GHC.Word.Word32
instance Std.Data.LEON.LEON GHC.Word.Word64
instance Std.Data.LEON.LEON GHC.Int.Int16
instance Std.Data.LEON.LEON GHC.Int.Int32
instance Std.Data.LEON.LEON GHC.Int.Int64
instance Std.Data.LEON.LEON GHC.Types.Float
instance Std.Data.LEON.LEON GHC.Types.Double
instance Std.Data.LEON.LEON GHC.Types.Char
instance Std.Data.LEON.LEON (Std.Data.PrimArray.UnalignedAccess.BE GHC.Word.Word16)
instance Std.Data.LEON.LEON (Std.Data.PrimArray.UnalignedAccess.BE GHC.Word.Word32)
instance Std.Data.LEON.LEON (Std.Data.PrimArray.UnalignedAccess.BE GHC.Word.Word64)
instance Std.Data.LEON.LEON (Std.Data.PrimArray.UnalignedAccess.BE GHC.Int.Int16)
instance Std.Data.LEON.LEON (Std.Data.PrimArray.UnalignedAccess.BE GHC.Int.Int32)
instance Std.Data.LEON.LEON (Std.Data.PrimArray.UnalignedAccess.BE GHC.Int.Int64)
instance Std.Data.LEON.LEON (Std.Data.PrimArray.UnalignedAccess.BE GHC.Types.Float)
instance Std.Data.LEON.LEON (Std.Data.PrimArray.UnalignedAccess.BE GHC.Types.Double)
instance Std.Data.LEON.LEON (Std.Data.PrimArray.UnalignedAccess.BE GHC.Types.Char)
instance Std.Data.LEON.LEON a => Std.Data.LEON.LEON (Std.Data.Vector.Base.Vector a)
instance (Data.Primitive.Types.Prim a, Std.Data.LEON.LEON a) => Std.Data.LEON.LEON (Std.Data.Vector.Base.PrimVector a)
instance Std.Data.LEON.LEON Std.Data.Vector.Base.Bytes
instance Std.Data.LEON.LEON Std.Data.Text.Base.Text
instance Std.Data.LEON.LEON Std.Data.CBytes.CBytes
instance Std.Data.LEON.LEON a => Std.Data.LEON.LEON [a]
instance Std.Data.LEON.LEON ()
instance (Std.Data.LEON.LEON a, Std.Data.LEON.LEON b) => Std.Data.LEON.LEON (a, b)
instance (Std.Data.LEON.LEON a, Std.Data.LEON.LEON b, Std.Data.LEON.LEON c) => Std.Data.LEON.LEON (a, b, c)
instance (Std.Data.LEON.LEON a, Std.Data.LEON.LEON b, Std.Data.LEON.LEON c, Std.Data.LEON.LEON d) => Std.Data.LEON.LEON (a, b, c, d)
instance (Std.Data.LEON.LEON a, Std.Data.LEON.LEON b, Std.Data.LEON.LEON c, Std.Data.LEON.LEON d, Std.Data.LEON.LEON e) => Std.Data.LEON.LEON (a, b, c, d, e)
instance (Std.Data.LEON.LEON a, Std.Data.LEON.LEON b, Std.Data.LEON.LEON c, Std.Data.LEON.LEON d, Std.Data.LEON.LEON e, Std.Data.LEON.LEON f) => Std.Data.LEON.LEON (a, b, c, d, e, f)
instance (Std.Data.LEON.LEON a, Std.Data.LEON.LEON b, Std.Data.LEON.LEON c, Std.Data.LEON.LEON d, Std.Data.LEON.LEON e, Std.Data.LEON.LEON f, Std.Data.LEON.LEON g) => Std.Data.LEON.LEON (a, b, c, d, e, f, g)
instance (Std.Data.LEON.LEON a, Std.Data.LEON.LEON b, Std.Data.LEON.LEON c, Std.Data.LEON.LEON d, Std.Data.LEON.LEON e, Std.Data.LEON.LEON f, Std.Data.LEON.LEON g, Std.Data.LEON.LEON h) => Std.Data.LEON.LEON (a, b, c, d, e, f, g, h)
instance (Std.Data.LEON.LEON a, Std.Data.LEON.LEON b, Std.Data.LEON.LEON c, Std.Data.LEON.LEON d, Std.Data.LEON.LEON e, Std.Data.LEON.LEON f, Std.Data.LEON.LEON g, Std.Data.LEON.LEON h, Std.Data.LEON.LEON i) => Std.Data.LEON.LEON (a, b, c, d, e, f, g, h, i)
instance (Std.Data.LEON.LEON a, Std.Data.LEON.LEON b, Std.Data.LEON.LEON c, Std.Data.LEON.LEON d, Std.Data.LEON.LEON e, Std.Data.LEON.LEON f, Std.Data.LEON.LEON g, Std.Data.LEON.LEON h, Std.Data.LEON.LEON i, Std.Data.LEON.LEON j) => Std.Data.LEON.LEON (a, b, c, d, e, f, g, h, i, j)
instance Std.Data.LEON.LEON a => Std.Data.LEON.LEON (Data.Functor.Identity.Identity a)
instance Std.Data.LEON.LEON a => Std.Data.LEON.LEON (GHC.Maybe.Maybe a)
instance (Std.Data.LEON.LEON a, Std.Data.LEON.LEON b) => Std.Data.LEON.LEON (Data.Either.Either a b)
instance Std.Data.LEON.LEON GHC.Fingerprint.Type.Fingerprint
instance Std.Data.LEON.LEON Data.Version.Version
instance Std.Data.LEON.LEON a => Std.Data.LEON.LEON (Data.Semigroup.Internal.Dual a)
instance Std.Data.LEON.LEON a => Std.Data.LEON.LEON (Data.Semigroup.Internal.Sum a)
instance Std.Data.LEON.LEON a => Std.Data.LEON.LEON (Data.Semigroup.Internal.Product a)
instance Std.Data.LEON.LEON a => Std.Data.LEON.LEON (Data.Monoid.First a)
instance Std.Data.LEON.LEON a => Std.Data.LEON.LEON (Data.Monoid.Last a)
instance Std.Data.LEON.LEON Data.Semigroup.Internal.All
instance Std.Data.LEON.LEON Data.Semigroup.Internal.Any
instance Std.Data.LEON.LEON (f a) => Std.Data.LEON.LEON (Data.Semigroup.Internal.Alt f a)
instance Std.Data.LEON.LEON a => Std.Data.LEON.LEON (Data.Semigroup.Min a)
instance Std.Data.LEON.LEON a => Std.Data.LEON.LEON (Data.Semigroup.Max a)
instance Std.Data.LEON.LEON a => Std.Data.LEON.LEON (Data.Semigroup.First a)
instance Std.Data.LEON.LEON a => Std.Data.LEON.LEON (Data.Semigroup.Last a)
instance Std.Data.LEON.LEON a => Std.Data.LEON.LEON (Data.Semigroup.Option a)
instance Std.Data.LEON.LEON m => Std.Data.LEON.LEON (Data.Semigroup.WrappedMonoid m)
instance (Std.Data.LEON.LEON a, Std.Data.LEON.LEON b) => Std.Data.LEON.LEON (Data.Semigroup.Arg a b)
instance Std.Data.LEON.LEON a => Std.Data.LEON.LEON (GHC.Base.NonEmpty a)
instance Std.Data.LEON.LEON a => Std.Data.LEON.GLEONEncode (GHC.Generics.K1 i a)
instance Std.Data.LEON.LEON a => Std.Data.LEON.GLEONDecode (GHC.Generics.K1 i a)
instance Std.Data.LEON.GLEONDecode GHC.Generics.V1
instance Std.Data.LEON.GLEONDecode GHC.Generics.U1
instance (Std.Data.LEON.GLEONDecode a, Std.Data.LEON.GLEONDecode b) => Std.Data.LEON.GLEONDecode (a GHC.Generics.:*: b)
instance Std.Data.LEON.GLEONDecode a => Std.Data.LEON.GLEONDecode (GHC.Generics.M1 i c a)
instance Std.Data.LEON.GLEONEncode GHC.Generics.V1
instance Std.Data.LEON.GLEONEncode GHC.Generics.U1
instance (Std.Data.LEON.GLEONEncode a, Std.Data.LEON.GLEONEncode b) => Std.Data.LEON.GLEONEncode (a GHC.Generics.:*: b)
instance Std.Data.LEON.GLEONEncode a => Std.Data.LEON.GLEONEncode (GHC.Generics.M1 i c a)
-- | INTERNAL MODULE, provides all libuv side operations.
module Std.IO.UV.FFI
uv_version :: IO CUInt
uv_version_string :: IO CString
type UVSlot = Int
-- | UVSlotUnSafe wrap a slot which may not have a MVar in
-- blocking table, i.e. the blocking table need to be resized.
newtype UVSlotUnSafe
UVSlotUnSafe :: UVSlot -> UVSlotUnSafe
[unsafeGetSlot] :: UVSlotUnSafe -> UVSlot
type UVFD = Int32
data UVLoop
data UVLoopData
peekUVEventQueue :: Ptr UVLoopData -> IO (Int, Ptr Int)
clearUVEventCounter :: Ptr UVLoopData -> IO ()
peekUVBufferTable :: Ptr UVLoopData -> IO (Ptr (Ptr Word8), Ptr CSsize)
newtype UVRunMode
UVRunMode :: CInt -> UVRunMode
-- | Peek loop data pointer from uv loop pointer.
peekUVLoopData :: Ptr UVLoop -> IO (Ptr UVLoopData)
hs_uv_loop_init :: Int -> IO (Ptr UVLoop)
hs_uv_loop_close :: Ptr UVLoop -> IO ()
-- | uv_run with usafe FFI.
uv_run :: Ptr UVLoop -> UVRunMode -> IO CInt
-- | uv_run with safe FFI.
uv_run_safe :: Ptr UVLoop -> UVRunMode -> IO CInt
uv_loop_alive :: Ptr UVLoop -> IO CInt
hs_uv_wake_up_timer :: Ptr UVLoopData -> IO CInt
hs_uv_wake_up_async :: Ptr UVLoopData -> IO CInt
data UVHandle
peekUVHandleData :: Ptr UVHandle -> IO UVSlotUnSafe
hs_uv_fileno :: Ptr UVHandle -> IO UVFD
hs_uv_handle_alloc :: Ptr UVLoop -> IO (Ptr UVHandle)
hs_uv_handle_free :: Ptr UVHandle -> IO ()
hs_uv_handle_close :: Ptr UVHandle -> IO ()
hs_uv_cancel :: Ptr UVLoop -> UVSlot -> IO ()
hs_uv_listen :: Ptr UVHandle -> CInt -> IO CInt
hs_uv_listen_resume :: Ptr UVHandle -> IO ()
hs_uv_read_start :: Ptr UVHandle -> IO CInt
hs_uv_write :: Ptr UVHandle -> Ptr Word8 -> Int -> IO UVSlotUnSafe
hs_uv_accept_check_alloc :: Ptr UVHandle -> IO (Ptr UVHandle)
hs_uv_accept_check_init :: Ptr UVHandle -> IO CInt
hs_uv_accept_check_close :: Ptr UVHandle -> IO ()
hs_uv_tcp_open :: Ptr UVHandle -> UVFD -> IO CInt
uv_tcp_init :: Ptr UVLoop -> Ptr UVHandle -> IO CInt
uv_tcp_init_ex :: Ptr UVLoop -> Ptr UVHandle -> CUInt -> IO CInt
uv_tcp_nodelay :: Ptr UVHandle -> CInt -> IO CInt
uv_tcp_keepalive :: Ptr UVHandle -> CInt -> CUInt -> IO CInt
uV_TCP_IPV6ONLY :: CUInt
uv_tcp_bind :: Ptr UVHandle -> Ptr SockAddr -> CUInt -> IO CInt
hs_uv_tcp_connect :: Ptr UVHandle -> Ptr SockAddr -> IO UVSlotUnSafe
hs_set_socket_reuse :: Ptr UVHandle -> IO CInt
uv_pipe_init :: Ptr UVLoop -> Ptr UVHandle -> CInt -> IO CInt
newtype UVTTYMode
UVTTYMode :: CInt -> UVTTYMode
uv_tty_init :: Ptr UVLoop -> Ptr UVHandle -> CInt -> IO CInt
newtype UVFileMode
UVFileMode :: CInt -> UVFileMode
-- | 00700 user (file owner) has read, write and execute permission
-- | 00400 user has read permission
-- | 00200 user has write permission
-- | 00100 user has execute permission
-- | 00070 group has read, write and execute permission
-- | 00040 group has read permission
-- | 00020 group has write permission
-- | 00010 group has execute permission
-- | 00007 others have read, write and execute permission
-- | 00004 others have read permission
-- | 00002 others have write permission
-- | 00001 others have execute permission
-- | Default mode for open, 0o666(readable and writable).
hs_uv_fs_open :: CString -> UVFileFlag -> UVFileMode -> IO UVFD
hs_uv_fs_close :: UVFD -> IO Int
hs_uv_fs_read :: UVFD -> Ptr Word8 -> Int -> Int64 -> IO Int
hs_uv_fs_write :: UVFD -> Ptr Word8 -> Int -> Int64 -> IO Int
hs_uv_fs_unlink :: CString -> IO Int
hs_uv_fs_mkdir :: CString -> UVFileMode -> IO Int
hs_uv_fs_rmdir :: CString -> IO Int
hs_uv_fs_mkdtemp :: CString -> Int -> CString -> IO Int
hs_uv_fs_open_threaded :: CString -> UVFileFlag -> UVFileMode -> Ptr UVLoop -> IO UVSlotUnSafe
hs_uv_fs_close_threaded :: UVFD -> Ptr UVLoop -> IO UVSlotUnSafe
hs_uv_fs_read_threaded :: UVFD -> Ptr Word8 -> Int -> Int64 -> Ptr UVLoop -> IO UVSlotUnSafe
hs_uv_fs_write_threaded :: UVFD -> Ptr Word8 -> Int -> Int64 -> Ptr UVLoop -> IO UVSlotUnSafe
hs_uv_fs_unlink_threaded :: CString -> Ptr UVLoop -> IO UVSlotUnSafe
hs_uv_fs_mkdir_threaded :: CString -> UVFileMode -> Ptr UVLoop -> IO UVSlotUnSafe
hs_uv_fs_rmdir_threaded :: CString -> Ptr UVLoop -> IO UVSlotUnSafe
hs_uv_fs_mkdtemp_threaded :: CString -> Int -> CString -> Ptr UVLoop -> IO UVSlotUnSafe
newtype UVFileFlag
UVFileFlag :: CInt -> UVFileFlag
-- | The file is opened in append mode. Before each write, the file offset
-- is positioned at the end of the file.
-- | The file is created if it does not already exist.
-- | File IO is done directly to and from user-space buffers, which must be
-- aligned. Buffer size and address should be a multiple of the physical
-- sector size of the block device, (DO NOT USE WITH stdio's
-- BufferedIO)
-- | If the path is not a directory, fail the open. (Not useful on regular
-- file)
--
-- Note o_DIRECTORY is not supported on Windows.
-- | The file is opened for synchronous IO. Write operations will complete
-- once all data and a minimum of metadata are flushed to disk.
--
-- Note o_DSYNC is supported on Windows via
-- FILE_FLAG_WRITE_THROUGH.
-- | If the o_CREAT flag is set and the file already exists, fail
-- the open.
--
-- Note In general, the behavior of o_EXCL is undefined if it is
-- used without o_CREAT. There is one exception: on Linux 2.6
-- and later, o_EXCL can be used without o_CREAT if
-- pathname refers to a block device. If the block device is in use by
-- the system (e.g., mounted), the open will fail with the error
-- EBUSY.
-- | Atomically obtain an exclusive lock.
--
-- Note UV_FS_O_EXLOCK is only supported on macOS and Windows. (libuv:
-- Changed in version 1.17.0: support is added for Windows.)
-- | Do not update the file access time when the file is read.
--
-- Note o_NOATIME is not supported on Windows.
-- | If the path identifies a terminal device, opening the path will not
-- cause that terminal to become the controlling terminal for the process
-- (if the process does not already have one). (Not sure if this flag is
-- useful)
--
-- Note o_NOCTTY is not supported on Windows.
-- | If the path is a symbolic link, fail the open.
--
-- Note o_NOFOLLOW is not supported on Windows.
-- | Open the file in nonblocking mode if possible. (Definitely not useful
-- with stdio)
--
-- Note o_NONBLOCK is not supported on Windows. (Not useful on
-- regular file anyway)
-- | Access is intended to be random. The system can use this as a hint to
-- optimize file caching.
--
-- Note o_RANDOM is only supported on Windows via
-- FILE_FLAG_RANDOM_ACCESS.
-- | Open the file for read-only access.
-- | Open the file for read-write access.
-- | Access is intended to be sequential from beginning to end. The system
-- can use this as a hint to optimize file caching.
--
-- Note o_SEQUENTIAL is only supported on Windows via
-- FILE_FLAG_SEQUENTIAL_SCAN.
-- | The file is temporary and should not be flushed to disk if possible.
--
-- Note o_SHORT_LIVED is only supported on Windows via
-- FILE_ATTRIBUTE_TEMPORARY.
-- | Open the symbolic link itself rather than the resource it points to.
-- | The file is opened for synchronous IO. Write operations will complete
-- once all data and all metadata are flushed to disk.
--
-- Note o_SYNC is supported on Windows via
-- FILE_FLAG_WRITE_THROUGH.
-- | The file is temporary and should not be flushed to disk if possible.
--
-- Note o_TEMPORARY is only supported on Windows via
-- FILE_ATTRIBUTE_TEMPORARY.
-- | If the file exists and is a regular file, and the file is opened
-- successfully for write access, its length shall be truncated to zero.
-- | Open the file for write-only access.
newtype UVDirEntType
UVDirEntType :: CChar -> UVDirEntType
data DirEntType
DirEntUnknown :: DirEntType
DirEntFile :: DirEntType
DirEntDir :: DirEntType
DirEntLink :: DirEntType
DirEntFIFO :: DirEntType
DirEntSocket :: DirEntType
DirEntChar :: DirEntType
DirEntBlock :: DirEntType
fromUVDirEntType :: UVDirEntType -> DirEntType
uV__DT_FILE :: UVDirEntType
uV__DT_DIR :: UVDirEntType
uV__DT_LINK :: UVDirEntType
uV__DT_FIFO :: UVDirEntType
uV__DT_SOCKET :: UVDirEntType
data UVDirEnt
uV__DT_CHAR :: UVDirEntType
peekUVDirEnt :: Ptr UVDirEnt -> IO (CString, UVDirEntType)
uV__DT_BLOCK :: UVDirEntType
hs_uv_fs_scandir_cleanup :: Ptr (Ptr UVDirEnt) -> Int -> IO ()
hs_uv_fs_scandir :: CString -> MBA# (Ptr UVDirEnt) -> IO Int
hs_uv_fs_scandir_extra_cleanup :: Ptr (Ptr (Ptr UVDirEnt)) -> Int -> IO ()
hs_uv_fs_scandir_threaded :: CString -> Ptr (Ptr (Ptr UVDirEnt)) -> Ptr UVLoop -> IO UVSlotUnSafe
data UVTimeSpec
UVTimeSpec :: {-# UNPACK #-} !CLong -> {-# UNPACK #-} !CLong -> UVTimeSpec
[uvtSecond] :: UVTimeSpec -> {-# UNPACK #-} !CLong
[uvtNanoSecond] :: UVTimeSpec -> {-# UNPACK #-} !CLong
data UVStat
UVStat :: {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !UVTimeSpec -> {-# UNPACK #-} !UVTimeSpec -> {-# UNPACK #-} !UVTimeSpec -> {-# UNPACK #-} !UVTimeSpec -> UVStat
[stDev] :: UVStat -> {-# UNPACK #-} !Word64
[stMode] :: UVStat -> {-# UNPACK #-} !Word64
[stNlink] :: UVStat -> {-# UNPACK #-} !Word64
[stUid] :: UVStat -> {-# UNPACK #-} !Word64
[stGid] :: UVStat -> {-# UNPACK #-} !Word64
[stRdev] :: UVStat -> {-# UNPACK #-} !Word64
[stIno] :: UVStat -> {-# UNPACK #-} !Word64
[stSize] :: UVStat -> {-# UNPACK #-} !Word64
[stBlksize] :: UVStat -> {-# UNPACK #-} !Word64
[stBlocks] :: UVStat -> {-# UNPACK #-} !Word64
[stFlags] :: UVStat -> {-# UNPACK #-} !Word64
[stGen] :: UVStat -> {-# UNPACK #-} !Word64
[stAtim] :: UVStat -> {-# UNPACK #-} !UVTimeSpec
[stMtim] :: UVStat -> {-# UNPACK #-} !UVTimeSpec
[stCtim] :: UVStat -> {-# UNPACK #-} !UVTimeSpec
[stBirthtim] :: UVStat -> {-# UNPACK #-} !UVTimeSpec
uvStatSize :: Int
peekUVStat :: Ptr UVStat -> IO UVStat
hs_uv_fs_stat :: CString -> Ptr UVStat -> IO Int
hs_uv_fs_fstat :: UVFD -> Ptr UVStat -> IO Int
hs_uv_fs_lstat :: CString -> Ptr UVStat -> IO Int
hs_uv_fs_rename :: CString -> CString -> IO Int
hs_uv_fs_fsync :: UVFD -> IO Int
hs_uv_fs_fdatasync :: UVFD -> IO Int
hs_uv_fs_ftruncate :: UVFD -> Int64 -> IO Int
hs_uv_fs_stat_threaded :: CString -> Ptr UVStat -> Ptr UVLoop -> IO UVSlotUnSafe
hs_uv_fs_fstat_threaded :: UVFD -> Ptr UVStat -> Ptr UVLoop -> IO UVSlotUnSafe
hs_uv_fs_lstat_threaded :: CString -> Ptr UVStat -> Ptr UVLoop -> IO UVSlotUnSafe
hs_uv_fs_rename_threaded :: CString -> CString -> Ptr UVLoop -> IO UVSlotUnSafe
hs_uv_fs_fsync_threaded :: UVFD -> Ptr UVLoop -> IO UVSlotUnSafe
hs_uv_fs_fdatasync_threaded :: UVFD -> Ptr UVLoop -> IO UVSlotUnSafe
hs_uv_fs_ftruncate_threaded :: UVFD -> Int64 -> Ptr UVLoop -> IO UVSlotUnSafe
-- | Flags control copying.
--
--
-- - COPYFILE_EXCL: If present, uv_fs_copyfile() will fail with
-- UV_EEXIST if the destination path already exists. The default behavior
-- is to overwrite the destination if it exists.
-- - COPYFILE_FICLONE: If present, uv_fs_copyfile() will attempt
-- to create a copy-on-write reflink. If the underlying platform does not
-- support copy-on-write, then a fallback copy mechanism is used.
--
newtype UVCopyFileFlag
UVCopyFileFlag :: CInt -> UVCopyFileFlag
hs_uv_fs_copyfile :: CString -> CString -> UVCopyFileFlag -> IO Int
hs_uv_fs_copyfile_threaded :: CString -> CString -> UVCopyFileFlag -> Ptr UVLoop -> IO UVSlotUnSafe
newtype UVAccessMode
UVAccessMode :: CInt -> UVAccessMode
data AccessResult
NoExistence :: AccessResult
NoPermission :: AccessResult
AccessOK :: AccessResult
hs_uv_fs_access :: CString -> UVAccessMode -> IO Int
hs_uv_fs_access_threaded :: CString -> UVAccessMode -> Ptr UVLoop -> IO UVSlotUnSafe
hs_uv_fs_chmod :: CString -> UVFileMode -> IO Int
hs_uv_fs_chmod_threaded :: CString -> UVFileMode -> Ptr UVLoop -> IO UVSlotUnSafe
hs_uv_fs_fchmod :: UVFD -> UVFileMode -> IO Int
hs_uv_fs_fchmod_threaded :: UVFD -> UVFileMode -> Ptr UVLoop -> IO UVSlotUnSafe
hs_uv_fs_utime :: CString -> Double -> Double -> IO Int
hs_uv_fs_utime_threaded :: CString -> Double -> Double -> Ptr UVLoop -> IO UVSlotUnSafe
hs_uv_fs_futime :: UVFD -> Double -> Double -> IO Int
hs_uv_fs_futime_threaded :: UVFD -> Double -> Double -> Ptr UVLoop -> IO UVSlotUnSafe
newtype UVSymlinkFlag
UVSymlinkFlag :: CInt -> UVSymlinkFlag
hs_uv_fs_link :: CString -> CString -> IO Int
hs_uv_fs_link_threaded :: CString -> CString -> Ptr UVLoop -> IO UVSlotUnSafe
hs_uv_fs_symlink :: CString -> CString -> UVSymlinkFlag -> IO Int
hs_uv_fs_symlink_threaded :: CString -> CString -> UVSymlinkFlag -> Ptr UVLoop -> IO UVSlotUnSafe
hs_uv_fs_readlink_cleanup :: CString -> IO ()
hs_uv_fs_readlink :: CString -> MBA# CString -> IO Int
hs_uv_fs_realpath :: CString -> MBA# CString -> IO Int
hs_uv_fs_readlink_extra_cleanup :: Ptr CString -> IO ()
hs_uv_fs_readlink_threaded :: CString -> Ptr CString -> Ptr UVLoop -> IO UVSlotUnSafe
hs_uv_fs_realpath_threaded :: CString -> Ptr CString -> Ptr UVLoop -> IO UVSlotUnSafe
newtype UVHandleType
UVHandleType :: CInt -> UVHandleType
uv_guess_handle :: UVFD -> IO UVHandleType
instance Foreign.Storable.Storable Std.IO.UV.FFI.UVHandleType
instance GHC.Show.Show Std.IO.UV.FFI.UVHandleType
instance GHC.Read.Read Std.IO.UV.FFI.UVHandleType
instance GHC.Classes.Ord Std.IO.UV.FFI.UVHandleType
instance GHC.Classes.Eq Std.IO.UV.FFI.UVHandleType
instance Foreign.Storable.Storable Std.IO.UV.FFI.UVSymlinkFlag
instance Data.Bits.Bits Std.IO.UV.FFI.UVSymlinkFlag
instance Data.Bits.FiniteBits Std.IO.UV.FFI.UVSymlinkFlag
instance GHC.Show.Show Std.IO.UV.FFI.UVSymlinkFlag
instance GHC.Read.Read Std.IO.UV.FFI.UVSymlinkFlag
instance GHC.Classes.Ord Std.IO.UV.FFI.UVSymlinkFlag
instance GHC.Classes.Eq Std.IO.UV.FFI.UVSymlinkFlag
instance GHC.Classes.Ord Std.IO.UV.FFI.AccessResult
instance GHC.Classes.Eq Std.IO.UV.FFI.AccessResult
instance GHC.Show.Show Std.IO.UV.FFI.AccessResult
instance Foreign.Storable.Storable Std.IO.UV.FFI.UVAccessMode
instance Data.Bits.Bits Std.IO.UV.FFI.UVAccessMode
instance Data.Bits.FiniteBits Std.IO.UV.FFI.UVAccessMode
instance GHC.Show.Show Std.IO.UV.FFI.UVAccessMode
instance GHC.Read.Read Std.IO.UV.FFI.UVAccessMode
instance GHC.Classes.Ord Std.IO.UV.FFI.UVAccessMode
instance GHC.Classes.Eq Std.IO.UV.FFI.UVAccessMode
instance Foreign.Storable.Storable Std.IO.UV.FFI.UVCopyFileFlag
instance Data.Bits.Bits Std.IO.UV.FFI.UVCopyFileFlag
instance Data.Bits.FiniteBits Std.IO.UV.FFI.UVCopyFileFlag
instance GHC.Show.Show Std.IO.UV.FFI.UVCopyFileFlag
instance GHC.Read.Read Std.IO.UV.FFI.UVCopyFileFlag
instance GHC.Classes.Ord Std.IO.UV.FFI.UVCopyFileFlag
instance GHC.Classes.Eq Std.IO.UV.FFI.UVCopyFileFlag
instance GHC.Generics.Generic Std.IO.UV.FFI.UVStat
instance GHC.Classes.Ord Std.IO.UV.FFI.UVStat
instance GHC.Classes.Eq Std.IO.UV.FFI.UVStat
instance GHC.Read.Read Std.IO.UV.FFI.UVStat
instance GHC.Show.Show Std.IO.UV.FFI.UVStat
instance GHC.Generics.Generic Std.IO.UV.FFI.UVTimeSpec
instance GHC.Classes.Ord Std.IO.UV.FFI.UVTimeSpec
instance GHC.Classes.Eq Std.IO.UV.FFI.UVTimeSpec
instance GHC.Read.Read Std.IO.UV.FFI.UVTimeSpec
instance GHC.Show.Show Std.IO.UV.FFI.UVTimeSpec
instance GHC.Generics.Generic Std.IO.UV.FFI.DirEntType
instance GHC.Classes.Ord Std.IO.UV.FFI.DirEntType
instance GHC.Classes.Eq Std.IO.UV.FFI.DirEntType
instance GHC.Show.Show Std.IO.UV.FFI.DirEntType
instance GHC.Read.Read Std.IO.UV.FFI.DirEntType
instance Foreign.Storable.Storable Std.IO.UV.FFI.UVDirEntType
instance Data.Bits.Bits Std.IO.UV.FFI.UVDirEntType
instance Data.Bits.FiniteBits Std.IO.UV.FFI.UVDirEntType
instance GHC.Show.Show Std.IO.UV.FFI.UVDirEntType
instance GHC.Read.Read Std.IO.UV.FFI.UVDirEntType
instance GHC.Classes.Ord Std.IO.UV.FFI.UVDirEntType
instance GHC.Classes.Eq Std.IO.UV.FFI.UVDirEntType
instance Foreign.Storable.Storable Std.IO.UV.FFI.UVFileFlag
instance Data.Bits.Bits Std.IO.UV.FFI.UVFileFlag
instance Data.Bits.FiniteBits Std.IO.UV.FFI.UVFileFlag
instance GHC.Show.Show Std.IO.UV.FFI.UVFileFlag
instance GHC.Read.Read Std.IO.UV.FFI.UVFileFlag
instance GHC.Classes.Ord Std.IO.UV.FFI.UVFileFlag
instance GHC.Classes.Eq Std.IO.UV.FFI.UVFileFlag
instance Foreign.Storable.Storable Std.IO.UV.FFI.UVFileMode
instance Data.Bits.Bits Std.IO.UV.FFI.UVFileMode
instance Data.Bits.FiniteBits Std.IO.UV.FFI.UVFileMode
instance GHC.Show.Show Std.IO.UV.FFI.UVFileMode
instance GHC.Read.Read Std.IO.UV.FFI.UVFileMode
instance GHC.Classes.Ord Std.IO.UV.FFI.UVFileMode
instance GHC.Classes.Eq Std.IO.UV.FFI.UVFileMode
instance Foreign.Storable.Storable Std.IO.UV.FFI.UVTTYMode
instance Data.Bits.Bits Std.IO.UV.FFI.UVTTYMode
instance Data.Bits.FiniteBits Std.IO.UV.FFI.UVTTYMode
instance GHC.Show.Show Std.IO.UV.FFI.UVTTYMode
instance GHC.Read.Read Std.IO.UV.FFI.UVTTYMode
instance GHC.Classes.Ord Std.IO.UV.FFI.UVTTYMode
instance GHC.Classes.Eq Std.IO.UV.FFI.UVTTYMode
instance Foreign.Storable.Storable Std.IO.UV.FFI.UVRunMode
instance Data.Bits.Bits Std.IO.UV.FFI.UVRunMode
instance Data.Bits.FiniteBits Std.IO.UV.FFI.UVRunMode
instance GHC.Show.Show Std.IO.UV.FFI.UVRunMode
instance GHC.Read.Read Std.IO.UV.FFI.UVRunMode
instance GHC.Classes.Ord Std.IO.UV.FFI.UVRunMode
instance GHC.Classes.Eq Std.IO.UV.FFI.UVRunMode
instance Foreign.Storable.Storable Std.IO.UV.FFI.UVTimeSpec
-- | This module provide IO manager which bridge libuv's async interface
-- with ghc's light weight thread.
--
-- The main procedures for doing event IO is:
--
--
-- - Allocate a slot number using allocSlot.
-- - Prepare you IO buffer and write them to uv loop with
-- pokeBufferTable(both read and write).
-- - Block your thread with a MVar, using getBlockMVar to
-- get it.
-- - Read the result with getResult, for read it's the read
-- bytes number, for write it will be zero. Use throwIfError to
-- guard error situations.
-- - Return the slot back uv manager with freeSlot.
--
--
-- Usually slots are cache in the IO device so that you don't have to
-- allocate new one before each IO operation. Check
-- System.IO.Socket.TCP as an example.
module Std.IO.UV.Manager
data UVManager
-- | Get UVManager runing on the same capability.
getUVManager :: IO UVManager
-- | Get MVar from blocking table with given slot.
getBlockMVar :: UVManager -> UVSlot -> IO (MVar Int)
peekBufferTable :: UVManager -> UVSlot -> IO Int
-- | Poke a prepared buffer and size into loop data under given slot.
--
-- NOTE, this action is not protected with 'withUVManager_ for effcient
-- reason, you should merge this action with other uv action and put them
-- together inside a 'withUVManager_ or 'withUVManager\''. for example:
--
--
-- ...
-- withUVManager_ uvm $ do
-- pokeBufferTable uvm slot buf len
-- uvReadStart handle
-- ...
--
pokeBufferTable :: UVManager -> UVSlot -> Ptr Word8 -> Int -> IO ()
-- | Lock an uv mananger, so that we can safely mutate its uv_loop's state.
--
-- libuv is not thread safe, use this function to perform any action
-- which will mutate uv_loop's state.
withUVManager :: HasCallStack => UVManager -> (Ptr UVLoop -> IO a) -> IO a
-- | Lock an uv mananger, so that we can safely mutate its uv_loop's state.
--
-- Some action did not request uv_loop pointer explicitly, but will
-- mutate uv_loop underhood, for example: uv_read_start. These
-- actions have to be protected by locking the uv_loop.
--
-- In fact most of the libuv's functions are not thread safe, so watch
-- out!
withUVManager_ :: HasCallStack => UVManager -> IO a -> IO a
-- | Run a libuv FFI to get a UVSlotUnSafe (which may exceed block
-- table size), resize the block table in that case, so that the returned
-- slot always has an accompanying MVar in block table.
--
-- Always use this function to turn an UVSlotUnsafe into
-- UVSlot, so that the block table size synchronize with libuv
-- side's slot table.
getUVSlot :: HasCallStack => UVManager -> IO UVSlotUnSafe -> IO UVSlot
-- | Exception safe uv request helper
--
-- This helper will run a libuv's async function, which will return a
-- libuv side's slot, then we will accommodate a MVar in block
-- table and wait on that MVar, until the async function finished
-- or an exception is received, in later case we will call
-- cancelUVReq to cancel the on-going async function with best
-- efforts,
withUVRequest :: HasCallStack => UVManager -> (Ptr UVLoop -> IO UVSlotUnSafe) -> IO Int
-- | Same with withUVRequest but disgard the result.
withUVRequest_ :: HasCallStack => UVManager -> (Ptr UVLoop -> IO UVSlotUnSafe) -> IO ()
-- | Same with withUVRequest but apply an convert function to
-- result.
--
-- The convert function have all access to the returned value including
-- negative ones, it's convert funtions's responsiblity to throw an
-- exception if appropriate.
withUVRequest' :: HasCallStack => UVManager -> (Ptr UVLoop -> IO UVSlotUnSafe) -> (Int -> IO b) -> IO b
-- | Same with withUVRequest, but will also run an extra cleanup
-- function if async exception hit this thread but the async action is
-- already successfully performed, e.g. release result memory.
withUVRequestEx :: HasCallStack => UVManager -> (Ptr UVLoop -> IO UVSlotUnSafe) -> (Int -> IO ()) -> IO Int
-- | Safely lock an uv manager and perform uv_handle initialization.
--
-- Initialization an UV stream usually take two step:
--
--
-- - allocate an uv_stream struct with proper size
-- - lock a particular uv_loop from a uv manager, and perform custom
-- initialization, such as uv_tcp_init.
--
--
-- And this is what initUVStream do, all you need to do is to
-- provide the manager you want to hook the handle onto(usually the one
-- on the same capability, i.e. the one obtained by getUVManager),
-- and provide a custom initialization function.
initUVStream :: HasCallStack => (Ptr UVLoop -> Ptr UVHandle -> IO ()) -> UVManager -> Resource UVStream
-- | A haskell data type wrap an uv_stream_t inside
--
-- UVStream DO NOT provide thread safety! Use UVStream
-- concurrently in multiple threads will lead to undefined behavior.
data UVStream
UVStream :: {-# UNPACK #-} !Ptr UVHandle -> {-# UNPACK #-} !UVSlot -> UVManager -> {-# UNPACK #-} !IORef Bool -> UVStream
[uvsHandle] :: UVStream -> {-# UNPACK #-} !Ptr UVHandle
[uvsSlot] :: UVStream -> {-# UNPACK #-} !UVSlot
[uvsManager] :: UVStream -> UVManager
[uvsClosed] :: UVStream -> {-# UNPACK #-} !IORef Bool
-- | Fork a new GHC thread with active load-balancing.
--
-- Using libuv based IO solution has a disadvantage that file handlers
-- are bound to certain uv_loop, thus certain uv mananger/capability.
-- Worker threads that migrate to other capability will lead contention
-- since various APIs here is protected by manager's lock, this makes
-- GHC's work-stealing strategy unsuitable for certain workload, such as
-- a webserver. we solve this problem with simple round-robin
-- load-balancing: forkBa will automatically distribute new threads to
-- all capabilities in round-robin manner. Thus its name forkBa(lance).
forkBa :: IO () -> IO ThreadId
instance GHC.Show.Show Std.IO.UV.Manager.UVStream
instance Std.IO.Buffered.Input Std.IO.UV.Manager.UVStream
instance Std.IO.Buffered.Output Std.IO.UV.Manager.UVStream
instance GHC.Show.Show Std.IO.UV.Manager.UVManager
instance GHC.Classes.Eq Std.IO.UV.Manager.UVManager
-- | This module provides an API for creating TCP servers and clients.
module Std.IO.TCP
-- | A TCP client configuration
data ClientConfig
ClientConfig :: Maybe SockAddr -> SockAddr -> Bool -> ClientConfig
[clientLocalAddr] :: ClientConfig -> Maybe SockAddr
[clientTargetAddr] :: ClientConfig -> SockAddr
[clientNoDelay] :: ClientConfig -> Bool
defaultClientConfig :: ClientConfig
initClient :: HasCallStack => ClientConfig -> Resource UVStream
-- | A TCP server configuration
data ServerConfig
ServerConfig :: SockAddr -> Int -> (UVStream -> IO ()) -> Bool -> ServerConfig
[serverAddr] :: ServerConfig -> SockAddr
[serverBackLog] :: ServerConfig -> Int
[serverWorker] :: ServerConfig -> UVStream -> IO ()
[serverWorkerNoDelay] :: ServerConfig -> Bool
-- | A default hello world server on localhost:8888
--
-- Test it with main = startServer defaultServerConfig, now try
-- nc -v 127.0.0.1 8888
defaultServerConfig :: ServerConfig
-- | Start a server
--
-- Fork new worker thread upon a new connection.
startServer :: ServerConfig -> IO ()
-- | This module provides stdin/stderr/stdout reading and writings. Usually
-- you don't have to use stderr or stderrBuf directly,
-- Logger provides more logging utilities through stderr.
-- While stdinBuf and stdoutBuf is useful when you write
-- interactive programs, Buffered module provide many reading and
-- writing operations. Example:
--
--
-- import Std.IO.LowResTimer
-- import Std.IO.Buffered
-- import Std.IO.StdStream
--
-- main = do
-- -- read by '\n'
-- b1 <- readLineStd
-- -- read whatever user input in 3s, otherwise get Nothing
-- b2 <- timeoutLowRes 30 $ readBuffered stdinBuf
-- ...
-- putStd "hello world!"
--
module Std.IO.StdStream
-- | Standard input and output streams
--
-- We support both regular file and TTY based streams, when initialized
-- uv_guess_handle is called to decide which type of devices are
-- connected to standard streams.
--
-- StdStream is different from other UVStream in that
-- exception during reading & writing won't close StdStream.
data StdStream
isStdStreamTTY :: StdStream -> Bool
stdin :: StdStream
stdout :: StdStream
stderr :: StdStream
stdinBuf :: BufferedInput StdStream
stdoutBuf :: BufferedOutput StdStream
-- | print a Show to stdout
printStd :: Show a => a -> IO ()
-- | read a line from stdin
readLineStd :: IO Bytes
-- | print a Builder and flush to stdout.
putStd :: Builder a -> IO ()
-- | print a Builder and flush to stdout stdout, with a linefeed.
putLineStd :: Builder a -> IO ()
instance Std.IO.Buffered.Input Std.IO.StdStream.StdStream
instance Std.IO.Buffered.Output Std.IO.StdStream.StdStream
-- | Simple, high performance logger. The design choice of this logger is
-- biased towards simplicity instead of generlization:
--
--
-- - All log functions lives in IO.
-- - A logger connected to stderr, setStdLogger are always
-- available.
-- - Each logging thread are responsible for building log
-- Builders into a small Bytes with line buffer instead
-- of leaving all Builders to the flushing thread so that:
-- - We won't keep garbage for too long simply because they're
-- referenced by log's Builder.
-- - Each logging thread only need perform a CAS to prepend log
-- Bytes into a list, which reduces contention.
-- - Each log is atomic, Logging order is preserved under concurrent
-- settings.
--
--
-- Flushing is automatic and throttled for debug, info,
-- warn to boost performance, while a fatal log always
-- flush logger's buffer, This also lead to a problem that if main thread
-- exits too early logs may missed, to add a flushing when program exits,
-- use withLogger like:
--
--
-- import Std.IO.Logger
--
-- main :: IO ()
-- main = withStdLogger $ do
-- ....
--
module Std.IO.Logger
data Logger
-- | Logger configuration.
data LoggerConfig
LoggerConfig :: {-# UNPACK #-} !Int -> {-# UNPACK #-} !Int -> IO (Builder ()) -> {-# UNPACK #-} !Int -> Bool -> Bool -> LoggerConfig
-- | Buffer size used when creating logger's BufferedOutput
[loggerBufferSize] :: LoggerConfig -> {-# UNPACK #-} !Int
-- | Minimal flush interval, see Notes on debug
[loggerMinFlushInterval] :: LoggerConfig -> {-# UNPACK #-} !Int
-- | A IO action return a formatted date/time string
[loggerTsCache] :: LoggerConfig -> IO (Builder ())
-- | Buffer size to build each log/line
[loggerLineBufSize] :: LoggerConfig -> {-# UNPACK #-} !Int
-- | Set to False to filter debug logs
[loggerShowDebug] :: LoggerConfig -> Bool
-- | Set to False to disable auto data/time string prepending
[loggerShowTS] :: LoggerConfig -> Bool
-- | Make a new logger
newLogger :: Output o => LoggerConfig -> o -> IO Logger
-- | flush logger's buffer to output device
loggerFlush :: Logger -> IO ()
-- | Change stderr logger.
setStdLogger :: Logger -> IO ()
getStdLogger :: IO Logger
-- | Flush stderr logger when program exits.
withStdLogger :: IO () -> IO ()
debug :: Builder () -> IO ()
info :: Builder () -> IO ()
warn :: Builder () -> IO ()
fatal :: Builder () -> IO ()
otherLevel :: Builder () -> Bool -> Builder () -> IO ()
debugWith :: Logger -> Builder () -> IO ()
infoWith :: Logger -> Builder () -> IO ()
warnWith :: Logger -> Builder () -> IO ()
fatalWith :: Logger -> Builder () -> IO ()
otherLevelWith :: Logger -> Builder () -> Bool -> Builder () -> IO ()
-- | This module provide IO operations related to filesystem, operations
-- are implemented using libuv's threadpool to achieve non-block behavior
-- (non-block here meaning won't block other haskell threads), which
-- should be prefered when the operations' estimated time is long
-- enough(>1ms) or running with a non-threaded haskell runtime, such
-- as accessing network filesystem or scan a very large directory.
-- Otherwise you may block RTS's capability thus all the other haskell
-- threads live on it.
--
-- The threadpool version operations have overheads similar to safe FFI,
-- but provide same adventages:
--
--
-- - The libuv's threadpool have a limit on concurrent threads number
-- (4 by default), which can reduce disk contention.
-- - The threadpool version works with non-threaded runtime, which
-- doesn't have safe FFI available.
-- - The threadpool version won't relinquish current HEC (Haskell
-- Execution Context) a.k.a. capability.
--
module Std.IO.FileSystemT
-- | UVFile wrap a uv_file_t and a referencing counter
--
-- Note this is a differet data type from Std.IO.FileSystem 's
-- one, the Input and Output instance use thread pool
-- version functions.
--
-- libuv implements read and write method with both implict and explict
-- offset capability. (negative offset result in read/write
-- system call otherwise pread/pwrite), we provide implict
-- offset interface with UVFile, which is NOT thread safe.
--
-- An offset bundled UVFileReader, UVFileWriter is also
-- provided, which can be used concurrently. The offset is protected with
-- MVar and increasing automatically.
data UVFile
data UVFileReader
-- | Create a reader from an UVFile.
--
-- Note this will not increase UVFile's referencing counter.
newUVFileReader :: UVFile -> Int64 -> IO UVFileReader
-- | Change reader's offset.
peekUVFileReader :: UVFileReader -> Int64 -> IO Int64
data UVFileWriter
-- | Create a writer from an UVFile.
--
-- Note this will not increase UVFile's referencing counter.
newUVFileWriter :: UVFile -> Int64 -> IO UVFileWriter
-- | Change writer's offset.
peekUVFileWriter :: UVFileWriter -> Int64 -> IO Int64
-- | init a file Resource, which open a file when used.
--
-- Resource closing will wait for the referencing counter goes down to
-- zero (no reading or writing is in process), which can be a problem if
-- you are using multiple readers or writers in multiple threads. In that
-- case you have to stop all reading or writing thread if you don't want
-- to block the resource thread.
initUVFile :: HasCallStack => CBytes -> UVFileFlag -> UVFileMode -> Resource UVFile
data UVFileMode
data UVFileFlag
-- | Equivalent to mkdir(2).
--
-- Note mode is currently not implemented on Windows.
mkdir :: HasCallStack => CBytes -> UVFileMode -> IO ()
-- | Equivalent to unlink(2).
unlink :: HasCallStack => CBytes -> IO ()
-- | Equivalent to http://linux.die.net/man/3/mkdtemp
--
-- Creates a temporary directory in the most secure manner possible.
-- There are no race conditions in the directory’s creation. The
-- directory is readable, writable, and searchable only by the creating
-- user ID. The user of mkdtemp() is responsible for deleting the
-- temporary directory and its contents when done with it.
--
-- Note: the argument is the prefix of the temporary directory, so no
-- need to add XXXXXX ending.
mkdtemp :: HasCallStack => CBytes -> IO CBytes
-- | Equivalent to rmdir(2).
rmdir :: HasCallStack => CBytes -> IO ()
data DirEntType
DirEntUnknown :: DirEntType
DirEntFile :: DirEntType
DirEntDir :: DirEntType
DirEntLink :: DirEntType
DirEntFIFO :: DirEntType
DirEntSocket :: DirEntType
DirEntChar :: DirEntType
DirEntBlock :: DirEntType
-- | Equivalent to scandir(3).
--
-- Note Unlike scandir(3), this function does not return the “.” and “..”
-- entries.
--
-- Note On Linux, getting the type of an entry is only supported by some
-- file systems (btrfs, ext2, ext3 and ext4 at the time of this writing),
-- check the getdents(2) man page.
scandir :: HasCallStack => CBytes -> IO [(CBytes, DirEntType)]
data UVStat
UVStat :: {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !UVTimeSpec -> {-# UNPACK #-} !UVTimeSpec -> {-# UNPACK #-} !UVTimeSpec -> {-# UNPACK #-} !UVTimeSpec -> UVStat
[stDev] :: UVStat -> {-# UNPACK #-} !Word64
[stMode] :: UVStat -> {-# UNPACK #-} !Word64
[stNlink] :: UVStat -> {-# UNPACK #-} !Word64
[stUid] :: UVStat -> {-# UNPACK #-} !Word64
[stGid] :: UVStat -> {-# UNPACK #-} !Word64
[stRdev] :: UVStat -> {-# UNPACK #-} !Word64
[stIno] :: UVStat -> {-# UNPACK #-} !Word64
[stSize] :: UVStat -> {-# UNPACK #-} !Word64
[stBlksize] :: UVStat -> {-# UNPACK #-} !Word64
[stBlocks] :: UVStat -> {-# UNPACK #-} !Word64
[stFlags] :: UVStat -> {-# UNPACK #-} !Word64
[stGen] :: UVStat -> {-# UNPACK #-} !Word64
[stAtim] :: UVStat -> {-# UNPACK #-} !UVTimeSpec
[stMtim] :: UVStat -> {-# UNPACK #-} !UVTimeSpec
[stCtim] :: UVStat -> {-# UNPACK #-} !UVTimeSpec
[stBirthtim] :: UVStat -> {-# UNPACK #-} !UVTimeSpec
data UVTimeSpec
UVTimeSpec :: {-# UNPACK #-} !CLong -> {-# UNPACK #-} !CLong -> UVTimeSpec
[uvtSecond] :: UVTimeSpec -> {-# UNPACK #-} !CLong
[uvtNanoSecond] :: UVTimeSpec -> {-# UNPACK #-} !CLong
-- | Equivalent to stat(2)
stat :: HasCallStack => CBytes -> IO UVStat
-- | Equivalent to lstat(2)
lstat :: HasCallStack => CBytes -> IO UVStat
-- | Equivalent to fstat(2)
fstat :: HasCallStack => UVFile -> IO UVStat
-- | Equivalent to rename(2).
--
-- Note On Windows if this function fails with UV_EBUSY, UV_EPERM or
-- UV_EACCES, it will retry to rename the file up to four times with
-- 250ms wait between attempts before giving up. If both path and
-- new_path are existing directories this function will work only if
-- target directory is empty.
rename :: HasCallStack => CBytes -> CBytes -> IO ()
-- | Equivalent to fsync(2).
fsync :: HasCallStack => UVFile -> IO ()
-- | Equivalent to fdatasync(2).
fdatasync :: HasCallStack => UVFile -> IO ()
-- | Equivalent to ftruncate(2).
ftruncate :: HasCallStack => UVFile -> Int64 -> IO ()
-- | Flags control copying.
--
--
-- - COPYFILE_EXCL: If present, uv_fs_copyfile() will fail with
-- UV_EEXIST if the destination path already exists. The default behavior
-- is to overwrite the destination if it exists.
-- - COPYFILE_FICLONE: If present, uv_fs_copyfile() will attempt
-- to create a copy-on-write reflink. If the underlying platform does not
-- support copy-on-write, then a fallback copy mechanism is used.
--
data UVCopyFileFlag
-- | Copies a file from path to new_path.
--
-- Warning: If the destination path is created, but an error occurs while
-- copying the data, then the destination path is removed. There is a
-- brief window of time between closing and removing the file where
-- another process could access the file.
copyfile :: HasCallStack => CBytes -> CBytes -> UVCopyFileFlag -> IO ()
data UVAccessMode
data AccessResult
NoExistence :: AccessResult
NoPermission :: AccessResult
AccessOK :: AccessResult
-- | Equivalent to access(2) on Unix. Windows uses
-- GetFileAttributesW().
access :: HasCallStack => CBytes -> UVAccessMode -> IO AccessResult
-- | Equivalent to chmod(2).
chmod :: HasCallStack => CBytes -> UVFileMode -> IO ()
-- | Equivalent to fchmod(2).
fchmod :: HasCallStack => UVFile -> UVFileMode -> IO ()
-- | Equivalent to utime(2).
--
-- libuv choose Double type due to cross platform concerns, we
-- only provide micro-second precision:
--
--
-- - second = v
-- - nanosecond = (v * 1000000) % 1000000 * 1000;
--
--
-- second and nanosecond are fields in UVTimeSpec respectively.
--
-- Note libuv prior to v1.23.1 have issues which may result in nanosecond
-- not set, futime doesn't have
utime :: HasCallStack => CBytes -> Double -> Double -> IO ()
-- | Equivalent to futime(2).
--
-- Same precision notes with utime.
futime :: HasCallStack => UVFile -> Double -> Double -> IO ()
data UVSymlinkFlag
-- | Equivalent to link(2).
link :: HasCallStack => CBytes -> CBytes -> IO ()
-- | Equivalent to symlink(2).
--
-- | Note On Windows the flags parameter can be specified to control how
-- the symlink will be created.
--
--
-- - SYMLINK_DIR: indicates that path points to a
-- directory.
-- - SYMLINK_JUNCTION: request that the symlink is created using
-- junction points.
--
--
-- On other platforms these flags are ignored.
symlink :: HasCallStack => CBytes -> CBytes -> UVSymlinkFlag -> IO ()
-- | Equivalent to readlink(2).
readlink :: HasCallStack => CBytes -> IO CBytes
-- | Equivalent to realpath(3) on Unix. Windows uses
-- GetFinalPathNameByHandle.
--
-- Warning This function has certain platform-specific caveats that were
-- discovered when used in Node.
--
--
-- - macOS and other BSDs: this function will fail with UV_ELOOP if
-- more than 32 symlinks are found while resolving the given path. This
-- limit is hardcoded and cannot be sidestepped.
-- - Windows: while this function works in the common case, there are a
-- number of corner cases where it doesn’t:
- Paths in ramdisk
-- volumes created by tools which sidestep the Volume Manager (such as
-- ImDisk) cannot be resolved.
- Inconsistent casing when using
-- drive letters.
- Resolved path bypasses subst’d
-- drives.
--
--
-- While this function can still be used, it’s not recommended if
-- scenarios such as the above need to be supported. The background story
-- and some more details on these issues can be checked here.
--
-- Note This function is not implemented on Windows XP and Windows Server
-- 2003. On these systems, UV_ENOSYS is returned.
realpath :: HasCallStack => CBytes -> IO CBytes
instance Std.IO.Buffered.Output Std.IO.FileSystemT.UVFileWriter
instance Std.IO.Buffered.Input Std.IO.FileSystemT.UVFileReader
instance GHC.Show.Show Std.IO.FileSystemT.UVFile
instance Std.IO.Buffered.Input Std.IO.FileSystemT.UVFile
instance Std.IO.Buffered.Output Std.IO.FileSystemT.UVFile
-- | This module provide IO operations related to filesystem, operations
-- are implemented using unsafe FFIs, which should be prefered when the
-- operations' estimated time is short(<1ms), which is much common on
-- modern SSDs.
module Std.IO.FileSystem
-- | UVFile wrap a uv_file_t and a referencing counter.
--
-- libuv implements read and write method with both implict and explict
-- offset capable. (negative offset result in read/write system
-- call otherwise pread/pwrite), we provide implict offset
-- interface with UVFile, which is NOT thread safe.
--
-- An offset bundled UVFileReader, UVFileWriter is also
-- provided, which can be used concurrently. The offset is protected with
-- MVar and increasing automatically.
data UVFile
-- | An UVFile bundled with a MVar protected reading offset.
data UVFileReader
-- | Create a reader from an UVFile.
--
-- Note this will not increase UVFile's referencing counter.
newUVFileReader :: UVFile -> Int64 -> IO UVFileReader
-- | Change reader's offset.
peekUVFileReader :: UVFileReader -> Int64 -> IO Int64
-- | An UVFile bundled with a MVar protected writing offset.
data UVFileWriter
-- | Create a writer from an UVFile.
--
-- Note this will not increase UVFile's referencing counter.
newUVFileWriter :: UVFile -> Int64 -> IO UVFileWriter
-- | Change writer's offset.
peekUVFileWriter :: UVFileWriter -> Int64 -> IO Int64
-- | init a file Resource, which open a file when used.
--
-- Resource closing will wait for the referencing counter goes down to
-- zero (no reading or writing is in process), which can be a problem if
-- you are using multiple readers or writers in multiple threads. In that
-- case you have to stop all reading or writing thread if you don't want
-- to block the resource thread.
--
-- Note, on some versions of OSX, repeatly open and close same file
-- Resource may result in shared memory object error, use
-- O_CREAT to avoid that.
initUVFile :: HasCallStack => CBytes -> UVFileFlag -> UVFileMode -> Resource UVFile
data UVFileMode
data UVFileFlag
-- | Equivalent to mkdir(2).
--
-- Note mode is currently not implemented on Windows.
mkdir :: HasCallStack => CBytes -> UVFileMode -> IO ()
-- | Equivalent to unlink(2).
unlink :: HasCallStack => CBytes -> IO ()
-- | Equivalent to http://linux.die.net/man/3/mkdtemp
--
-- Creates a temporary directory in the most secure manner possible.
-- There are no race conditions in the directory’s creation. The
-- directory is readable, writable, and searchable only by the creating
-- user ID. The user of mkdtemp() is responsible for deleting the
-- temporary directory and its contents when done with it.
--
-- Note: the argument is the prefix of the temporary directory, so no
-- need to add XXXXXX ending.
mkdtemp :: HasCallStack => CBytes -> IO CBytes
-- | Equivalent to rmdir(2).
rmdir :: HasCallStack => CBytes -> IO ()
data DirEntType
DirEntUnknown :: DirEntType
DirEntFile :: DirEntType
DirEntDir :: DirEntType
DirEntLink :: DirEntType
DirEntFIFO :: DirEntType
DirEntSocket :: DirEntType
DirEntChar :: DirEntType
DirEntBlock :: DirEntType
-- | Equivalent to scandir(3).
--
-- Note Unlike scandir(3), this function does not return the “.” and “..”
-- entries.
--
-- Note On Linux, getting the type of an entry is only supported by some
-- file systems (btrfs, ext2, ext3 and ext4 at the time of this writing),
-- check the getdents(2) man page.
scandir :: HasCallStack => CBytes -> IO [(CBytes, DirEntType)]
data UVStat
UVStat :: {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !Word64 -> {-# UNPACK #-} !UVTimeSpec -> {-# UNPACK #-} !UVTimeSpec -> {-# UNPACK #-} !UVTimeSpec -> {-# UNPACK #-} !UVTimeSpec -> UVStat
[stDev] :: UVStat -> {-# UNPACK #-} !Word64
[stMode] :: UVStat -> {-# UNPACK #-} !Word64
[stNlink] :: UVStat -> {-# UNPACK #-} !Word64
[stUid] :: UVStat -> {-# UNPACK #-} !Word64
[stGid] :: UVStat -> {-# UNPACK #-} !Word64
[stRdev] :: UVStat -> {-# UNPACK #-} !Word64
[stIno] :: UVStat -> {-# UNPACK #-} !Word64
[stSize] :: UVStat -> {-# UNPACK #-} !Word64
[stBlksize] :: UVStat -> {-# UNPACK #-} !Word64
[stBlocks] :: UVStat -> {-# UNPACK #-} !Word64
[stFlags] :: UVStat -> {-# UNPACK #-} !Word64
[stGen] :: UVStat -> {-# UNPACK #-} !Word64
[stAtim] :: UVStat -> {-# UNPACK #-} !UVTimeSpec
[stMtim] :: UVStat -> {-# UNPACK #-} !UVTimeSpec
[stCtim] :: UVStat -> {-# UNPACK #-} !UVTimeSpec
[stBirthtim] :: UVStat -> {-# UNPACK #-} !UVTimeSpec
data UVTimeSpec
UVTimeSpec :: {-# UNPACK #-} !CLong -> {-# UNPACK #-} !CLong -> UVTimeSpec
[uvtSecond] :: UVTimeSpec -> {-# UNPACK #-} !CLong
[uvtNanoSecond] :: UVTimeSpec -> {-# UNPACK #-} !CLong
-- | Equivalent to stat(2)
stat :: HasCallStack => CBytes -> IO UVStat
-- | Equivalent to lstat(2)
lstat :: HasCallStack => CBytes -> IO UVStat
-- | Equivalent to fstat(2)
fstat :: HasCallStack => UVFile -> IO UVStat
-- | Equivalent to rename(2).
--
-- Note On Windows if this function fails with UV_EBUSY, UV_EPERM or
-- UV_EACCES, it will retry to rename the file up to four times with
-- 250ms wait between attempts before giving up. If both path and
-- new_path are existing directories this function will work only if
-- target directory is empty.
rename :: HasCallStack => CBytes -> CBytes -> IO ()
-- | Equivalent to fsync(2).
fsync :: HasCallStack => UVFile -> IO ()
-- | Equivalent to fdatasync(2).
fdatasync :: HasCallStack => UVFile -> IO ()
-- | Equivalent to ftruncate(2).
ftruncate :: HasCallStack => UVFile -> Int64 -> IO ()
-- | Flags control copying.
--
--
-- - COPYFILE_EXCL: If present, uv_fs_copyfile() will fail with
-- UV_EEXIST if the destination path already exists. The default behavior
-- is to overwrite the destination if it exists.
-- - COPYFILE_FICLONE: If present, uv_fs_copyfile() will attempt
-- to create a copy-on-write reflink. If the underlying platform does not
-- support copy-on-write, then a fallback copy mechanism is used.
--
data UVCopyFileFlag
-- | Copies a file from path to new_path.
--
-- Warning: If the destination path is created, but an error occurs while
-- copying the data, then the destination path is removed. There is a
-- brief window of time between closing and removing the file where
-- another process could access the file.
copyfile :: HasCallStack => CBytes -> CBytes -> UVCopyFileFlag -> IO ()
data UVAccessMode
data AccessResult
NoExistence :: AccessResult
NoPermission :: AccessResult
AccessOK :: AccessResult
-- | Equivalent to access(2) on Unix. Windows uses
-- GetFileAttributesW().
access :: HasCallStack => CBytes -> UVAccessMode -> IO AccessResult
-- | Equivalent to chmod(2).
chmod :: HasCallStack => CBytes -> UVFileMode -> IO ()
-- | Equivalent to fchmod(2).
fchmod :: HasCallStack => UVFile -> UVFileMode -> IO ()
-- | Equivalent to utime(2).
--
-- libuv choose Double type due to cross platform concerns, we
-- only provide micro-second precision:
--
--
-- - second = v
-- - nanosecond = (v * 1000000) % 1000000 * 1000;
--
--
-- second and nanosecond are fields in UVTimeSpec respectively.
--
-- Note libuv prior to v1.23.1 have issues which may result in nanosecond
-- not set, futime doesn't have that issue.
utime :: HasCallStack => CBytes -> Double -> Double -> IO ()
-- | Equivalent to futime(2).
--
-- Same precision notes with utime.
futime :: HasCallStack => UVFile -> Double -> Double -> IO ()
data UVSymlinkFlag
-- | Equivalent to link(2).
link :: HasCallStack => CBytes -> CBytes -> IO ()
-- | Equivalent to symlink(2).
--
-- | Note On Windows the flags parameter can be specified to control how
-- the symlink will be created.
--
--
-- - SYMLINK_DIR: indicates that path points to a
-- directory.
-- - SYMLINK_JUNCTION: request that the symlink is created using
-- junction points.
--
--
-- On other platforms these flags are ignored.
symlink :: HasCallStack => CBytes -> CBytes -> UVSymlinkFlag -> IO ()
-- | Equivalent to readlink(2).
readlink :: HasCallStack => CBytes -> IO CBytes
-- | Equivalent to realpath(3) on Unix. Windows uses
-- GetFinalPathNameByHandle.
--
-- Warning This function has certain platform-specific caveats that were
-- discovered when used in Node.
--
--
-- - macOS and other BSDs: this function will fail with UV_ELOOP if
-- more than 32 symlinks are found while resolving the given path. This
-- limit is hardcoded and cannot be sidestepped.
-- - Windows: while this function works in the common case, there are a
-- number of corner cases where it doesn’t:
- Paths in ramdisk
-- volumes created by tools which sidestep the Volume Manager (such as
-- ImDisk) cannot be resolved.
- Inconsistent casing when using
-- drive letters.
- Resolved path bypasses subst’d
-- drives.
--
--
-- While this function can still be used, it’s not recommended if
-- scenarios such as the above need to be supported. The background story
-- and some more details on these issues can be checked here.
--
-- Note This function is not implemented on Windows XP and Windows Server
-- 2003. On these systems, UV_ENOSYS is returned.
realpath :: HasCallStack => CBytes -> IO CBytes
instance Std.IO.Buffered.Output Std.IO.FileSystem.UVFileWriter
instance Std.IO.Buffered.Input Std.IO.FileSystem.UVFileReader
instance GHC.Show.Show Std.IO.FileSystem.UVFile
instance Std.IO.Buffered.Input Std.IO.FileSystem.UVFile
instance Std.IO.Buffered.Output Std.IO.FileSystem.UVFile