6fc999193f
Don't need to be sanitized and displaying them messes up actually exiting with the right exit code! And broke the test suite. Sponsored-by: Brett Eisenberg on Patreon
120 lines
3.7 KiB
Haskell
120 lines
3.7 KiB
Haskell
{- Simple IO exception handling (and some more)
|
|
-
|
|
- Copyright 2011-2023 Joey Hess <id@joeyh.name>
|
|
-
|
|
- License: BSD-2-clause
|
|
-}
|
|
|
|
{-# LANGUAGE ScopedTypeVariables #-}
|
|
{-# OPTIONS_GHC -fno-warn-tabs #-}
|
|
|
|
module Utility.Exception (
|
|
module X,
|
|
giveup,
|
|
catchBoolIO,
|
|
catchMaybeIO,
|
|
catchDefaultIO,
|
|
catchMsgIO,
|
|
catchIO,
|
|
tryIO,
|
|
bracketIO,
|
|
catchNonAsync,
|
|
tryNonAsync,
|
|
nonAsyncHandler,
|
|
tryWhenExists,
|
|
catchIOErrorType,
|
|
IOErrorType(..),
|
|
catchPermissionDenied,
|
|
) where
|
|
|
|
import Control.Monad.Catch as X hiding (Handler)
|
|
import qualified Control.Monad.Catch as M
|
|
import Control.Exception (IOException, AsyncException, SomeAsyncException)
|
|
import Control.Monad
|
|
import Control.Monad.IO.Class (liftIO, MonadIO)
|
|
import System.IO.Error (isDoesNotExistError, ioeGetErrorType)
|
|
import GHC.IO.Exception (IOErrorType(..))
|
|
|
|
import Utility.Data
|
|
import Utility.SafeOutput
|
|
|
|
{- Like error, this throws an exception. Unlike error, if this exception
|
|
- is not caught, it won't generate a backtrace. So use this for situations
|
|
- where there's a problem that the user is expected to see in some
|
|
- circumstances.
|
|
-
|
|
- Also, control characters are filtered out of the message.
|
|
-}
|
|
giveup :: [Char] -> a
|
|
giveup = errorWithoutStackTrace . safeOutput
|
|
|
|
{- Catches IO errors and returns a Bool -}
|
|
catchBoolIO :: MonadCatch m => m Bool -> m Bool
|
|
catchBoolIO = catchDefaultIO False
|
|
|
|
{- Catches IO errors and returns a Maybe -}
|
|
catchMaybeIO :: MonadCatch m => m a -> m (Maybe a)
|
|
catchMaybeIO a = catchDefaultIO Nothing $ a >>= (return . Just)
|
|
|
|
{- Catches IO errors and returns a default value. -}
|
|
catchDefaultIO :: MonadCatch m => a -> m a -> m a
|
|
catchDefaultIO def a = catchIO a (const $ return def)
|
|
|
|
{- Catches IO errors and returns the error message. -}
|
|
catchMsgIO :: MonadCatch m => m a -> m (Either String a)
|
|
catchMsgIO a = do
|
|
v <- tryIO a
|
|
return $ either (Left . show) Right v
|
|
|
|
{- catch specialized for IO errors only -}
|
|
catchIO :: MonadCatch m => m a -> (IOException -> m a) -> m a
|
|
catchIO = M.catch
|
|
|
|
{- try specialized for IO errors only -}
|
|
tryIO :: MonadCatch m => m a -> m (Either IOException a)
|
|
tryIO = M.try
|
|
|
|
{- bracket with setup and cleanup actions lifted to IO.
|
|
-
|
|
- Note that unlike catchIO and tryIO, this catches all exceptions. -}
|
|
bracketIO :: (MonadMask m, MonadIO m) => IO v -> (v -> IO b) -> (v -> m a) -> m a
|
|
bracketIO setup cleanup = bracket (liftIO setup) (liftIO . cleanup)
|
|
|
|
{- Catches all exceptions except for async exceptions.
|
|
- This is often better to use than catching them all, so that
|
|
- ThreadKilled and UserInterrupt get through.
|
|
-}
|
|
catchNonAsync :: MonadCatch m => m a -> (SomeException -> m a) -> m a
|
|
catchNonAsync a onerr = a `catches` (nonAsyncHandler onerr)
|
|
|
|
tryNonAsync :: MonadCatch m => m a -> m (Either SomeException a)
|
|
tryNonAsync a = go `catchNonAsync` (return . Left)
|
|
where
|
|
go = do
|
|
v <- a
|
|
return (Right v)
|
|
|
|
nonAsyncHandler :: MonadCatch m => (SomeException -> m a) -> [M.Handler m a]
|
|
nonAsyncHandler onerr =
|
|
[ M.Handler (\ (e :: AsyncException) -> throwM e)
|
|
, M.Handler (\ (e :: SomeAsyncException) -> throwM e)
|
|
, M.Handler (\ (e :: SomeException) -> onerr e)
|
|
]
|
|
|
|
{- Catches only DoesNotExist exceptions, and lets all others through. -}
|
|
tryWhenExists :: MonadCatch m => m a -> m (Maybe a)
|
|
tryWhenExists a = do
|
|
v <- tryJust (guard . isDoesNotExistError) a
|
|
return (eitherToMaybe v)
|
|
|
|
{- Catches only IO exceptions of a particular type.
|
|
- Ie, use HardwareFault to catch disk IO errors. -}
|
|
catchIOErrorType :: MonadCatch m => IOErrorType -> (IOException -> m a) -> m a -> m a
|
|
catchIOErrorType errtype onmatchingerr a = catchIO a onlymatching
|
|
where
|
|
onlymatching e
|
|
| ioeGetErrorType e == errtype = onmatchingerr e
|
|
| otherwise = throwM e
|
|
|
|
catchPermissionDenied :: MonadCatch m => (IOException -> m a) -> m a -> m a
|
|
catchPermissionDenied = catchIOErrorType PermissionDenied
|