[project @ 1998-02-02 17:27:26 by simonm]
[ghc-hetmet.git] / ghc / lib / exts / IOExts.lhs
1 %
2 % (c) The AQUA Project, Glasgow University, 1994-1996
3 %
4
5 \section[IOExts]{Module @IOExts@}
6
7 \begin{code}
8 {-# OPTIONS -fno-implicit-prelude #-}
9
10 module IOExts
11         ( fixIO
12         , unsafePerformIO
13         , unsafeInterleaveIO
14
15         , IORef
16           -- instance Eq (IORef a)
17         , newIORef
18         , readIORef
19         , writeIORef
20
21         , IOArray
22           -- instance Eq (IOArray ix a)
23         , newIOArray
24         , boundsIOArray
25         , readIOArray
26         , writeIOArray
27         , freezeIOArray
28
29         , trace
30         , performGC
31         
32         , reallyUnsafePtrEq
33         ) where
34 \end{code}
35
36 \begin{code}
37 import PrelBase
38 import PrelIOBase
39 import PrelST
40 import PrelUnsafe
41 import PrelArr
42 import PrelGHC
43 import Ix
44
45 reallyUnsafePtrEq a b =
46     case reallyUnsafePtrEquality# a b of
47          0# -> False
48          _  -> True
49 \end{code}
50
51 \begin{code}
52 newtype IORef a = IORef (MutableVar RealWorld a) 
53     deriving Eq
54
55 newIORef :: a -> IO (IORef a)
56 newIORef v = stToIO (newVar v) >>= \ var -> return (IORef var)
57
58 readIORef :: IORef a -> IO a
59 readIORef (IORef var) = stToIO (readVar var)
60
61 writeIORef :: IORef a -> a -> IO ()
62 writeIORef (IORef var) v = stToIO (writeVar var v)
63 \end{code}
64
65 \begin{code}
66 newtype IOArray ix elt = IOArray (MutableArray RealWorld ix elt)
67     deriving Eq
68
69 newIOArray          :: Ix ix => (ix,ix) -> elt -> IO (IOArray ix elt)
70 boundsIOArray       :: Ix ix => IOArray ix elt -> (ix, ix)
71 readIOArray         :: Ix ix => IOArray ix elt -> ix -> IO elt
72 writeIOArray        :: Ix ix => IOArray ix elt -> ix -> elt -> IO ()
73 freezeIOArray       :: Ix ix => IOArray ix elt -> IO (Array ix elt)
74
75 newIOArray ixs elt = 
76     stToIO (newArray ixs elt) >>= \arr -> 
77     return (IOArray arr)
78
79 boundsIOArray (IOArray arr) = boundsOfArray arr
80
81 readIOArray (IOArray arr) ix = stToIO (readArray arr ix)
82
83 writeIOArray (IOArray arr) ix elt = stToIO (writeArray arr ix elt)
84
85 freezeIOArray (IOArray arr) = stToIO (freezeArray arr)
86 \end{code}