GHC/IOBase.lhs

   1 \begin{code}
   2 {-# OPTIONS -fno-implicit-prelude #-}
   3 -----------------------------------------------------------------------------
   4 -- |
   5 -- Module      :  GHC.IOBase
   6 -- Copyright   :  (c) The University of Glasgow 1994-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 -- Definitions for the 'IO' monad and its friends.
  14 --
  15 -----------------------------------------------------------------------------
  16
  17 module GHC.IOBase where
  18
  19 import GHC.ST
  20 import GHC.Arr  -- to derive Ix class
  21 import GHC.Enum -- to derive Enum class
  22 import GHC.STRef
  23 import GHC.Base
  24 import GHC.Num  -- To get fromInteger etc, needed because of -fno-implicit-prelude
  25 import Data.Maybe  ( Maybe(..) )
  26 import GHC.Show
  27 import GHC.List
  28 import GHC.Read
  29
  30 #ifndef __HADDOCK__
  31 import {-# SOURCE #-} Data.Dynamic
  32 #endif
  33
  34 -- ---------------------------------------------------------------------------
  35 -- The IO Monad
  36
  37 {-
  38 The IO Monad is just an instance of the ST monad, where the state is
  39 the real world.  We use the exception mechanism (in GHC.Exception) to
  40 implement IO exceptions.
  41
  42 NOTE: The IO representation is deeply wired in to various parts of the
  43 system.  The following list may or may not be exhaustive:
  44
  45 Compiler  - types of various primitives in PrimOp.lhs
  46
  47 RTS       - forceIO (StgMiscClosures.hc)
  48           - catchzh_fast, (un)?blockAsyncExceptionszh_fast, raisezh_fast
  49             (Exceptions.hc)
  50           - raiseAsync (Schedule.c)
  51
  52 Prelude   - GHC.IOBase.lhs, and several other places including
  53             GHC.Exception.lhs.
  54
  55 Libraries - parts of hslibs/lang.
  56
  57 --SDM
  58 -}
  59
  60 {-|
  61 A value of type @'IO' a@ is a computation which, when performed,
  62 does some I\/O before returning a value of type @a@.
  63
  64 There is really only one way to \"perform\" an I\/O action: bind it to
  65 @Main.main@ in your program.  When your program is run, the I\/O will
  66 be performed.  It isn't possible to perform I\/O from an arbitrary
  67 function, unless that function is itself in the 'IO' monad and called
  68 at some point, directly or indirectly, from @Main.main@.
  69
  70 'IO' is a monad, so 'IO' actions can be combined using either the do-notation
  71 or the '>>' and '>>=' operations from the 'Monad' class.
  72 -}
  73 newtype IO a = IO (State# RealWorld -> (# State# RealWorld, a #))
  74
  75 unIO :: IO a -> (State# RealWorld -> (# State# RealWorld, a #))
  76 unIO (IO a) = a
  77
  78 instance  Functor IO where
  79    fmap f x = x >>= (return . f)
  80
  81 instance  Monad IO  where
  82     {-# INLINE return #-}
  83     {-# INLINE (>>)   #-}
  84     {-# INLINE (>>=)  #-}
  85     m >> k      =  m >>= \ _ -> k
  86     return x    = returnIO x
  87
  88     m >>= k     = bindIO m k
  89     fail s      = failIO s
  90
  91 failIO :: String -> IO a
  92 failIO s = ioError (userError s)
  93
  94 liftIO :: IO a -> State# RealWorld -> STret RealWorld a
  95 liftIO (IO m) = \s -> case m s of (# s', r #) -> STret s' r
  96
  97 bindIO :: IO a -> (a -> IO b) -> IO b
  98 bindIO (IO m) k = IO ( \ s ->
  99   case m s of
 100     (# new_s, a #) -> unIO (k a) new_s
 101   )
 102
 103 thenIO :: IO a -> IO b -> IO b
 104 thenIO (IO m) k = IO ( \ s ->
 105   case m s of
 106     (# new_s, a #) -> unIO k new_s
 107   )
 108
 109 returnIO :: a -> IO a
 110 returnIO x = IO (\ s -> (# s, x #))
 111
 112 -- ---------------------------------------------------------------------------
 113 -- Coercions between IO and ST
 114
 115 -- | A monad transformer embedding strict state transformers in the 'IO'
 116 -- monad.  The 'RealWorld' parameter indicates that the internal state
 117 -- used by the 'ST' computation is a special one supplied by the 'IO'
 118 -- monad, and thus distinct from those used by invocations of 'runST'.
 119 stToIO        :: ST RealWorld a -> IO a
 120 stToIO (ST m) = IO m
 121
 122 ioToST        :: IO a -> ST RealWorld a
 123 ioToST (IO m) = (ST m)
 124
 125 -- This relies on IO and ST having the same representation modulo the
 126 -- constraint on the type of the state
 127 --
 128 unsafeIOToST        :: IO a -> ST s a
 129 unsafeIOToST (IO io) = ST $ \ s -> (unsafeCoerce# io) s
 130
 131 -- ---------------------------------------------------------------------------
 132 -- Unsafe IO operations
 133
 134 {-|
 135 This is the \"back door\" into the 'IO' monad, allowing
 136 'IO' computation to be performed at any time.  For
 137 this to be safe, the 'IO' computation should be
 138 free of side effects and independent of its environment.
 139
 140 If the I\/O computation wrapped in 'unsafePerformIO'
 141 performs side effects, then the relative order in which those side
 142 effects take place (relative to the main I\/O trunk, or other calls to
 143 'unsafePerformIO') is indeterminate.  You have to be careful when
 144 writing and compiling modules that use 'unsafePerformIO':
 145
 146   * Use @{\-\# NOINLINE foo \#-\}@ as a pragma on any function @foo@
 147         that calls 'unsafePerformIO'.  If the call is inlined,
 148         the I\/O may be performed more than once.
 149
 150   * Use the compiler flag @-fno-cse@ to prevent common sub-expression
 151         elimination being performed on the module, which might combine
 152         two side effects that were meant to be separate.  A good example
 153         is using multiple global variables (like @test@ in the example below).
 154
 155   * Make sure that the either you switch off let-floating, or that the
 156         call to 'unsafePerformIO' cannot float outside a lambda.  For example,
 157         if you say:
 158         @
 159            f x = unsafePerformIO (newIORef [])
 160         @
 161         you may get only one reference cell shared between all calls to @f@.
 162         Better would be
 163         @
 164            f x = unsafePerformIO (newIORef [x])
 165         @
 166         because now it can't float outside the lambda.
 167
 168 It is less well known that
 169 'unsafePerformIO' is not type safe.  For example:
 170
 171 >     test :: IORef [a]
 172 >     test = unsafePerformIO $ newIORef []
 173 >
 174 >     main = do
 175 >             writeIORef test [42]
 176 >             bang <- readIORef test
 177 >             print (bang :: [Char])
 178
 179 This program will core dump.  This problem with polymorphic references
 180 is well known in the ML community, and does not arise with normal
 181 monadic use of references.  There is no easy way to make it impossible
 182 once you use 'unsafePerformIO'.  Indeed, it is
 183 possible to write @coerce :: a -> b@ with the
 184 help of 'unsafePerformIO'.  So be careful!
 185 -}
 186 {-# NOINLINE unsafePerformIO #-}
 187 unsafePerformIO :: IO a -> a
 188 unsafePerformIO (IO m) = case m realWorld# of (# _, r #)   -> r
 189
 190 -- Why do we NOINLINE unsafePerformIO?  See the comment with
 191 -- GHC.ST.runST.  Essentially the issue is that the IO computation
 192 -- inside unsafePerformIO must be atomic: it must either all run, or
 193 -- not at all.  If we let the compiler see the application of the IO
 194 -- to realWorld#, it might float out part of the IO.
 195
 196 {-|
 197 'unsafeInterleaveIO' allows 'IO' computation to be deferred lazily.
 198 When passed a value of type @IO a@, the 'IO' will only be performed
 199 when the value of the @a@ is demanded.  This is used to implement lazy
 200 file reading, see 'System.IO.hGetContents'.
 201 -}
 202 {-# INLINE unsafeInterleaveIO #-}
 203 unsafeInterleaveIO :: IO a -> IO a
 204 unsafeInterleaveIO (IO m)
 205   = IO ( \ s -> let
 206                    r = case m s of (# _, res #) -> res
 207                 in
 208                 (# s, r #))
 209
 210 -- We believe that INLINE on unsafeInterleaveIO is safe, because the
 211 -- state from this IO thread is passed explicitly to the interleaved
 212 -- IO, so it cannot be floated out and shared.
 213
 214 -- ---------------------------------------------------------------------------
 215 -- Handle type
 216
 217 data MVar a = MVar (MVar# RealWorld a)
 218 {- ^
 219 An 'MVar' (pronounced \"em-var\") is a synchronising variable, used
 220 for communication between concurrent threads.  It can be thought of
 221 as a a box, which may be empty or full.
 222 -}
 223
 224 -- pull in Eq (Mvar a) too, to avoid GHC.Conc being an orphan-instance module
 225 instance Eq (MVar a) where
 226         (MVar mvar1#) == (MVar mvar2#) = sameMVar# mvar1# mvar2#
 227
 228 --  A Handle is represented by (a reference to) a record
 229 --  containing the state of the I/O port/device. We record
 230 --  the following pieces of info:
 231
 232 --    * type (read,write,closed etc.)
 233 --    * the underlying file descriptor
 234 --    * buffering mode
 235 --    * buffer, and spare buffers
 236 --    * user-friendly name (usually the
 237 --      FilePath used when IO.openFile was called)
 238
 239 -- Note: when a Handle is garbage collected, we want to flush its buffer
 240 -- and close the OS file handle, so as to free up a (precious) resource.
 241
 242 -- | Haskell defines operations to read and write characters from and to files,
 243 -- represented by values of type @Handle@.  Each value of this type is a
 244 -- /handle/: a record used by the Haskell run-time system to /manage/ I\/O
 245 -- with file system objects.  A handle has at least the following properties:
 246 --
 247 --  * whether it manages input or output or both;
 248 --
 249 --  * whether it is /open/, /closed/ or /semi-closed/;
 250 --
 251 --  * whether the object is seekable;
 252 --
 253 --  * whether buffering is disabled, or enabled on a line or block basis;
 254 --
 255 --  * a buffer (whose length may be zero).
 256 --
 257 -- Most handles will also have a current I\/O position indicating where the next
 258 -- input or output operation will occur.  A handle is /readable/ if it
 259 -- manages only input or both input and output; likewise, it is /writable/ if
 260 -- it manages only output or both input and output.  A handle is /open/ when
 261 -- first allocated.
 262 -- Once it is closed it can no longer be used for either input or output,
 263 -- though an implementation cannot re-use its storage while references
 264 -- remain to it.  Handles are in the 'Show' and 'Eq' classes.  The string
 265 -- produced by showing a handle is system dependent; it should include
 266 -- enough information to identify the handle for debugging.  A handle is
 267 -- equal according to '==' only to itself; no attempt
 268 -- is made to compare the internal state of different handles for equality.
 269 --
 270 -- GHC note: a 'Handle' will be automatically closed when the garbage
 271 -- collector detects that it has become unreferenced by the program.
 272 -- However, relying on this behaviour is not generally recommended:
 273 -- the garbage collector is unpredictable.  If possible, use explicit
 274 -- an explicit 'hClose' to close 'Handle's when they are no longer
 275 -- required.  GHC does not currently attempt to free up file
 276 -- descriptors when they have run out, it is your responsibility to
 277 -- ensure that this doesn't happen.
 278
 279 data Handle
 280   = FileHandle                          -- A normal handle to a file
 281         FilePath                        -- the file (invariant)
 282         !(MVar Handle__)
 283
 284   | DuplexHandle                        -- A handle to a read/write stream
 285         FilePath                        -- file for a FIFO, otherwise some
 286                                         --   descriptive string.
 287         !(MVar Handle__)                -- The read side
 288         !(MVar Handle__)                -- The write side
 289
 290 -- NOTES:
 291 --    * A 'FileHandle' is seekable.  A 'DuplexHandle' may or may not be
 292 --      seekable.
 293
 294 instance Eq Handle where
 295  (FileHandle _ h1)     == (FileHandle _ h2)     = h1 == h2
 296  (DuplexHandle _ h1 _) == (DuplexHandle _ h2 _) = h1 == h2
 297  _ == _ = False
 298
 299 type FD = Int -- XXX ToDo: should be CInt
 300
 301 data Handle__
 302   = Handle__ {
 303       haFD          :: !FD,                  -- file descriptor
 304       haType        :: HandleType,           -- type (read/write/append etc.)
 305       haIsBin       :: Bool,                 -- binary mode?
 306       haIsStream    :: Bool,                 -- is this a stream handle?
 307       haBufferMode  :: BufferMode,           -- buffer contains read/write data?
 308       haBuffer      :: !(IORef Buffer),      -- the current buffer
 309       haBuffers     :: !(IORef BufferList),  -- spare buffers
 310       haOtherSide   :: Maybe (MVar Handle__) -- ptr to the write side of a
 311                                              -- duplex handle.
 312     }
 313
 314 -- ---------------------------------------------------------------------------
 315 -- Buffers
 316
 317 -- The buffer is represented by a mutable variable containing a
 318 -- record, where the record contains the raw buffer and the start/end
 319 -- points of the filled portion.  We use a mutable variable so that
 320 -- the common operation of writing (or reading) some data from (to)
 321 -- the buffer doesn't need to modify, and hence copy, the handle
 322 -- itself, it just updates the buffer.
 323
 324 -- There will be some allocation involved in a simple hPutChar in
 325 -- order to create the new Buffer structure (below), but this is
 326 -- relatively small, and this only has to be done once per write
 327 -- operation.
 328
 329 -- The buffer contains its size - we could also get the size by
 330 -- calling sizeOfMutableByteArray# on the raw buffer, but that tends
 331 -- to be rounded up to the nearest Word.
 332
 333 type RawBuffer = MutableByteArray# RealWorld
 334
 335 -- INVARIANTS on a Buffer:
 336 --
 337 --   * A handle *always* has a buffer, even if it is only 1 character long
 338 --     (an unbuffered handle needs a 1 character buffer in order to support
 339 --      hLookAhead and hIsEOF).
 340 --   * r <= w
 341 --   * if r == w, then r == 0 && w == 0
 342 --   * if state == WriteBuffer, then r == 0
 343 --   * a write buffer is never full.  If an operation
 344 --     fills up the buffer, it will always flush it before
 345 --     returning.
 346 --   * a read buffer may be full as a result of hLookAhead.  In normal
 347 --     operation, a read buffer always has at least one character of space.
 348
 349 data Buffer
 350   = Buffer {
 351         bufBuf   :: RawBuffer,
 352         bufRPtr  :: !Int,
 353         bufWPtr  :: !Int,
 354         bufSize  :: !Int,
 355         bufState :: BufferState
 356   }
 357
 358 data BufferState = ReadBuffer | WriteBuffer deriving (Eq)
 359
 360 -- we keep a few spare buffers around in a handle to avoid allocating
 361 -- a new one for each hPutStr.  These buffers are *guaranteed* to be the
 362 -- same size as the main buffer.
 363 data BufferList
 364   = BufferListNil
 365   | BufferListCons RawBuffer BufferList
 366
 367
 368 bufferIsWritable :: Buffer -> Bool
 369 bufferIsWritable Buffer{ bufState=WriteBuffer } = True
 370 bufferIsWritable _other = False
 371
 372 bufferEmpty :: Buffer -> Bool
 373 bufferEmpty Buffer{ bufRPtr=r, bufWPtr=w } = r == w
 374
 375 -- only makes sense for a write buffer
 376 bufferFull :: Buffer -> Bool
 377 bufferFull b@Buffer{ bufWPtr=w } = w >= bufSize b
 378
 379 --  Internally, we classify handles as being one
 380 --  of the following:
 381
 382 data HandleType
 383  = ClosedHandle
 384  | SemiClosedHandle
 385  | ReadHandle
 386  | WriteHandle
 387  | AppendHandle
 388  | ReadWriteHandle
 389
 390 isReadableHandleType ReadHandle         = True
 391 isReadableHandleType ReadWriteHandle    = True
 392 isReadableHandleType _                  = False
 393
 394 isWritableHandleType AppendHandle    = True
 395 isWritableHandleType WriteHandle     = True
 396 isWritableHandleType ReadWriteHandle = True
 397 isWritableHandleType _               = False
 398
 399 -- | File and directory names are values of type 'String', whose precise
 400 -- meaning is operating system dependent. Files can be opened, yielding a
 401 -- handle which can then be used to operate on the contents of that file.
 402
 403 type FilePath = String
 404
 405 -- ---------------------------------------------------------------------------
 406 -- Buffering modes
 407
 408 -- | Three kinds of buffering are supported: line-buffering,
 409 -- block-buffering or no-buffering.  These modes have the following
 410 -- effects. For output, items are written out, or /flushed/,
 411 -- from the internal buffer according to the buffer mode:
 412 --
 413 --  * /line-buffering/: the entire output buffer is flushed
 414 --    whenever a newline is output, the buffer overflows,
 415 --    a 'System.IO.hFlush' is issued, or the handle is closed.
 416 --
 417 --  * /block-buffering/: the entire buffer is written out whenever it
 418 --    overflows, a 'System.IO.hFlush' is issued, or the handle is closed.
 419 --
 420 --  * /no-buffering/: output is written immediately, and never stored
 421 --    in the buffer.
 422 --
 423 -- An implementation is free to flush the buffer more frequently,
 424 -- but not less frequently, than specified above.
 425 -- The output buffer is emptied as soon as it has been written out.
 426 --
 427 -- Similarly, input occurs according to the buffer mode for the handle:
 428 --
 429 --  * /line-buffering/: when the buffer for the handle is not empty,
 430 --    the next item is obtained from the buffer; otherwise, when the
 431 --    buffer is empty, characters up to and including the next newline
 432 --    character are read into the buffer.  No characters are available
 433 --    until the newline character is available or the buffer is full.
 434 --
 435 --  * /block-buffering/: when the buffer for the handle becomes empty,
 436 --    the next block of data is read into the buffer.
 437 --
 438 --  * /no-buffering/: the next input item is read and returned.
 439 --    The 'System.IO.hLookAhead' operation implies that even a no-buffered
 440 --    handle may require a one-character buffer.
 441 --
 442 -- The default buffering mode when a handle is opened is
 443 -- implementation-dependent and may depend on the file system object
 444 -- which is attached to that handle.
 445 -- For most implementations, physical files will normally be block-buffered
 446 -- and terminals will normally be line-buffered.
 447
 448 data BufferMode
 449  = NoBuffering  -- ^ buffering is disabled if possible.
 450  | LineBuffering
 451                 -- ^ line-buffering should be enabled if possible.
 452  | BlockBuffering (Maybe Int)
 453                 -- ^ block-buffering should be enabled if possible.
 454                 -- The size of the buffer is @n@ items if the argument
 455                 -- is 'Just' @n@ and is otherwise implementation-dependent.
 456    deriving (Eq, Ord, Read, Show)
 457
 458 -- ---------------------------------------------------------------------------
 459 -- IORefs
 460
 461 -- |A mutable variable in the 'IO' monad
 462 newtype IORef a = IORef (STRef RealWorld a)
 463
 464 -- explicit instance because Haddock can't figure out a derived one
 465 instance Eq (IORef a) where
 466   IORef x == IORef y = x == y
 467
 468 -- |Build a new 'IORef'
 469 newIORef    :: a -> IO (IORef a)
 470 newIORef v = stToIO (newSTRef v) >>= \ var -> return (IORef var)
 471
 472 -- |Read the value of an 'IORef'
 473 readIORef   :: IORef a -> IO a
 474 readIORef  (IORef var) = stToIO (readSTRef var)
 475
 476 -- |Write a new value into an 'IORef'
 477 writeIORef  :: IORef a -> a -> IO ()
 478 writeIORef (IORef var) v = stToIO (writeSTRef var v)
 479
 480 -- ---------------------------------------------------------------------------
 481 -- | An 'IOArray' is a mutable, boxed, non-strict array in the 'IO' monad.
 482 -- The type arguments are as follows:
 483 --
 484 --  * @i@: the index type of the array (should be an instance of 'Ix')
 485 --
 486 --  * @e@: the element type of the array.
 487 --
 488 --
 489
 490 newtype IOArray i e = IOArray (STArray RealWorld i e)
 491
 492 -- explicit instance because Haddock can't figure out a derived one
 493 instance Eq (IOArray i e) where
 494   IOArray x == IOArray y = x == y
 495
 496 -- |Build a new 'IOArray'
 497 newIOArray :: Ix i => (i,i) -> e -> IO (IOArray i e)
 498 {-# INLINE newIOArray #-}
 499 newIOArray lu init  = stToIO $ do {marr <- newSTArray lu init; return (IOArray marr)}
 500
 501 -- | Read a value from an 'IOArray'
 502 unsafeReadIOArray  :: Ix i => IOArray i e -> Int -> IO e
 503 {-# INLINE unsafeReadIOArray #-}
 504 unsafeReadIOArray (IOArray marr) i = stToIO (unsafeReadSTArray marr i)
 505
 506 -- | Write a new value into an 'IOArray'
 507 unsafeWriteIOArray :: Ix i => IOArray i e -> Int -> e -> IO ()
 508 {-# INLINE unsafeWriteIOArray #-}
 509 unsafeWriteIOArray (IOArray marr) i e = stToIO (unsafeWriteSTArray marr i e)
 510
 511 -- | Read a value from an 'IOArray'
 512 readIOArray  :: Ix i => IOArray i e -> i -> IO e
 513 readIOArray (IOArray marr) i = stToIO (readSTArray marr i)
 514
 515 -- | Write a new value into an 'IOArray'
 516 writeIOArray :: Ix i => IOArray i e -> i -> e -> IO ()
 517 writeIOArray (IOArray marr) i e = stToIO (writeSTArray marr i e)
 518
 519
 520 -- ---------------------------------------------------------------------------
 521 -- Show instance for Handles
 522
 523 -- handle types are 'show'n when printing error msgs, so
 524 -- we provide a more user-friendly Show instance for it
 525 -- than the derived one.
 526
 527 instance Show HandleType where
 528   showsPrec p t =
 529     case t of
 530       ClosedHandle      -> showString "closed"
 531       SemiClosedHandle  -> showString "semi-closed"
 532       ReadHandle        -> showString "readable"
 533       WriteHandle       -> showString "writable"
 534       AppendHandle      -> showString "writable (append)"
 535       ReadWriteHandle   -> showString "read-writable"
 536
 537 instance Show Handle where
 538   showsPrec p (FileHandle   file _)   = showHandle file
 539   showsPrec p (DuplexHandle file _ _) = showHandle file
 540
 541 showHandle file = showString "{handle: " . showString file . showString "}"
 542
 543 -- ------------------------------------------------------------------------
 544 -- Exception datatype and operations
 545
 546 -- |The type of exceptions.  Every kind of system-generated exception
 547 -- has a constructor in the 'Exception' type, and values of other
 548 -- types may be injected into 'Exception' by coercing them to
 549 -- 'Data.Dynamic.Dynamic' (see the section on Dynamic Exceptions:
 550 -- "Control.Exception\#DynamicExceptions").
 551 data Exception
 552   = ArithException      ArithException
 553         -- ^Exceptions raised by arithmetic
 554         -- operations.  (NOTE: GHC currently does not throw
 555         -- 'ArithException's except for 'DivideByZero').
 556   | ArrayException      ArrayException
 557         -- ^Exceptions raised by array-related
 558         -- operations.  (NOTE: GHC currently does not throw
 559         -- 'ArrayException's).
 560   | AssertionFailed     String
 561         -- ^This exception is thrown by the
 562         -- 'assert' operation when the condition
 563         -- fails.  The 'String' argument contains the
 564         -- location of the assertion in the source program.
 565   | AsyncException      AsyncException
 566         -- ^Asynchronous exceptions (see section on Asynchronous Exceptions: "Control.Exception\#AsynchronousExceptions").
 567   | BlockedOnDeadMVar
 568         -- ^The current thread was executing a call to
 569         -- 'Control.Concurrent.MVar.takeMVar' that could never return,
 570         -- because there are no other references to this 'MVar'.
 571   | Deadlock
 572         -- ^There are no runnable threads, so the program is
 573         -- deadlocked.  The 'Deadlock' exception is
 574         -- raised in the main thread only (see also: "Control.Concurrent").
 575   | DynException        Dynamic
 576         -- ^Dynamically typed exceptions (see section on Dynamic Exceptions: "Control.Exception\#DynamicExceptions").
 577   | ErrorCall           String
 578         -- ^The 'ErrorCall' exception is thrown by 'error'.  The 'String'
 579         -- argument of 'ErrorCall' is the string passed to 'error' when it was
 580         -- called.
 581   | ExitException       ExitCode
 582         -- ^The 'ExitException' exception is thrown by 'System.Exit.exitWith' (and
 583         -- 'System.Exit.exitFailure').  The 'ExitCode' argument is the value passed
 584         -- to 'System.Exit.exitWith'.  An unhandled 'ExitException' exception in the
 585         -- main thread will cause the program to be terminated with the given
 586         -- exit code.
 587   | IOException         IOException
 588         -- ^These are the standard IO exceptions generated by
 589         -- Haskell\'s @IO@ operations.  See also "System.IO.Error".
 590   | NoMethodError       String
 591         -- ^An attempt was made to invoke a class method which has
 592         -- no definition in this instance, and there was no default
 593         -- definition given in the class declaration.  GHC issues a
 594         -- warning when you compile an instance which has missing
 595         -- methods.
 596   | NonTermination
 597         -- ^The current thread is stuck in an infinite loop.  This
 598         -- exception may or may not be thrown when the program is
 599         -- non-terminating.
 600   | PatternMatchFail    String
 601         -- ^A pattern matching failure.  The 'String' argument should contain a
 602         -- descriptive message including the function name, source file
 603         -- and line number.
 604   | RecConError         String
 605         -- ^An attempt was made to evaluate a field of a record
 606         -- for which no value was given at construction time.  The
 607         -- 'String' argument gives the location of the
 608         -- record construction in the source program.
 609   | RecSelError         String
 610         -- ^A field selection was attempted on a constructor that
 611         -- doesn\'t have the requested field.  This can happen with
 612         -- multi-constructor records when one or more fields are
 613         -- missing from some of the constructors.  The
 614         -- 'String' argument gives the location of the
 615         -- record selection in the source program.
 616   | RecUpdError         String
 617         -- ^An attempt was made to update a field in a record,
 618         -- where the record doesn\'t have the requested field.  This can
 619         -- only occur with multi-constructor records, when one or more
 620         -- fields are missing from some of the constructors.  The
 621         -- 'String' argument gives the location of the
 622         -- record update in the source program.
 623
 624 -- |The type of arithmetic exceptions
 625 data ArithException
 626   = Overflow
 627   | Underflow
 628   | LossOfPrecision
 629   | DivideByZero
 630   | Denormal
 631   deriving (Eq, Ord)
 632
 633
 634 -- |Asynchronous exceptions
 635 data AsyncException
 636   = StackOverflow
 637         -- ^The current thread\'s stack exceeded its limit.
 638         -- Since an exception has been raised, the thread\'s stack
 639         -- will certainly be below its limit again, but the
 640         -- programmer should take remedial action
 641         -- immediately.
 642   | HeapOverflow
 643         -- ^The program\'s heap is reaching its limit, and
 644         -- the program should take action to reduce the amount of
 645         -- live data it has. Notes:
 646         --
 647         --      * It is undefined which thread receives this exception.
 648         --
 649         --      * GHC currently does not throw 'HeapOverflow' exceptions.
 650   | ThreadKilled
 651         -- ^This exception is raised by another thread
 652         -- calling 'Control.Concurrent.killThread', or by the system
 653         -- if it needs to terminate the thread for some
 654         -- reason.
 655   deriving (Eq, Ord)
 656
 657 -- | Exceptions generated by array operations
 658 data ArrayException
 659   = IndexOutOfBounds    String
 660         -- ^An attempt was made to index an array outside
 661         -- its declared bounds.
 662   | UndefinedElement    String
 663         -- ^An attempt was made to evaluate an element of an
 664         -- array that had not been initialized.
 665   deriving (Eq, Ord)
 666
 667 stackOverflow, heapOverflow :: Exception -- for the RTS
 668 stackOverflow = AsyncException StackOverflow
 669 heapOverflow  = AsyncException HeapOverflow
 670
 671 instance Show ArithException where
 672   showsPrec _ Overflow        = showString "arithmetic overflow"
 673   showsPrec _ Underflow       = showString "arithmetic underflow"
 674   showsPrec _ LossOfPrecision = showString "loss of precision"
 675   showsPrec _ DivideByZero    = showString "divide by zero"
 676   showsPrec _ Denormal        = showString "denormal"
 677
 678 instance Show AsyncException where
 679   showsPrec _ StackOverflow   = showString "stack overflow"
 680   showsPrec _ HeapOverflow    = showString "heap overflow"
 681   showsPrec _ ThreadKilled    = showString "thread killed"
 682
 683 instance Show ArrayException where
 684   showsPrec _ (IndexOutOfBounds s)
 685         = showString "array index out of range"
 686         . (if not (null s) then showString ": " . showString s
 687                            else id)
 688   showsPrec _ (UndefinedElement s)
 689         = showString "undefined array element"
 690         . (if not (null s) then showString ": " . showString s
 691                            else id)
 692
 693 instance Show Exception where
 694   showsPrec _ (IOException err)          = shows err
 695   showsPrec _ (ArithException err)       = shows err
 696   showsPrec _ (ArrayException err)       = shows err
 697   showsPrec _ (ErrorCall err)            = showString err
 698   showsPrec _ (ExitException err)        = showString "exit: " . shows err
 699   showsPrec _ (NoMethodError err)        = showString err
 700   showsPrec _ (PatternMatchFail err)     = showString err
 701   showsPrec _ (RecSelError err)          = showString err
 702   showsPrec _ (RecConError err)          = showString err
 703   showsPrec _ (RecUpdError err)          = showString err
 704   showsPrec _ (AssertionFailed err)      = showString err
 705   showsPrec _ (DynException _err)        = showString "unknown exception"
 706   showsPrec _ (AsyncException e)         = shows e
 707   showsPrec _ (BlockedOnDeadMVar)        = showString "thread blocked indefinitely"
 708   showsPrec _ (NonTermination)           = showString "<<loop>>"
 709   showsPrec _ (Deadlock)                 = showString "<<deadlock>>"
 710
 711 instance Eq Exception where
 712   IOException e1      == IOException e2      = e1 == e2
 713   ArithException e1   == ArithException e2   = e1 == e2
 714   ArrayException e1   == ArrayException e2   = e1 == e2
 715   ErrorCall e1        == ErrorCall e2        = e1 == e2
 716   ExitException e1    == ExitException e2    = e1 == e2
 717   NoMethodError e1    == NoMethodError e2    = e1 == e2
 718   PatternMatchFail e1 == PatternMatchFail e2 = e1 == e2
 719   RecSelError e1      == RecSelError e2      = e1 == e2
 720   RecConError e1      == RecConError e2      = e1 == e2
 721   RecUpdError e1      == RecUpdError e2      = e1 == e2
 722   AssertionFailed e1  == AssertionFailed e2  = e1 == e2
 723   DynException _      == DynException _      = False -- incomparable
 724   AsyncException e1   == AsyncException e2   = e1 == e2
 725   BlockedOnDeadMVar   == BlockedOnDeadMVar   = True
 726   NonTermination      == NonTermination      = True
 727   Deadlock            == Deadlock            = True
 728   _                   == _                   = False
 729
 730 -- -----------------------------------------------------------------------------
 731 -- The ExitCode type
 732
 733 -- We need it here because it is used in ExitException in the
 734 -- Exception datatype (above).
 735
 736 data ExitCode
 737   = ExitSuccess -- ^ indicates successful termination;
 738   | ExitFailure Int
 739                 -- ^ indicates program failure with an exit code.
 740                 -- The exact interpretation of the code is
 741                 -- operating-system dependent.  In particular, some values
 742                 -- may be prohibited (e.g. 0 on a POSIX-compliant system).
 743   deriving (Eq, Ord, Read, Show)
 744
 745 -- --------------------------------------------------------------------------
 746 -- Primitive throw
 747
 748 -- | Throw an exception.  Exceptions may be thrown from purely
 749 -- functional code, but may only be caught within the 'IO' monad.
 750 throw :: Exception -> a
 751 throw exception = raise# exception
 752
 753 -- | A variant of 'throw' that can be used within the 'IO' monad.
 754 --
 755 -- Although 'throwIO' has a type that is an instance of the type of 'throw', the
 756 -- two functions are subtly different:
 757 --
 758 -- > throw e   `seq` return ()  ===> throw e
 759 -- > throwIO e `seq` return ()  ===> return ()
 760 --
 761 -- The first example will cause the exception @e@ to be raised,
 762 -- whereas the second one won\'t.  In fact, 'throwIO' will only cause
 763 -- an exception to be raised when it is used within the 'IO' monad.
 764 -- The 'throwIO' variant should be used in preference to 'throw' to
 765 -- raise an exception within the 'IO' monad because it guarantees
 766 -- ordering with respect to other 'IO' operations, whereas 'throw'
 767 -- does not.
 768 throwIO         :: Exception -> IO a
 769 throwIO err     =  IO $ raiseIO# err
 770
 771 ioException     :: IOException -> IO a
 772 ioException err =  IO $ raiseIO# (IOException err)
 773
 774 -- | Raise an 'IOError' in the 'IO' monad.
 775 ioError         :: IOError -> IO a
 776 ioError         =  ioException
 777
 778 -- ---------------------------------------------------------------------------
 779 -- IOError type
 780
 781 -- | The Haskell 98 type for exceptions in the 'IO' monad.
 782 -- Any I\/O operation may raise an 'IOError' instead of returning a result.
 783 -- For a more general type of exception, including also those that arise
 784 -- in pure code, see 'Control.Exception.Exception'.
 785 --
 786 -- In Haskell 98, this is an opaque type.
 787 type IOError = IOException
 788
 789 -- |Exceptions that occur in the @IO@ monad.
 790 -- An @IOException@ records a more specific error type, a descriptive
 791 -- string and maybe the handle that was used when the error was
 792 -- flagged.
 793 data IOException
 794  = IOError {
 795      ioe_handle   :: Maybe Handle,   -- the handle used by the action flagging
 796                                      -- the error.
 797      ioe_type     :: IOErrorType,    -- what it was.
 798      ioe_location :: String,         -- location.
 799      ioe_description :: String,      -- error type specific information.
 800      ioe_filename :: Maybe FilePath  -- filename the error is related to.
 801    }
 802
 803 instance Eq IOException where
 804   (IOError h1 e1 loc1 str1 fn1) == (IOError h2 e2 loc2 str2 fn2) =
 805     e1==e2 && str1==str2 && h1==h2 && loc1==loc2 && fn1==fn2
 806
 807 -- | An abstract type that contains a value for each variant of 'IOError'.
 808 data IOErrorType
 809   -- Haskell 98:
 810   = AlreadyExists
 811   | NoSuchThing
 812   | ResourceBusy
 813   | ResourceExhausted
 814   | EOF
 815   | IllegalOperation
 816   | PermissionDenied
 817   | UserError
 818   -- GHC only:
 819   | UnsatisfiedConstraints
 820   | SystemError
 821   | ProtocolError
 822   | OtherError
 823   | InvalidArgument
 824   | InappropriateType
 825   | HardwareFault
 826   | UnsupportedOperation
 827   | TimeExpired
 828   | ResourceVanished
 829   | Interrupted
 830   | DynIOError Dynamic -- cheap&cheerful extensible IO error type.
 831
 832 instance Eq IOErrorType where
 833    x == y =
 834      case x of
 835        DynIOError{} -> False -- from a strictness POV, compatible with a derived Eq inst?
 836        _ -> getTag x ==# getTag y
 837
 838 instance Show IOErrorType where
 839   showsPrec _ e =
 840     showString $
 841     case e of
 842       AlreadyExists     -> "already exists"
 843       NoSuchThing       -> "does not exist"
 844       ResourceBusy      -> "resource busy"
 845       ResourceExhausted -> "resource exhausted"
 846       EOF               -> "end of file"
 847       IllegalOperation  -> "illegal operation"
 848       PermissionDenied  -> "permission denied"
 849       UserError         -> "user error"
 850       HardwareFault     -> "hardware fault"
 851       InappropriateType -> "inappropriate type"
 852       Interrupted       -> "interrupted"
 853       InvalidArgument   -> "invalid argument"
 854       OtherError        -> "failed"
 855       ProtocolError     -> "protocol error"
 856       ResourceVanished  -> "resource vanished"
 857       SystemError       -> "system error"
 858       TimeExpired       -> "timeout"
 859       UnsatisfiedConstraints -> "unsatisified constraints" -- ultra-precise!
 860       UnsupportedOperation -> "unsupported operation"
 861       DynIOError{}      -> "unknown IO error"
 862
 863 -- | Construct an 'IOError' value with a string describing the error.
 864 -- The 'fail' method of the 'IO' instance of the 'Monad' class raises a
 865 -- 'userError', thus:
 866 --
 867 -- > instance Monad IO where
 868 -- >   ...
 869 -- >   fail s = ioError (userError s)
 870 --
 871 userError       :: String  -> IOError
 872 userError str   =  IOError Nothing UserError "" str Nothing
 873
 874 -- ---------------------------------------------------------------------------
 875 -- Showing IOErrors
 876
 877 instance Show IOException where
 878     showsPrec p (IOError hdl iot loc s fn) =
 879       (case fn of
 880          Nothing -> case hdl of
 881                         Nothing -> id
 882                         Just h  -> showsPrec p h . showString ": "
 883          Just name -> showString name . showString ": ") .
 884       (case loc of
 885          "" -> id
 886          _  -> showString loc . showString ": ") .
 887       showsPrec p iot .
 888       (case s of
 889          "" -> id
 890          _  -> showString " (" . showString s . showString ")")
 891
 892 -- -----------------------------------------------------------------------------
 893 -- IOMode type
 894
 895 data IOMode      =  ReadMode | WriteMode | AppendMode | ReadWriteMode
 896                     deriving (Eq, Ord, Ix, Enum, Read, Show)
 897 \end{code}