Remove Control.Parallel*, now in package parallel
[haskell-directory.git] / Control / Monad / ST.hs
1 -----------------------------------------------------------------------------
2 -- |
3 -- Module      :  Control.Monad.ST
4 -- Copyright   :  (c) The University of Glasgow 2001
5 -- License     :  BSD-style (see the file libraries/base/LICENSE)
6 -- 
7 -- Maintainer  :  libraries@haskell.org
8 -- Stability   :  experimental
9 -- Portability :  non-portable (requires universal quantification for runST)
10 --
11 -- This library provides support for /strict/ state threads, as
12 -- described in the PLDI \'94 paper by John Launchbury and Simon Peyton
13 -- Jones /Lazy Functional State Threads/.
14 --
15 -----------------------------------------------------------------------------
16
17 module Control.Monad.ST
18   (
19         -- * The 'ST' Monad
20         ST,             -- abstract, instance of Functor, Monad, Typeable.
21         runST,          -- :: (forall s. ST s a) -> a
22         fixST,          -- :: (a -> ST s a) -> ST s a
23
24         -- * Converting 'ST' to 'IO'
25         RealWorld,              -- abstract
26         stToIO,                 -- :: ST RealWorld a -> IO a
27
28         -- * Unsafe operations
29         unsafeInterleaveST,     -- :: ST s a -> ST s a
30         unsafeIOToST,           -- :: IO a -> ST s a
31         unsafeSTToIO            -- :: ST s a -> IO a
32       ) where
33
34 import Prelude
35
36 import Control.Monad.Fix
37
38 #include "Typeable.h"
39
40 #ifdef __HUGS__
41 import Data.Typeable
42 import Hugs.ST
43 import qualified Hugs.LazyST as LazyST
44
45 INSTANCE_TYPEABLE2(ST,sTTc,"ST")
46 INSTANCE_TYPEABLE0(RealWorld,realWorldTc,"RealWorld")
47
48 fixST :: (a -> ST s a) -> ST s a
49 fixST f = LazyST.lazyToStrictST (LazyST.fixST (LazyST.strictToLazyST . f))
50
51 unsafeInterleaveST :: ST s a -> ST s a
52 unsafeInterleaveST =
53     LazyST.lazyToStrictST . LazyST.unsafeInterleaveST . LazyST.strictToLazyST
54 #endif
55
56 #ifdef __GLASGOW_HASKELL__
57 import GHC.ST           ( ST, runST, fixST, unsafeInterleaveST )
58 import GHC.Base         ( RealWorld )
59 import GHC.IOBase       ( stToIO, unsafeIOToST, unsafeSTToIO )
60 #endif
61
62 instance MonadFix (ST s) where
63         mfix = fixST
64