GHC/Storable.lhs

   1 \begin{code}
   2 {-# LANGUAGE NoImplicitPrelude, MagicHash, UnboxedTuples #-}
   3 {-# OPTIONS_HADDOCK hide #-}
   4
   5 -----------------------------------------------------------------------------
   6 -- |
   7 -- Module      :  GHC.Storable
   8 -- Copyright   :  (c) The FFI task force, 2000-2002
   9 -- License     :  see libraries/base/LICENSE
  10 --
  11 -- Maintainer  :  ffi@haskell.org
  12 -- Stability   :  internal
  13 -- Portability :  non-portable (GHC Extensions)
  14 --
  15 -- Helper functions for "Foreign.Storable"
  16 --
  17 -----------------------------------------------------------------------------
  18
  19 -- #hide
  20 module GHC.Storable
  21         ( readWideCharOffPtr
  22         , readIntOffPtr
  23         , readWordOffPtr
  24         , readPtrOffPtr
  25         , readFunPtrOffPtr
  26         , readFloatOffPtr
  27         , readDoubleOffPtr
  28         , readStablePtrOffPtr
  29         , readInt8OffPtr
  30         , readInt16OffPtr
  31         , readInt32OffPtr
  32         , readInt64OffPtr
  33         , readWord8OffPtr
  34         , readWord16OffPtr
  35         , readWord32OffPtr
  36         , readWord64OffPtr
  37         , writeWideCharOffPtr
  38         , writeIntOffPtr
  39         , writeWordOffPtr
  40         , writePtrOffPtr
  41         , writeFunPtrOffPtr
  42         , writeFloatOffPtr
  43         , writeDoubleOffPtr
  44         , writeStablePtrOffPtr
  45         , writeInt8OffPtr
  46         , writeInt16OffPtr
  47         , writeInt32OffPtr
  48         , writeInt64OffPtr
  49         , writeWord8OffPtr
  50         , writeWord16OffPtr
  51         , writeWord32OffPtr
  52         , writeWord64OffPtr
  53         ) where
  54
  55 import GHC.Stable       ( StablePtr(..) )
  56 import GHC.Int
  57 import GHC.Word
  58 import GHC.Ptr
  59 import GHC.Base
  60 \end{code}
  61
  62 \begin{code}
  63
  64 readWideCharOffPtr  :: Ptr Char          -> Int -> IO Char
  65 readIntOffPtr       :: Ptr Int           -> Int -> IO Int
  66 readWordOffPtr      :: Ptr Word          -> Int -> IO Word
  67 readPtrOffPtr       :: Ptr (Ptr a)       -> Int -> IO (Ptr a)
  68 readFunPtrOffPtr    :: Ptr (FunPtr a)    -> Int -> IO (FunPtr a)
  69 readFloatOffPtr     :: Ptr Float         -> Int -> IO Float
  70 readDoubleOffPtr    :: Ptr Double        -> Int -> IO Double
  71 readStablePtrOffPtr :: Ptr (StablePtr a) -> Int -> IO (StablePtr a)
  72 readInt8OffPtr      :: Ptr Int8          -> Int -> IO Int8
  73 readInt16OffPtr     :: Ptr Int16         -> Int -> IO Int16
  74 readInt32OffPtr     :: Ptr Int32         -> Int -> IO Int32
  75 readInt64OffPtr     :: Ptr Int64         -> Int -> IO Int64
  76 readWord8OffPtr     :: Ptr Word8         -> Int -> IO Word8
  77 readWord16OffPtr    :: Ptr Word16        -> Int -> IO Word16
  78 readWord32OffPtr    :: Ptr Word32        -> Int -> IO Word32
  79 readWord64OffPtr    :: Ptr Word64        -> Int -> IO Word64
  80
  81 readWideCharOffPtr (Ptr a) (I# i)
  82   = IO $ \s -> case readWideCharOffAddr# a i s  of (# s2, x #) -> (# s2, C# x #)
  83 readIntOffPtr (Ptr a) (I# i)
  84   = IO $ \s -> case readIntOffAddr# a i s       of (# s2, x #) -> (# s2, I# x #)
  85 readWordOffPtr (Ptr a) (I# i)
  86   = IO $ \s -> case readWordOffAddr# a i s      of (# s2, x #) -> (# s2, W# x #)
  87 readPtrOffPtr (Ptr a) (I# i)
  88   = IO $ \s -> case readAddrOffAddr# a i s      of (# s2, x #) -> (# s2, Ptr x #)
  89 readFunPtrOffPtr (Ptr a) (I# i)
  90   = IO $ \s -> case readAddrOffAddr# a i s      of (# s2, x #) -> (# s2, FunPtr x #)
  91 readFloatOffPtr (Ptr a) (I# i)
  92   = IO $ \s -> case readFloatOffAddr# a i s     of (# s2, x #) -> (# s2, F# x #)
  93 readDoubleOffPtr (Ptr a) (I# i)
  94   = IO $ \s -> case readDoubleOffAddr# a i s    of (# s2, x #) -> (# s2, D# x #)
  95 readStablePtrOffPtr (Ptr a) (I# i)
  96   = IO $ \s -> case readStablePtrOffAddr# a i s of (# s2, x #) -> (# s2, StablePtr x #)
  97 readInt8OffPtr (Ptr a) (I# i)
  98   = IO $ \s -> case readInt8OffAddr# a i s      of (# s2, x #) -> (# s2, I8# x #)
  99 readWord8OffPtr (Ptr a) (I# i)
 100   = IO $ \s -> case readWord8OffAddr# a i s     of (# s2, x #) -> (# s2, W8# x #)
 101 readInt16OffPtr (Ptr a) (I# i)
 102   = IO $ \s -> case readInt16OffAddr# a i s     of (# s2, x #) -> (# s2, I16# x #)
 103 readWord16OffPtr (Ptr a) (I# i)
 104   = IO $ \s -> case readWord16OffAddr# a i s    of (# s2, x #) -> (# s2, W16# x #)
 105 readInt32OffPtr (Ptr a) (I# i)
 106   = IO $ \s -> case readInt32OffAddr# a i s     of (# s2, x #) -> (# s2, I32# x #)
 107 readWord32OffPtr (Ptr a) (I# i)
 108   = IO $ \s -> case readWord32OffAddr# a i s    of (# s2, x #) -> (# s2, W32# x #)
 109 readInt64OffPtr (Ptr a) (I# i)
 110   = IO $ \s -> case readInt64OffAddr# a i s     of (# s2, x #) -> (# s2, I64# x #)
 111 readWord64OffPtr (Ptr a) (I# i)
 112   = IO $ \s -> case readWord64OffAddr# a i s    of (# s2, x #) -> (# s2, W64# x #)
 113
 114 writeWideCharOffPtr  :: Ptr Char          -> Int -> Char        -> IO ()
 115 writeIntOffPtr       :: Ptr Int           -> Int -> Int         -> IO ()
 116 writeWordOffPtr      :: Ptr Word          -> Int -> Word        -> IO ()
 117 writePtrOffPtr       :: Ptr (Ptr a)       -> Int -> Ptr a       -> IO ()
 118 writeFunPtrOffPtr    :: Ptr (FunPtr a)    -> Int -> FunPtr a    -> IO ()
 119 writeFloatOffPtr     :: Ptr Float         -> Int -> Float       -> IO ()
 120 writeDoubleOffPtr    :: Ptr Double        -> Int -> Double      -> IO ()
 121 writeStablePtrOffPtr :: Ptr (StablePtr a) -> Int -> StablePtr a -> IO ()
 122 writeInt8OffPtr      :: Ptr Int8          -> Int -> Int8        -> IO ()
 123 writeInt16OffPtr     :: Ptr Int16         -> Int -> Int16       -> IO ()
 124 writeInt32OffPtr     :: Ptr Int32         -> Int -> Int32       -> IO ()
 125 writeInt64OffPtr     :: Ptr Int64         -> Int -> Int64       -> IO ()
 126 writeWord8OffPtr     :: Ptr Word8         -> Int -> Word8       -> IO ()
 127 writeWord16OffPtr    :: Ptr Word16        -> Int -> Word16      -> IO ()
 128 writeWord32OffPtr    :: Ptr Word32        -> Int -> Word32      -> IO ()
 129 writeWord64OffPtr    :: Ptr Word64        -> Int -> Word64      -> IO ()
 130
 131 writeWideCharOffPtr (Ptr a) (I# i) (C# x)
 132   = IO $ \s -> case writeWideCharOffAddr# a i x s  of s2 -> (# s2, () #)
 133 writeIntOffPtr (Ptr a) (I# i) (I# x)
 134   = IO $ \s -> case writeIntOffAddr# a i x s       of s2 -> (# s2, () #)
 135 writeWordOffPtr (Ptr a) (I# i) (W# x)
 136   = IO $ \s -> case writeWordOffAddr# a i x s      of s2 -> (# s2, () #)
 137 writePtrOffPtr (Ptr a) (I# i) (Ptr x)
 138   = IO $ \s -> case writeAddrOffAddr# a i x s      of s2 -> (# s2, () #)
 139 writeFunPtrOffPtr (Ptr a) (I# i) (FunPtr x)
 140   = IO $ \s -> case writeAddrOffAddr# a i x s      of s2 -> (# s2, () #)
 141 writeFloatOffPtr (Ptr a) (I# i) (F# x)
 142   = IO $ \s -> case writeFloatOffAddr# a i x s     of s2 -> (# s2, () #)
 143 writeDoubleOffPtr (Ptr a) (I# i) (D# x)
 144   = IO $ \s -> case writeDoubleOffAddr# a i x s    of s2 -> (# s2, () #)
 145 writeStablePtrOffPtr (Ptr a) (I# i) (StablePtr x)
 146   = IO $ \s -> case writeStablePtrOffAddr# a i x s of s2 -> (# s2 , () #)
 147 writeInt8OffPtr (Ptr a) (I# i) (I8# x)
 148   = IO $ \s -> case writeInt8OffAddr# a i x s      of s2 -> (# s2, () #)
 149 writeWord8OffPtr (Ptr a) (I# i) (W8# x)
 150   = IO $ \s -> case writeWord8OffAddr# a i x s     of s2 -> (# s2, () #)
 151 writeInt16OffPtr (Ptr a) (I# i) (I16# x)
 152   = IO $ \s -> case writeInt16OffAddr# a i x s     of s2 -> (# s2, () #)
 153 writeWord16OffPtr (Ptr a) (I# i) (W16# x)
 154   = IO $ \s -> case writeWord16OffAddr# a i x s    of s2 -> (# s2, () #)
 155 writeInt32OffPtr (Ptr a) (I# i) (I32# x)
 156   = IO $ \s -> case writeInt32OffAddr# a i x s     of s2 -> (# s2, () #)
 157 writeWord32OffPtr (Ptr a) (I# i) (W32# x)
 158   = IO $ \s -> case writeWord32OffAddr# a i x s    of s2 -> (# s2, () #)
 159 writeInt64OffPtr (Ptr a) (I# i) (I64# x)
 160   = IO $ \s -> case writeInt64OffAddr# a i x s     of s2 -> (# s2, () #)
 161 writeWord64OffPtr (Ptr a) (I# i) (W64# x)
 162   = IO $ \s -> case writeWord64OffAddr# a i x s    of s2 -> (# s2, () #)
 163
 164 \end{code}