Use explicit language extensions & remove extension fields from base.cabal
[packages/base.git] / GHC / Conc.lhs
1 \begin{code}
2 {-# LANGUAGE CPP, NoImplicitPrelude #-}
3 {-# OPTIONS_GHC -fno-warn-missing-signatures #-}
4 {-# OPTIONS_HADDOCK not-home #-}
5
6 -----------------------------------------------------------------------------
7 -- |
8 -- Module      :  GHC.Conc
9 -- Copyright   :  (c) The University of Glasgow, 1994-2002
10 -- License     :  see libraries/base/LICENSE
11 -- 
12 -- Maintainer  :  cvs-ghc@haskell.org
13 -- Stability   :  internal
14 -- Portability :  non-portable (GHC extensions)
15 --
16 -- Basic concurrency stuff.
17 -- 
18 -----------------------------------------------------------------------------
19
20 -- No: #hide, because bits of this module are exposed by the stm package.
21 -- However, we don't want this module to be the home location for the
22 -- bits it exports, we'd rather have Control.Concurrent and the other
23 -- higher level modules be the home.  Hence:
24
25 #include "Typeable.h"
26
27 -- #not-home
28 module GHC.Conc
29         ( ThreadId(..)
30
31         -- * Forking and suchlike
32         , forkIO        -- :: IO a -> IO ThreadId
33         , forkIOUnmasked
34         , forkOnIO      -- :: Int -> IO a -> IO ThreadId
35         , forkOnIOUnmasked
36         , numCapabilities -- :: Int
37         , numSparks       -- :: IO Int
38         , childHandler  -- :: Exception -> IO ()
39         , myThreadId    -- :: IO ThreadId
40         , killThread    -- :: ThreadId -> IO ()
41         , throwTo       -- :: ThreadId -> Exception -> IO ()
42         , par           -- :: a -> b -> b
43         , pseq          -- :: a -> b -> b
44         , runSparks
45         , yield         -- :: IO ()
46         , labelThread   -- :: ThreadId -> String -> IO ()
47
48         , ThreadStatus(..), BlockReason(..)
49         , threadStatus  -- :: ThreadId -> IO ThreadStatus
50
51         -- * Waiting
52         , threadDelay           -- :: Int -> IO ()
53         , registerDelay         -- :: Int -> IO (TVar Bool)
54         , threadWaitRead        -- :: Int -> IO ()
55         , threadWaitWrite       -- :: Int -> IO ()
56         , closeFdWith           -- :: (Fd -> IO ()) -> Fd -> IO ()
57
58         -- * TVars
59         , STM(..)
60         , atomically    -- :: STM a -> IO a
61         , retry         -- :: STM a
62         , orElse        -- :: STM a -> STM a -> STM a
63         , throwSTM      -- :: Exception e => e -> STM a
64         , catchSTM      -- :: Exception e => STM a -> (e -> STM a) -> STM a
65         , alwaysSucceeds -- :: STM a -> STM ()
66         , always        -- :: STM Bool -> STM ()
67         , TVar(..)
68         , newTVar       -- :: a -> STM (TVar a)
69         , newTVarIO     -- :: a -> STM (TVar a)
70         , readTVar      -- :: TVar a -> STM a
71         , readTVarIO    -- :: TVar a -> IO a
72         , writeTVar     -- :: a -> TVar a -> STM ()
73         , unsafeIOToSTM -- :: IO a -> STM a
74
75         -- * Miscellaneous
76         , withMVar
77 #ifdef mingw32_HOST_OS
78         , asyncRead     -- :: Int -> Int -> Int -> Ptr a -> IO (Int, Int)
79         , asyncWrite    -- :: Int -> Int -> Int -> Ptr a -> IO (Int, Int)
80         , asyncDoProc   -- :: FunPtr (Ptr a -> IO Int) -> Ptr a -> IO Int
81
82         , asyncReadBA   -- :: Int -> Int -> Int -> Int -> MutableByteArray# RealWorld -> IO (Int, Int)
83         , asyncWriteBA  -- :: Int -> Int -> Int -> Int -> MutableByteArray# RealWorld -> IO (Int, Int)
84 #endif
85
86 #ifndef mingw32_HOST_OS
87         , Signal, HandlerFun, setHandler, runHandlers
88 #endif
89
90         , ensureIOManagerIsRunning
91
92 #ifdef mingw32_HOST_OS
93         , ConsoleEvent(..)
94         , win32ConsoleHandler
95         , toWin32ConsoleEvent
96 #endif
97         , setUncaughtExceptionHandler      -- :: (Exception -> IO ()) -> IO ()
98         , getUncaughtExceptionHandler      -- :: IO (Exception -> IO ())
99
100         , reportError, reportStackOverflow
101         ) where
102
103 import GHC.Conc.IO
104 import GHC.Conc.Sync
105
106 #ifndef mingw32_HOST_OS
107 import GHC.Conc.Signal
108 #endif
109
110 \end{code}