1 -----------------------------------------------------------------------------
4 -- Copyright : (c) The University of Glasgow 2001
5 -- License : BSD-style (see the file libraries/base/LICENSE)
7 -- Maintainer : libraries@haskell.org
8 -- Stability : experimental
9 -- Portability : portable
11 -- Mutable references in the IO monad.
13 -----------------------------------------------------------------------------
18 IORef, -- abstract, instance of: Eq, Typeable
19 newIORef, -- :: a -> IO (IORef a)
20 readIORef, -- :: IORef a -> IO a
21 writeIORef, -- :: IORef a -> a -> IO ()
22 modifyIORef, -- :: IORef a -> (a -> a) -> IO ()
23 atomicModifyIORef, -- :: IORef a -> (a -> (a,b)) -> IO ()
25 #if !defined(__PARALLEL_HASKELL__) && defined(__GLASGOW_HASKELL__)
26 mkWeakIORef, -- :: IORef a -> IO () -> IO (Weak (IORef a))
36 #ifdef __GLASGOW_HASKELL__
37 import GHC.Base ( mkWeak#, atomicModifyMutVar# )
40 #if !defined(__PARALLEL_HASKELL__)
43 #endif /* __GLASGOW_HASKELL__ */
58 #if defined(__GLASGOW_HASKELL__) && !defined(__PARALLEL_HASKELL__)
59 -- |Make a 'Weak' pointer to an 'IORef'
60 mkWeakIORef :: IORef a -> IO () -> IO (Weak (IORef a))
61 mkWeakIORef r@(IORef (STRef r#)) f = IO $ \s ->
62 case mkWeak# r# r f s of (# s1, w #) -> (# s1, Weak w #)
65 -- |Mutate the contents of an 'IORef'
66 modifyIORef :: IORef a -> (a -> a) -> IO ()
67 modifyIORef ref f = writeIORef ref . f =<< readIORef ref
69 -- |Atomically modifies the contents of an 'IORef'.
71 -- This function is useful for using 'IORef' in a safe way in a multithreaded
72 -- program. If you only have one 'IORef', then using 'atomicModifyIORef' to
73 -- access and modify it will prevent race conditions.
75 -- Extending the atomicity to multiple 'IORef's is problematic, so it
76 -- is recommended that if you need to do anything more complicated
77 -- then using 'MVar' instead is a good idea.
79 atomicModifyIORef :: IORef a -> (a -> (a,b)) -> IO b
80 atomicModifyIORef (IORef (STRef r#)) f = IO $ \s -> atomicModifyMutVar# r# f s
84 INSTANCE_TYPEABLE1(IORef,ioRefTc,"IORef")