-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/

-- | Type classes and monads for unchecked extensible exceptions.
--   
--   This package provides type classes, a monad and a monad transformer
--   that support unchecked extensible exceptions as well as asynchronous
--   exceptions. It is compatible with the transformers package.
@package exception-transformers
@version 0.4.0.12

module Control.Monad.Exception

-- | Any type that you wish to throw or catch as an exception must be an
--   instance of the Exception class. The simplest case is a new
--   exception type directly below the root:
--   
--   
--   data MyException = ThisException | ThatException
--       deriving Show
--   
--   instance Exception MyException
--   
--   
--   The default method definitions in the Exception class do what
--   we need in this case. You can now throw and catch
--   ThisException and ThatException as exceptions:
--   
--   
--   *Main> throw ThisException `catch` \e -> putStrLn ("Caught " ++ show (e :: MyException))
--   Caught ThisException
--   
--   
--   In more complicated examples, you may wish to define a whole hierarchy
--   of exceptions:
--   
--   
--   ---------------------------------------------------------------------
--   -- Make the root exception type for all the exceptions in a compiler
--   
--   data SomeCompilerException = forall e . Exception e => SomeCompilerException e
--   
--   instance Show SomeCompilerException where
--       show (SomeCompilerException e) = show e
--   
--   instance Exception SomeCompilerException
--   
--   compilerExceptionToException :: Exception e => e -> SomeException
--   compilerExceptionToException = toException . SomeCompilerException
--   
--   compilerExceptionFromException :: Exception e => SomeException -> Maybe e
--   compilerExceptionFromException x = do
--       SomeCompilerException a <- fromException x
--       cast a
--   
--   ---------------------------------------------------------------------
--   -- Make a subhierarchy for exceptions in the frontend of the compiler
--   
--   data SomeFrontendException = forall e . Exception e => SomeFrontendException e
--   
--   instance Show SomeFrontendException where
--       show (SomeFrontendException e) = show e
--   
--   instance Exception SomeFrontendException where
--       toException = compilerExceptionToException
--       fromException = compilerExceptionFromException
--   
--   frontendExceptionToException :: Exception e => e -> SomeException
--   frontendExceptionToException = toException . SomeFrontendException
--   
--   frontendExceptionFromException :: Exception e => SomeException -> Maybe e
--   frontendExceptionFromException x = do
--       SomeFrontendException a <- fromException x
--       cast a
--   
--   ---------------------------------------------------------------------
--   -- Make an exception type for a particular frontend compiler exception
--   
--   data MismatchedParentheses = MismatchedParentheses
--       deriving Show
--   
--   instance Exception MismatchedParentheses where
--       toException   = frontendExceptionToException
--       fromException = frontendExceptionFromException
--   
--   
--   We can now catch a MismatchedParentheses exception as
--   MismatchedParentheses, SomeFrontendException or
--   SomeCompilerException, but not other types, e.g.
--   IOException:
--   
--   
--   *Main> throw MismatchedParentheses `catch` \e -> putStrLn ("Caught " ++ show (e :: MismatchedParentheses))
--   Caught MismatchedParentheses
--   *Main> throw MismatchedParentheses `catch` \e -> putStrLn ("Caught " ++ show (e :: SomeFrontendException))
--   Caught MismatchedParentheses
--   *Main> throw MismatchedParentheses `catch` \e -> putStrLn ("Caught " ++ show (e :: SomeCompilerException))
--   Caught MismatchedParentheses
--   *Main> throw MismatchedParentheses `catch` \e -> putStrLn ("Caught " ++ show (e :: IOException))
--   *** Exception: MismatchedParentheses
--   
class (Typeable e, Show e) => Exception e

-- | toException should produce a SomeException with no
--   attached ExceptionContext.
toException :: Exception e => e -> SomeException
fromException :: Exception e => SomeException -> Maybe e

-- | Render this exception value in a human-friendly manner.
--   
--   Default implementation: show.
displayException :: Exception e => e -> String
backtraceDesired :: Exception e => e -> Bool

-- | The SomeException type is the root of the exception type
--   hierarchy. When an exception of type e is thrown, behind the
--   scenes it is encapsulated in a SomeException.
data SomeException
class Monad m => MonadException (m :: Type -> Type)

-- | Throw an exception.
throw :: (MonadException m, Exception e) => e -> m a

-- | Catch an exception.
catch :: (MonadException m, Exception e) => m a -> (e -> m a) -> m a

-- | Run a computation and always perform a second, final computation even
--   if an exception is raised. If a short-circuiting monad transformer
--   such as ErrorT or MaybeT is used to transform a MonadException monad,
--   then the implementation of finally for the transformed monad
--   must guarantee that the final action is also always performed when any
--   short-circuiting occurs.
finally :: MonadException m => m a -> m b -> m a

-- | If an exception is raised by the computation, then perform a final
--   action and re-raise the exception.
onException :: MonadException m => m a -> m b -> m a
class (MonadIO m, MonadException m) => MonadAsyncException (m :: Type -> Type)

-- | Executes a computation with asynchronous exceptions masked. The
--   argument passed to mask is a function that takes as its
--   argument another function, which can be used to restore the prevailing
--   masking state within the context of the masked computation.
mask :: MonadAsyncException m => ((forall a. () => m a -> m a) -> m b) -> m b

-- | When you want to acquire a resource, do some work with it, and then
--   release the resource, it is a good idea to use bracket, because
--   bracket will install the necessary exception handler to release
--   the resource in the event that an exception is raised during the
--   computation. If an exception is raised, then bracket will
--   re-raise the exception (after performing the release).
bracket :: MonadAsyncException m => m a -> (a -> m b) -> (a -> m c) -> m c

-- | A variant of bracket where the return value from the first
--   computation is not required.
bracket_ :: MonadAsyncException m => m a -> m b -> m c -> m c
newtype ExceptionT (m :: Type -> Type) a
ExceptionT :: m (Either SomeException a) -> ExceptionT (m :: Type -> Type) a
[runExceptionT] :: ExceptionT (m :: Type -> Type) a -> m (Either SomeException a)
mapExceptionT :: (m (Either SomeException a) -> n (Either SomeException b)) -> ExceptionT m a -> ExceptionT n b

-- | Lift the result of running a computation in a monad transformed by
--   ExceptionT into another monad that supports exceptions.
liftException :: MonadException m => Either SomeException a -> m a
instance (GHC.Internal.Base.Functor m, GHC.Internal.Base.Monad m) => GHC.Internal.Base.Alternative (Control.Monad.Exception.ExceptionT m)
instance (GHC.Internal.Base.Functor m, GHC.Internal.Base.Monad m) => GHC.Internal.Base.Applicative (Control.Monad.Exception.ExceptionT m)
instance GHC.Internal.Base.Functor m => GHC.Internal.Base.Functor (Control.Monad.Exception.ExceptionT m)
instance Control.Monad.Exception.MonadAsyncException m => Control.Monad.Exception.MonadAsyncException (Control.Monad.Trans.Except.ExceptT e' m)
instance Control.Monad.Exception.MonadAsyncException m => Control.Monad.Exception.MonadAsyncException (Control.Monad.Exception.ExceptionT m)
instance Control.Monad.Exception.MonadAsyncException GHC.Types.IO
instance Control.Monad.Exception.MonadAsyncException m => Control.Monad.Exception.MonadAsyncException (Control.Monad.Trans.Identity.IdentityT m)
instance Control.Monad.Exception.MonadAsyncException m => Control.Monad.Exception.MonadAsyncException (Control.Monad.Trans.Maybe.MaybeT m)
instance (GHC.Internal.Base.Monoid w, Control.Monad.Exception.MonadAsyncException m) => Control.Monad.Exception.MonadAsyncException (Control.Monad.Trans.RWS.Strict.RWST r w s m)
instance (GHC.Internal.Base.Monoid w, Control.Monad.Exception.MonadAsyncException m) => Control.Monad.Exception.MonadAsyncException (Control.Monad.Trans.RWS.Lazy.RWST r w s m)
instance Control.Monad.Exception.MonadAsyncException m => Control.Monad.Exception.MonadAsyncException (Control.Monad.Trans.Reader.ReaderT r m)
instance Control.Monad.Exception.MonadAsyncException m => Control.Monad.Exception.MonadAsyncException (Control.Monad.Trans.State.Strict.StateT s m)
instance Control.Monad.Exception.MonadAsyncException m => Control.Monad.Exception.MonadAsyncException (Control.Monad.Trans.State.Lazy.StateT s m)
instance (GHC.Internal.Base.Monoid w, Control.Monad.Exception.MonadAsyncException m) => Control.Monad.Exception.MonadAsyncException (Control.Monad.Trans.Writer.Strict.WriterT w m)
instance (GHC.Internal.Base.Monoid w, Control.Monad.Exception.MonadAsyncException m) => Control.Monad.Exception.MonadAsyncException (Control.Monad.Trans.Writer.Lazy.WriterT w m)
instance GHC.Internal.Base.Monad m => GHC.Internal.Base.Monad (Control.Monad.Exception.ExceptionT m)
instance Control.Monad.Exception.MonadException m => Control.Monad.Exception.MonadException (Control.Monad.Trans.Except.ExceptT e' m)
instance GHC.Internal.Base.Monad m => Control.Monad.Exception.MonadException (Control.Monad.Exception.ExceptionT m)
instance Control.Monad.Exception.MonadException GHC.Types.IO
instance Control.Monad.Exception.MonadException m => Control.Monad.Exception.MonadException (Control.Monad.Trans.Identity.IdentityT m)
instance Control.Monad.Exception.MonadException m => Control.Monad.Exception.MonadException (Control.Monad.Trans.Maybe.MaybeT m)
instance (GHC.Internal.Base.Monoid w, Control.Monad.Exception.MonadException m) => Control.Monad.Exception.MonadException (Control.Monad.Trans.RWS.Strict.RWST r w s m)
instance (GHC.Internal.Base.Monoid w, Control.Monad.Exception.MonadException m) => Control.Monad.Exception.MonadException (Control.Monad.Trans.RWS.Lazy.RWST r w s m)
instance Control.Monad.Exception.MonadException m => Control.Monad.Exception.MonadException (Control.Monad.Trans.Reader.ReaderT r m)
instance Control.Monad.Exception.MonadException GHC.Internal.Conc.Sync.STM
instance Control.Monad.Exception.MonadException m => Control.Monad.Exception.MonadException (Control.Monad.Trans.State.Strict.StateT s m)
instance Control.Monad.Exception.MonadException m => Control.Monad.Exception.MonadException (Control.Monad.Trans.State.Lazy.StateT s m)
instance (GHC.Internal.Base.Monoid w, Control.Monad.Exception.MonadException m) => Control.Monad.Exception.MonadException (Control.Monad.Trans.Writer.Strict.WriterT w m)
instance (GHC.Internal.Base.Monoid w, Control.Monad.Exception.MonadException m) => Control.Monad.Exception.MonadException (Control.Monad.Trans.Writer.Lazy.WriterT w m)
instance GHC.Internal.Base.Monad m => GHC.Internal.Control.Monad.Fail.MonadFail (Control.Monad.Exception.ExceptionT m)
instance GHC.Internal.Control.Monad.Fix.MonadFix m => GHC.Internal.Control.Monad.Fix.MonadFix (Control.Monad.Exception.ExceptionT m)
instance Control.Monad.IO.Class.MonadIO m => Control.Monad.IO.Class.MonadIO (Control.Monad.Exception.ExceptionT m)
instance GHC.Internal.Base.Monad m => GHC.Internal.Base.MonadPlus (Control.Monad.Exception.ExceptionT m)
instance Control.Monad.Trans.Class.MonadTrans Control.Monad.Exception.ExceptionT
