GHC/Storable.lhs

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