[project @ 2003-06-19 10:42:26 by simonmar]
[packages/random.git] / GHC / Exception.lhs
1 \begin{code}
2 {-# OPTIONS -fno-implicit-prelude #-}
3 -----------------------------------------------------------------------------
4 -- |
5 -- Module      :  GHC.Exception
6 -- Copyright   :  (c) The University of Glasgow, 1998-2002
7 -- License     :  see libraries/base/LICENSE
8 -- 
9 -- Maintainer  :  cvs-ghc@haskell.org
10 -- Stability   :  internal
11 -- Portability :  non-portable (GHC extensions)
12 --
13 -- Exceptions and exception-handling functions.
14 -- 
15 -----------------------------------------------------------------------------
16
17 module GHC.Exception 
18         ( module GHC.Exception, 
19           Exception(..), AsyncException(..), 
20           IOException(..), ArithException(..), ArrayException(..),
21           throw, throwIO, ioError ) 
22   where
23
24 import GHC.Base
25 import GHC.IOBase
26 \end{code}
27
28 %*********************************************************
29 %*                                                      *
30 \subsection{Primitive catch}
31 %*                                                      *
32 %*********************************************************
33
34 catchException used to handle the passing around of the state to the
35 action and the handler.  This turned out to be a bad idea - it meant
36 that we had to wrap both arguments in thunks so they could be entered
37 as normal (remember IO returns an unboxed pair...).
38
39 Now catch# has type
40
41     catch# :: IO a -> (b -> IO a) -> IO a
42
43 (well almost; the compiler doesn't know about the IO newtype so we
44 have to work around that in the definition of catchException below).
45
46 \begin{code}
47 catchException :: IO a -> (Exception -> IO a) -> IO a
48 catchException (IO m) k =  IO $ \s -> catch# m (\ex -> unIO (k ex)) s
49
50 catch           :: IO a -> (IOError -> IO a) -> IO a 
51 catch m k       =  catchException m handler
52   where handler (IOException err)   = k err
53         handler other               = throw other
54 \end{code}
55
56
57 %*********************************************************
58 %*                                                      *
59 \subsection{Controlling asynchronous exception delivery}
60 %*                                                      *
61 %*********************************************************
62
63 \begin{code}
64 -- | Applying 'block' to a computation will
65 -- execute that computation with asynchronous exceptions
66 -- /blocked/.  That is, any thread which
67 -- attempts to raise an exception in the current thread will be
68 -- blocked until asynchronous exceptions are enabled again.  There\'s
69 -- no need to worry about re-enabling asynchronous exceptions; that is
70 -- done automatically on exiting the scope of
71 -- 'block'.
72 block :: IO a -> IO a
73
74 -- | To re-enable asynchronous exceptions inside the scope of
75 -- 'block', 'unblock' can be
76 -- used.  It scopes in exactly the same way, so on exit from
77 -- 'unblock' asynchronous exception delivery will
78 -- be disabled again.
79 unblock :: IO a -> IO a
80
81 block (IO io) = IO $ blockAsyncExceptions# io
82 unblock (IO io) = IO $ unblockAsyncExceptions# io
83 \end{code}
84
85