2 {-# OPTIONS_GHC -fno-implicit-prelude #-}
3 -----------------------------------------------------------------------------
6 -- Copyright : (c) The University of Glasgow 1994-2002
7 -- License : see libraries/base/LICENSE
9 -- Maintainer : cvs-ghc@haskell.org
10 -- Stability : internal
11 -- Portability : non-portable (GHC Extensions)
13 -- Definitions for the 'IO' monad and its friends.
15 -----------------------------------------------------------------------------
19 IO(..), unIO, failIO, liftIO, bindIO, thenIO, returnIO,
20 unsafePerformIO, unsafeInterleaveIO,
22 -- To and from from ST
23 stToIO, ioToST, unsafeIOToST,
26 IORef(..), newIORef, readIORef, writeIORef,
27 IOArray(..), newIOArray, readIOArray, writeIOArray, unsafeReadIOArray, unsafeWriteIOArray,
30 -- Handles, file descriptors,
32 Handle(..), Handle__(..), HandleType(..), IOMode(..), FD,
33 isReadableHandleType, isWritableHandleType, isReadWriteHandleType, showHandle,
36 Buffer(..), RawBuffer, BufferState(..), BufferList(..), BufferMode(..),
37 bufferIsWritable, bufferEmpty, bufferFull,
40 Exception(..), ArithException(..), AsyncException(..), ArrayException(..),
41 stackOverflow, heapOverflow, throw, throwIO, ioException,
42 IOError, IOException(..), IOErrorType(..), ioError, userError,
47 import GHC.Arr -- to derive Ix class
48 import GHC.Enum -- to derive Enum class
51 -- import GHC.Num -- To get fromInteger etc, needed because of -fno-implicit-prelude
52 import Data.Maybe ( Maybe(..) )
58 import {-# SOURCE #-} Data.Dynamic
61 -- ---------------------------------------------------------------------------
65 The IO Monad is just an instance of the ST monad, where the state is
66 the real world. We use the exception mechanism (in GHC.Exception) to
67 implement IO exceptions.
69 NOTE: The IO representation is deeply wired in to various parts of the
70 system. The following list may or may not be exhaustive:
72 Compiler - types of various primitives in PrimOp.lhs
74 RTS - forceIO (StgMiscClosures.hc)
75 - catchzh_fast, (un)?blockAsyncExceptionszh_fast, raisezh_fast
77 - raiseAsync (Schedule.c)
79 Prelude - GHC.IOBase.lhs, and several other places including
82 Libraries - parts of hslibs/lang.
88 A value of type @'IO' a@ is a computation which, when performed,
89 does some I\/O before returning a value of type @a@.
91 There is really only one way to \"perform\" an I\/O action: bind it to
92 @Main.main@ in your program. When your program is run, the I\/O will
93 be performed. It isn't possible to perform I\/O from an arbitrary
94 function, unless that function is itself in the 'IO' monad and called
95 at some point, directly or indirectly, from @Main.main@.
97 'IO' is a monad, so 'IO' actions can be combined using either the do-notation
98 or the '>>' and '>>=' operations from the 'Monad' class.
100 newtype IO a = IO (State# RealWorld -> (# State# RealWorld, a #))
102 unIO :: IO a -> (State# RealWorld -> (# State# RealWorld, a #))
105 instance Functor IO where
106 fmap f x = x >>= (return . f)
108 instance Monad IO where
109 {-# INLINE return #-}
112 m >> k = m >>= \ _ -> k
113 return x = returnIO x
118 failIO :: String -> IO a
119 failIO s = ioError (userError s)
121 liftIO :: IO a -> State# RealWorld -> STret RealWorld a
122 liftIO (IO m) = \s -> case m s of (# s', r #) -> STret s' r
124 bindIO :: IO a -> (a -> IO b) -> IO b
125 bindIO (IO m) k = IO ( \ s ->
127 (# new_s, a #) -> unIO (k a) new_s
130 thenIO :: IO a -> IO b -> IO b
131 thenIO (IO m) k = IO ( \ s ->
133 (# new_s, a #) -> unIO k new_s
136 returnIO :: a -> IO a
137 returnIO x = IO (\ s -> (# s, x #))
139 -- ---------------------------------------------------------------------------
140 -- Coercions between IO and ST
142 -- | A monad transformer embedding strict state transformers in the 'IO'
143 -- monad. The 'RealWorld' parameter indicates that the internal state
144 -- used by the 'ST' computation is a special one supplied by the 'IO'
145 -- monad, and thus distinct from those used by invocations of 'runST'.
146 stToIO :: ST RealWorld a -> IO a
149 ioToST :: IO a -> ST RealWorld a
150 ioToST (IO m) = (ST m)
152 -- This relies on IO and ST having the same representation modulo the
153 -- constraint on the type of the state
155 unsafeIOToST :: IO a -> ST s a
156 unsafeIOToST (IO io) = ST $ \ s -> (unsafeCoerce# io) s
158 -- ---------------------------------------------------------------------------
159 -- Unsafe IO operations
162 This is the \"back door\" into the 'IO' monad, allowing
163 'IO' computation to be performed at any time. For
164 this to be safe, the 'IO' computation should be
165 free of side effects and independent of its environment.
167 If the I\/O computation wrapped in 'unsafePerformIO'
168 performs side effects, then the relative order in which those side
169 effects take place (relative to the main I\/O trunk, or other calls to
170 'unsafePerformIO') is indeterminate. You have to be careful when
171 writing and compiling modules that use 'unsafePerformIO':
173 * Use @{\-\# NOINLINE foo \#-\}@ as a pragma on any function @foo@
174 that calls 'unsafePerformIO'. If the call is inlined,
175 the I\/O may be performed more than once.
177 * Use the compiler flag @-fno-cse@ to prevent common sub-expression
178 elimination being performed on the module, which might combine
179 two side effects that were meant to be separate. A good example
180 is using multiple global variables (like @test@ in the example below).
182 * Make sure that the either you switch off let-floating, or that the
183 call to 'unsafePerformIO' cannot float outside a lambda. For example,
186 f x = unsafePerformIO (newIORef [])
188 you may get only one reference cell shared between all calls to @f@.
191 f x = unsafePerformIO (newIORef [x])
193 because now it can't float outside the lambda.
195 It is less well known that
196 'unsafePerformIO' is not type safe. For example:
199 > test = unsafePerformIO $ newIORef []
202 > writeIORef test [42]
203 > bang <- readIORef test
204 > print (bang :: [Char])
206 This program will core dump. This problem with polymorphic references
207 is well known in the ML community, and does not arise with normal
208 monadic use of references. There is no easy way to make it impossible
209 once you use 'unsafePerformIO'. Indeed, it is
210 possible to write @coerce :: a -> b@ with the
211 help of 'unsafePerformIO'. So be careful!
213 {-# NOINLINE unsafePerformIO #-}
214 unsafePerformIO :: IO a -> a
215 unsafePerformIO (IO m) = case m realWorld# of (# _, r #) -> r
217 -- Why do we NOINLINE unsafePerformIO? See the comment with
218 -- GHC.ST.runST. Essentially the issue is that the IO computation
219 -- inside unsafePerformIO must be atomic: it must either all run, or
220 -- not at all. If we let the compiler see the application of the IO
221 -- to realWorld#, it might float out part of the IO.
224 'unsafeInterleaveIO' allows 'IO' computation to be deferred lazily.
225 When passed a value of type @IO a@, the 'IO' will only be performed
226 when the value of the @a@ is demanded. This is used to implement lazy
227 file reading, see 'System.IO.hGetContents'.
229 {-# INLINE unsafeInterleaveIO #-}
230 unsafeInterleaveIO :: IO a -> IO a
231 unsafeInterleaveIO (IO m)
233 r = case m s of (# _, res #) -> res
237 -- We believe that INLINE on unsafeInterleaveIO is safe, because the
238 -- state from this IO thread is passed explicitly to the interleaved
239 -- IO, so it cannot be floated out and shared.
241 -- ---------------------------------------------------------------------------
244 data MVar a = MVar (MVar# RealWorld a)
246 An 'MVar' (pronounced \"em-var\") is a synchronising variable, used
247 for communication between concurrent threads. It can be thought of
248 as a a box, which may be empty or full.
251 -- pull in Eq (Mvar a) too, to avoid GHC.Conc being an orphan-instance module
252 instance Eq (MVar a) where
253 (MVar mvar1#) == (MVar mvar2#) = sameMVar# mvar1# mvar2#
255 -- A Handle is represented by (a reference to) a record
256 -- containing the state of the I/O port/device. We record
257 -- the following pieces of info:
259 -- * type (read,write,closed etc.)
260 -- * the underlying file descriptor
262 -- * buffer, and spare buffers
263 -- * user-friendly name (usually the
264 -- FilePath used when IO.openFile was called)
266 -- Note: when a Handle is garbage collected, we want to flush its buffer
267 -- and close the OS file handle, so as to free up a (precious) resource.
269 -- | Haskell defines operations to read and write characters from and to files,
270 -- represented by values of type @Handle@. Each value of this type is a
271 -- /handle/: a record used by the Haskell run-time system to /manage/ I\/O
272 -- with file system objects. A handle has at least the following properties:
274 -- * whether it manages input or output or both;
276 -- * whether it is /open/, /closed/ or /semi-closed/;
278 -- * whether the object is seekable;
280 -- * whether buffering is disabled, or enabled on a line or block basis;
282 -- * a buffer (whose length may be zero).
284 -- Most handles will also have a current I\/O position indicating where the next
285 -- input or output operation will occur. A handle is /readable/ if it
286 -- manages only input or both input and output; likewise, it is /writable/ if
287 -- it manages only output or both input and output. A handle is /open/ when
289 -- Once it is closed it can no longer be used for either input or output,
290 -- though an implementation cannot re-use its storage while references
291 -- remain to it. Handles are in the 'Show' and 'Eq' classes. The string
292 -- produced by showing a handle is system dependent; it should include
293 -- enough information to identify the handle for debugging. A handle is
294 -- equal according to '==' only to itself; no attempt
295 -- is made to compare the internal state of different handles for equality.
297 -- GHC note: a 'Handle' will be automatically closed when the garbage
298 -- collector detects that it has become unreferenced by the program.
299 -- However, relying on this behaviour is not generally recommended:
300 -- the garbage collector is unpredictable. If possible, use explicit
301 -- an explicit 'hClose' to close 'Handle's when they are no longer
302 -- required. GHC does not currently attempt to free up file
303 -- descriptors when they have run out, it is your responsibility to
304 -- ensure that this doesn't happen.
307 = FileHandle -- A normal handle to a file
308 FilePath -- the file (invariant)
311 | DuplexHandle -- A handle to a read/write stream
312 FilePath -- file for a FIFO, otherwise some
313 -- descriptive string.
314 !(MVar Handle__) -- The read side
315 !(MVar Handle__) -- The write side
318 -- * A 'FileHandle' is seekable. A 'DuplexHandle' may or may not be
321 instance Eq Handle where
322 (FileHandle _ h1) == (FileHandle _ h2) = h1 == h2
323 (DuplexHandle _ h1 _) == (DuplexHandle _ h2 _) = h1 == h2
326 type FD = Int -- XXX ToDo: should be CInt
330 haFD :: !FD, -- file descriptor
331 haType :: HandleType, -- type (read/write/append etc.)
332 haIsBin :: Bool, -- binary mode?
333 haIsStream :: Bool, -- is this a stream handle?
334 haBufferMode :: BufferMode, -- buffer contains read/write data?
335 haBuffer :: !(IORef Buffer), -- the current buffer
336 haBuffers :: !(IORef BufferList), -- spare buffers
337 haOtherSide :: Maybe (MVar Handle__) -- ptr to the write side of a
341 -- ---------------------------------------------------------------------------
344 -- The buffer is represented by a mutable variable containing a
345 -- record, where the record contains the raw buffer and the start/end
346 -- points of the filled portion. We use a mutable variable so that
347 -- the common operation of writing (or reading) some data from (to)
348 -- the buffer doesn't need to modify, and hence copy, the handle
349 -- itself, it just updates the buffer.
351 -- There will be some allocation involved in a simple hPutChar in
352 -- order to create the new Buffer structure (below), but this is
353 -- relatively small, and this only has to be done once per write
356 -- The buffer contains its size - we could also get the size by
357 -- calling sizeOfMutableByteArray# on the raw buffer, but that tends
358 -- to be rounded up to the nearest Word.
360 type RawBuffer = MutableByteArray# RealWorld
362 -- INVARIANTS on a Buffer:
364 -- * A handle *always* has a buffer, even if it is only 1 character long
365 -- (an unbuffered handle needs a 1 character buffer in order to support
366 -- hLookAhead and hIsEOF).
368 -- * if r == w, then r == 0 && w == 0
369 -- * if state == WriteBuffer, then r == 0
370 -- * a write buffer is never full. If an operation
371 -- fills up the buffer, it will always flush it before
373 -- * a read buffer may be full as a result of hLookAhead. In normal
374 -- operation, a read buffer always has at least one character of space.
382 bufState :: BufferState
385 data BufferState = ReadBuffer | WriteBuffer deriving (Eq)
387 -- we keep a few spare buffers around in a handle to avoid allocating
388 -- a new one for each hPutStr. These buffers are *guaranteed* to be the
389 -- same size as the main buffer.
392 | BufferListCons RawBuffer BufferList
395 bufferIsWritable :: Buffer -> Bool
396 bufferIsWritable Buffer{ bufState=WriteBuffer } = True
397 bufferIsWritable _other = False
399 bufferEmpty :: Buffer -> Bool
400 bufferEmpty Buffer{ bufRPtr=r, bufWPtr=w } = r == w
402 -- only makes sense for a write buffer
403 bufferFull :: Buffer -> Bool
404 bufferFull b@Buffer{ bufWPtr=w } = w >= bufSize b
406 -- Internally, we classify handles as being one
417 isReadableHandleType ReadHandle = True
418 isReadableHandleType ReadWriteHandle = True
419 isReadableHandleType _ = False
421 isWritableHandleType AppendHandle = True
422 isWritableHandleType WriteHandle = True
423 isWritableHandleType ReadWriteHandle = True
424 isWritableHandleType _ = False
426 isReadWriteHandleType ReadWriteHandle{} = True
427 isReadWriteHandleType _ = False
429 -- | File and directory names are values of type 'String', whose precise
430 -- meaning is operating system dependent. Files can be opened, yielding a
431 -- handle which can then be used to operate on the contents of that file.
433 type FilePath = String
435 -- ---------------------------------------------------------------------------
438 -- | Three kinds of buffering are supported: line-buffering,
439 -- block-buffering or no-buffering. These modes have the following
440 -- effects. For output, items are written out, or /flushed/,
441 -- from the internal buffer according to the buffer mode:
443 -- * /line-buffering/: the entire output buffer is flushed
444 -- whenever a newline is output, the buffer overflows,
445 -- a 'System.IO.hFlush' is issued, or the handle is closed.
447 -- * /block-buffering/: the entire buffer is written out whenever it
448 -- overflows, a 'System.IO.hFlush' is issued, or the handle is closed.
450 -- * /no-buffering/: output is written immediately, and never stored
453 -- An implementation is free to flush the buffer more frequently,
454 -- but not less frequently, than specified above.
455 -- The output buffer is emptied as soon as it has been written out.
457 -- Similarly, input occurs according to the buffer mode for the handle:
459 -- * /line-buffering/: when the buffer for the handle is not empty,
460 -- the next item is obtained from the buffer; otherwise, when the
461 -- buffer is empty, characters up to and including the next newline
462 -- character are read into the buffer. No characters are available
463 -- until the newline character is available or the buffer is full.
465 -- * /block-buffering/: when the buffer for the handle becomes empty,
466 -- the next block of data is read into the buffer.
468 -- * /no-buffering/: the next input item is read and returned.
469 -- The 'System.IO.hLookAhead' operation implies that even a no-buffered
470 -- handle may require a one-character buffer.
472 -- The default buffering mode when a handle is opened is
473 -- implementation-dependent and may depend on the file system object
474 -- which is attached to that handle.
475 -- For most implementations, physical files will normally be block-buffered
476 -- and terminals will normally be line-buffered.
479 = NoBuffering -- ^ buffering is disabled if possible.
481 -- ^ line-buffering should be enabled if possible.
482 | BlockBuffering (Maybe Int)
483 -- ^ block-buffering should be enabled if possible.
484 -- The size of the buffer is @n@ items if the argument
485 -- is 'Just' @n@ and is otherwise implementation-dependent.
486 deriving (Eq, Ord, Read, Show)
488 -- ---------------------------------------------------------------------------
491 -- |A mutable variable in the 'IO' monad
492 newtype IORef a = IORef (STRef RealWorld a)
494 -- explicit instance because Haddock can't figure out a derived one
495 instance Eq (IORef a) where
496 IORef x == IORef y = x == y
498 -- |Build a new 'IORef'
499 newIORef :: a -> IO (IORef a)
500 newIORef v = stToIO (newSTRef v) >>= \ var -> return (IORef var)
502 -- |Read the value of an 'IORef'
503 readIORef :: IORef a -> IO a
504 readIORef (IORef var) = stToIO (readSTRef var)
506 -- |Write a new value into an 'IORef'
507 writeIORef :: IORef a -> a -> IO ()
508 writeIORef (IORef var) v = stToIO (writeSTRef var v)
510 -- ---------------------------------------------------------------------------
511 -- | An 'IOArray' is a mutable, boxed, non-strict array in the 'IO' monad.
512 -- The type arguments are as follows:
514 -- * @i@: the index type of the array (should be an instance of 'Ix')
516 -- * @e@: the element type of the array.
520 newtype IOArray i e = IOArray (STArray RealWorld i e)
522 -- explicit instance because Haddock can't figure out a derived one
523 instance Eq (IOArray i e) where
524 IOArray x == IOArray y = x == y
526 -- |Build a new 'IOArray'
527 newIOArray :: Ix i => (i,i) -> e -> IO (IOArray i e)
528 {-# INLINE newIOArray #-}
529 newIOArray lu init = stToIO $ do {marr <- newSTArray lu init; return (IOArray marr)}
531 -- | Read a value from an 'IOArray'
532 unsafeReadIOArray :: Ix i => IOArray i e -> Int -> IO e
533 {-# INLINE unsafeReadIOArray #-}
534 unsafeReadIOArray (IOArray marr) i = stToIO (unsafeReadSTArray marr i)
536 -- | Write a new value into an 'IOArray'
537 unsafeWriteIOArray :: Ix i => IOArray i e -> Int -> e -> IO ()
538 {-# INLINE unsafeWriteIOArray #-}
539 unsafeWriteIOArray (IOArray marr) i e = stToIO (unsafeWriteSTArray marr i e)
541 -- | Read a value from an 'IOArray'
542 readIOArray :: Ix i => IOArray i e -> i -> IO e
543 readIOArray (IOArray marr) i = stToIO (readSTArray marr i)
545 -- | Write a new value into an 'IOArray'
546 writeIOArray :: Ix i => IOArray i e -> i -> e -> IO ()
547 writeIOArray (IOArray marr) i e = stToIO (writeSTArray marr i e)
550 -- ---------------------------------------------------------------------------
551 -- Show instance for Handles
553 -- handle types are 'show'n when printing error msgs, so
554 -- we provide a more user-friendly Show instance for it
555 -- than the derived one.
557 instance Show HandleType where
560 ClosedHandle -> showString "closed"
561 SemiClosedHandle -> showString "semi-closed"
562 ReadHandle -> showString "readable"
563 WriteHandle -> showString "writable"
564 AppendHandle -> showString "writable (append)"
565 ReadWriteHandle -> showString "read-writable"
567 instance Show Handle where
568 showsPrec p (FileHandle file _) = showHandle file
569 showsPrec p (DuplexHandle file _ _) = showHandle file
571 showHandle file = showString "{handle: " . showString file . showString "}"
573 -- ------------------------------------------------------------------------
574 -- Exception datatype and operations
576 -- |The type of exceptions. Every kind of system-generated exception
577 -- has a constructor in the 'Exception' type, and values of other
578 -- types may be injected into 'Exception' by coercing them to
579 -- 'Data.Dynamic.Dynamic' (see the section on Dynamic Exceptions:
580 -- "Control.Exception\#DynamicExceptions").
582 = ArithException ArithException
583 -- ^Exceptions raised by arithmetic
584 -- operations. (NOTE: GHC currently does not throw
585 -- 'ArithException's except for 'DivideByZero').
586 | ArrayException ArrayException
587 -- ^Exceptions raised by array-related
588 -- operations. (NOTE: GHC currently does not throw
589 -- 'ArrayException's).
590 | AssertionFailed String
591 -- ^This exception is thrown by the
592 -- 'assert' operation when the condition
593 -- fails. The 'String' argument contains the
594 -- location of the assertion in the source program.
595 | AsyncException AsyncException
596 -- ^Asynchronous exceptions (see section on Asynchronous Exceptions: "Control.Exception\#AsynchronousExceptions").
598 -- ^The current thread was executing a call to
599 -- 'Control.Concurrent.MVar.takeMVar' that could never return,
600 -- because there are no other references to this 'MVar'.
601 | BlockedIndefinitely
602 -- ^The current thread was waiting to retry an atomic memory transaction
603 -- that could never become possible to complete because there are no other
604 -- threads referring to any of teh TVars involved.
606 -- ^There are no runnable threads, so the program is
607 -- deadlocked. The 'Deadlock' exception is
608 -- raised in the main thread only (see also: "Control.Concurrent").
609 | DynException Dynamic
610 -- ^Dynamically typed exceptions (see section on Dynamic Exceptions: "Control.Exception\#DynamicExceptions").
612 -- ^The 'ErrorCall' exception is thrown by 'error'. The 'String'
613 -- argument of 'ErrorCall' is the string passed to 'error' when it was
615 | ExitException ExitCode
616 -- ^The 'ExitException' exception is thrown by 'System.Exit.exitWith' (and
617 -- 'System.Exit.exitFailure'). The 'ExitCode' argument is the value passed
618 -- to 'System.Exit.exitWith'. An unhandled 'ExitException' exception in the
619 -- main thread will cause the program to be terminated with the given
621 | IOException IOException
622 -- ^These are the standard IO exceptions generated by
623 -- Haskell\'s @IO@ operations. See also "System.IO.Error".
624 | NoMethodError String
625 -- ^An attempt was made to invoke a class method which has
626 -- no definition in this instance, and there was no default
627 -- definition given in the class declaration. GHC issues a
628 -- warning when you compile an instance which has missing
631 -- ^The current thread is stuck in an infinite loop. This
632 -- exception may or may not be thrown when the program is
634 | PatternMatchFail String
635 -- ^A pattern matching failure. The 'String' argument should contain a
636 -- descriptive message including the function name, source file
639 -- ^An attempt was made to evaluate a field of a record
640 -- for which no value was given at construction time. The
641 -- 'String' argument gives the location of the
642 -- record construction in the source program.
644 -- ^A field selection was attempted on a constructor that
645 -- doesn\'t have the requested field. This can happen with
646 -- multi-constructor records when one or more fields are
647 -- missing from some of the constructors. The
648 -- 'String' argument gives the location of the
649 -- record selection in the source program.
651 -- ^An attempt was made to update a field in a record,
652 -- where the record doesn\'t have the requested field. This can
653 -- only occur with multi-constructor records, when one or more
654 -- fields are missing from some of the constructors. The
655 -- 'String' argument gives the location of the
656 -- record update in the source program.
658 -- |The type of arithmetic exceptions
668 -- |Asynchronous exceptions
671 -- ^The current thread\'s stack exceeded its limit.
672 -- Since an exception has been raised, the thread\'s stack
673 -- will certainly be below its limit again, but the
674 -- programmer should take remedial action
677 -- ^The program\'s heap is reaching its limit, and
678 -- the program should take action to reduce the amount of
679 -- live data it has. Notes:
681 -- * It is undefined which thread receives this exception.
683 -- * GHC currently does not throw 'HeapOverflow' exceptions.
685 -- ^This exception is raised by another thread
686 -- calling 'Control.Concurrent.killThread', or by the system
687 -- if it needs to terminate the thread for some
691 -- | Exceptions generated by array operations
693 = IndexOutOfBounds String
694 -- ^An attempt was made to index an array outside
695 -- its declared bounds.
696 | UndefinedElement String
697 -- ^An attempt was made to evaluate an element of an
698 -- array that had not been initialized.
701 stackOverflow, heapOverflow :: Exception -- for the RTS
702 stackOverflow = AsyncException StackOverflow
703 heapOverflow = AsyncException HeapOverflow
705 instance Show ArithException where
706 showsPrec _ Overflow = showString "arithmetic overflow"
707 showsPrec _ Underflow = showString "arithmetic underflow"
708 showsPrec _ LossOfPrecision = showString "loss of precision"
709 showsPrec _ DivideByZero = showString "divide by zero"
710 showsPrec _ Denormal = showString "denormal"
712 instance Show AsyncException where
713 showsPrec _ StackOverflow = showString "stack overflow"
714 showsPrec _ HeapOverflow = showString "heap overflow"
715 showsPrec _ ThreadKilled = showString "thread killed"
717 instance Show ArrayException where
718 showsPrec _ (IndexOutOfBounds s)
719 = showString "array index out of range"
720 . (if not (null s) then showString ": " . showString s
722 showsPrec _ (UndefinedElement s)
723 = showString "undefined array element"
724 . (if not (null s) then showString ": " . showString s
727 instance Show Exception where
728 showsPrec _ (IOException err) = shows err
729 showsPrec _ (ArithException err) = shows err
730 showsPrec _ (ArrayException err) = shows err
731 showsPrec _ (ErrorCall err) = showString err
732 showsPrec _ (ExitException err) = showString "exit: " . shows err
733 showsPrec _ (NoMethodError err) = showString err
734 showsPrec _ (PatternMatchFail err) = showString err
735 showsPrec _ (RecSelError err) = showString err
736 showsPrec _ (RecConError err) = showString err
737 showsPrec _ (RecUpdError err) = showString err
738 showsPrec _ (AssertionFailed err) = showString err
739 showsPrec _ (DynException _err) = showString "unknown exception"
740 showsPrec _ (AsyncException e) = shows e
741 showsPrec _ (BlockedOnDeadMVar) = showString "thread blocked indefinitely"
742 showsPrec _ (BlockedIndefinitely) = showString "thread blocked indefinitely"
743 showsPrec _ (NonTermination) = showString "<<loop>>"
744 showsPrec _ (Deadlock) = showString "<<deadlock>>"
746 instance Eq Exception where
747 IOException e1 == IOException e2 = e1 == e2
748 ArithException e1 == ArithException e2 = e1 == e2
749 ArrayException e1 == ArrayException e2 = e1 == e2
750 ErrorCall e1 == ErrorCall e2 = e1 == e2
751 ExitException e1 == ExitException e2 = e1 == e2
752 NoMethodError e1 == NoMethodError e2 = e1 == e2
753 PatternMatchFail e1 == PatternMatchFail e2 = e1 == e2
754 RecSelError e1 == RecSelError e2 = e1 == e2
755 RecConError e1 == RecConError e2 = e1 == e2
756 RecUpdError e1 == RecUpdError e2 = e1 == e2
757 AssertionFailed e1 == AssertionFailed e2 = e1 == e2
758 DynException _ == DynException _ = False -- incomparable
759 AsyncException e1 == AsyncException e2 = e1 == e2
760 BlockedOnDeadMVar == BlockedOnDeadMVar = True
761 NonTermination == NonTermination = True
762 Deadlock == Deadlock = True
765 -- -----------------------------------------------------------------------------
768 -- We need it here because it is used in ExitException in the
769 -- Exception datatype (above).
772 = ExitSuccess -- ^ indicates successful termination;
774 -- ^ indicates program failure with an exit code.
775 -- The exact interpretation of the code is
776 -- operating-system dependent. In particular, some values
777 -- may be prohibited (e.g. 0 on a POSIX-compliant system).
778 deriving (Eq, Ord, Read, Show)
780 -- --------------------------------------------------------------------------
783 -- | Throw an exception. Exceptions may be thrown from purely
784 -- functional code, but may only be caught within the 'IO' monad.
785 throw :: Exception -> a
786 throw exception = raise# exception
788 -- | A variant of 'throw' that can be used within the 'IO' monad.
790 -- Although 'throwIO' has a type that is an instance of the type of 'throw', the
791 -- two functions are subtly different:
793 -- > throw e `seq` return () ===> throw e
794 -- > throwIO e `seq` return () ===> return ()
796 -- The first example will cause the exception @e@ to be raised,
797 -- whereas the second one won\'t. In fact, 'throwIO' will only cause
798 -- an exception to be raised when it is used within the 'IO' monad.
799 -- The 'throwIO' variant should be used in preference to 'throw' to
800 -- raise an exception within the 'IO' monad because it guarantees
801 -- ordering with respect to other 'IO' operations, whereas 'throw'
803 throwIO :: Exception -> IO a
804 throwIO err = IO $ raiseIO# err
806 ioException :: IOException -> IO a
807 ioException err = IO $ raiseIO# (IOException err)
809 -- | Raise an 'IOError' in the 'IO' monad.
810 ioError :: IOError -> IO a
811 ioError = ioException
813 -- ---------------------------------------------------------------------------
816 -- | The Haskell 98 type for exceptions in the 'IO' monad.
817 -- Any I\/O operation may raise an 'IOError' instead of returning a result.
818 -- For a more general type of exception, including also those that arise
819 -- in pure code, see 'Control.Exception.Exception'.
821 -- In Haskell 98, this is an opaque type.
822 type IOError = IOException
824 -- |Exceptions that occur in the @IO@ monad.
825 -- An @IOException@ records a more specific error type, a descriptive
826 -- string and maybe the handle that was used when the error was
830 ioe_handle :: Maybe Handle, -- the handle used by the action flagging
832 ioe_type :: IOErrorType, -- what it was.
833 ioe_location :: String, -- location.
834 ioe_description :: String, -- error type specific information.
835 ioe_filename :: Maybe FilePath -- filename the error is related to.
838 instance Eq IOException where
839 (IOError h1 e1 loc1 str1 fn1) == (IOError h2 e2 loc2 str2 fn2) =
840 e1==e2 && str1==str2 && h1==h2 && loc1==loc2 && fn1==fn2
842 -- | An abstract type that contains a value for each variant of 'IOError'.
854 | UnsatisfiedConstraints
861 | UnsupportedOperation
865 | DynIOError Dynamic -- cheap&cheerful extensible IO error type.
867 instance Eq IOErrorType where
870 DynIOError{} -> False -- from a strictness POV, compatible with a derived Eq inst?
871 _ -> getTag x ==# getTag y
873 instance Show IOErrorType where
877 AlreadyExists -> "already exists"
878 NoSuchThing -> "does not exist"
879 ResourceBusy -> "resource busy"
880 ResourceExhausted -> "resource exhausted"
882 IllegalOperation -> "illegal operation"
883 PermissionDenied -> "permission denied"
884 UserError -> "user error"
885 HardwareFault -> "hardware fault"
886 InappropriateType -> "inappropriate type"
887 Interrupted -> "interrupted"
888 InvalidArgument -> "invalid argument"
889 OtherError -> "failed"
890 ProtocolError -> "protocol error"
891 ResourceVanished -> "resource vanished"
892 SystemError -> "system error"
893 TimeExpired -> "timeout"
894 UnsatisfiedConstraints -> "unsatisified constraints" -- ultra-precise!
895 UnsupportedOperation -> "unsupported operation"
896 DynIOError{} -> "unknown IO error"
898 -- | Construct an 'IOError' value with a string describing the error.
899 -- The 'fail' method of the 'IO' instance of the 'Monad' class raises a
900 -- 'userError', thus:
902 -- > instance Monad IO where
904 -- > fail s = ioError (userError s)
906 userError :: String -> IOError
907 userError str = IOError Nothing UserError "" str Nothing
909 -- ---------------------------------------------------------------------------
912 instance Show IOException where
913 showsPrec p (IOError hdl iot loc s fn) =
915 Nothing -> case hdl of
917 Just h -> showsPrec p h . showString ": "
918 Just name -> showString name . showString ": ") .
921 _ -> showString loc . showString ": ") .
925 _ -> showString " (" . showString s . showString ")")
927 -- -----------------------------------------------------------------------------
930 data IOMode = ReadMode | WriteMode | AppendMode | ReadWriteMode
931 deriving (Eq, Ord, Ix, Enum, Read, Show)