ghc/lib/std/PrelForeign.lhs

   1 % ------------------------------------------------------------------------------
   2 % $Id: PrelForeign.lhs,v 1.20 2001/07/16 00:39:04 sof Exp $
   3 %
   4 % (c) The University of Glasgow, 1994-2000
   5 %
   6
   7 \section[Foreign]{Module @Foreign@}
   8
   9 \begin{code}
  10 {-# OPTIONS -fno-implicit-prelude #-}
  11
  12 module PrelForeign where
  13
  14 import PrelIOBase
  15 import PrelNum                  -- for fromInteger
  16 import PrelBase
  17 import PrelPtr
  18 \end{code}
  19
  20 %*********************************************************
  21 %*                                                      *
  22 \subsection{ForeignPtr}
  23 %*                                                      *
  24 %*********************************************************
  25
  26 \begin{code}
  27 data ForeignPtr a = ForeignPtr ForeignObj#
  28 instance CCallable (ForeignPtr a)
  29
  30 eqForeignPtr  :: ForeignPtr a -> ForeignPtr a -> Bool
  31 eqForeignPtr (ForeignPtr fo1#) (ForeignPtr fo2#) = eqForeignObj# fo1# fo2#
  32
  33 instance Eq (ForeignPtr a) where
  34     p == q = eqForeignPtr p q
  35     p /= q = not (eqForeignPtr p q)
  36
  37 newForeignPtr :: Ptr a -> IO () -> IO (ForeignPtr a)
  38 newForeignPtr p finalizer
  39   = do fObj <- mkForeignPtr p
  40        addForeignPtrFinalizer fObj finalizer
  41        return fObj
  42
  43 addForeignPtrFinalizer :: ForeignPtr a -> IO () -> IO ()
  44 addForeignPtrFinalizer (ForeignPtr fo) finalizer =
  45   IO $ \s -> case mkWeak# fo () finalizer s of { (# s1, w #) -> (# s1, () #) }
  46
  47 mkForeignPtr :: Ptr a -> IO (ForeignPtr a) {- not exported -}
  48 mkForeignPtr (Ptr obj) =  IO ( \ s# ->
  49     case mkForeignObj# obj s# of
  50       (# s1#, fo# #) -> (# s1#,  ForeignPtr fo# #) )
  51
  52 touchForeignPtr :: ForeignPtr a -> IO ()
  53 touchForeignPtr (ForeignPtr fo)
  54    = IO $ \s -> case touch# fo s of s -> (# s, () #)
  55
  56 withForeignPtr :: ForeignPtr a -> (Ptr a -> IO b) -> IO b
  57 withForeignPtr fo io
  58   = do r <- io (foreignPtrToPtr fo)
  59        touchForeignPtr fo
  60        return r
  61
  62 foreignPtrToPtr :: ForeignPtr a -> Ptr a
  63 foreignPtrToPtr (ForeignPtr fo) = Ptr (foreignObjToAddr# fo)
  64
  65 castForeignPtr (ForeignPtr a) = ForeignPtr a
  66
  67 \end{code}
  68
  69