1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE UndecidableInstances #-}
-- |
-- Module : Verismith.Result
-- Description : Result monadic type.
-- Copyright : (c) 2019, Yann Herklotz Grave
-- License : GPL-3
-- Maintainer : yann [at] yannherklotz [dot] com
-- Stability : experimental
-- Portability : POSIX
--
-- Result monadic type. This is nearly equivalent to the transformers 'Error' type,
-- but to have more control this is reimplemented with the instances that are
-- needed in "Verismith".
module Verismith.Result
( Result (..),
ResultT (..),
justPass,
justFail,
(<?>),
annotate,
)
where
import Control.Monad (liftM)
import Control.Monad.Base
import Control.Monad.IO.Class
import Control.Monad.Trans.Class
import Control.Monad.Trans.Control
import Data.Bifunctor (Bifunctor (..))
import Shelly (RunFailed (..), Sh, catch_sh)
import Shelly.Lifted
( MonadSh,
MonadShControl,
ShM,
liftSh,
liftShWith,
restoreSh,
)
-- | Result type which is equivalent to 'Either' or 'Error'. This is
-- reimplemented so that there is full control over the 'Monad' definition and
-- definition of a 'Monad' transformer 'ResultT'.
data Result a b
= Fail a
| Pass b
deriving (Eq, Show)
justPass :: Result a b -> Maybe b
justPass (Fail _) = Nothing
justPass (Pass a) = Just a
justFail :: Result a b -> Maybe a
justFail (Pass _) = Nothing
justFail (Fail a) = Just a
instance Semigroup (Result a b) where
Pass _ <> a = a
a <> _ = a
instance (Monoid b) => Monoid (Result a b) where
mempty = Pass mempty
instance Functor (Result a) where
fmap f (Pass a) = Pass $ f a
fmap _ (Fail b) = Fail b
instance Applicative (Result a) where
pure = Pass
Fail e <*> _ = Fail e
Pass f <*> r = fmap f r
instance Monad (Result a) where
Pass a >>= f = f a
Fail b >>= _ = Fail b
instance MonadBase (Result a) (Result a) where
liftBase = id
instance Bifunctor Result where
bimap a _ (Fail c) = Fail $ a c
bimap _ b (Pass c) = Pass $ b c
-- | The transformer for the 'Result' type. This
newtype ResultT a m b = ResultT {runResultT :: m (Result a b)}
instance Functor f => Functor (ResultT a f) where
fmap f = ResultT . fmap (fmap f) . runResultT
instance Monad m => Applicative (ResultT a m) where
pure = ResultT . pure . pure
f <*> a = ResultT $ do
f' <- runResultT f
case f' of
Fail e -> return (Fail e)
Pass k -> do
a' <- runResultT a
case a' of
Fail e -> return (Fail e)
Pass v -> return (Pass $ k v)
instance Monad m => Monad (ResultT a m) where
a >>= b = ResultT $ do
m <- runResultT a
case m of
Fail e -> return (Fail e)
Pass p -> runResultT (b p)
instance (MonadSh m, Monoid a) => MonadSh (ResultT a m) where
liftSh s =
ResultT
. liftSh
. catch_sh (Pass <$> s)
$ (const (Fail <$> return mempty) :: RunFailed -> Sh (Result a b))
instance MonadIO m => MonadIO (ResultT a m) where
liftIO s = ResultT $ Pass <$> liftIO s
instance MonadBase b m => MonadBase b (ResultT a m) where
liftBase = liftBaseDefault
instance MonadTrans (ResultT e) where
lift m = ResultT $ Pass <$> m
instance MonadTransControl (ResultT a) where
type StT (ResultT a) b = Result a b
liftWith f = ResultT $ return <$> f runResultT
restoreT = ResultT
{-# INLINEABLE liftWith #-}
{-# INLINEABLE restoreT #-}
instance MonadBaseControl IO m => MonadBaseControl IO (ResultT a m) where
type StM (ResultT a m) b = ComposeSt (ResultT a) m b
liftBaseWith = defaultLiftBaseWith
restoreM = defaultRestoreM
{-# INLINEABLE liftBaseWith #-}
{-# INLINEABLE restoreM #-}
instance
(MonadShControl m) =>
MonadShControl (ResultT a m)
where
newtype ShM (ResultT a m) b = ResultTShM (ShM m (Result a b))
liftShWith f =
ResultT $ liftM return $ liftShWith $ \runInSh -> f $ \k ->
liftM ResultTShM $ runInSh $ runResultT k
restoreSh (ResultTShM m) = ResultT . restoreSh $ m
{-# INLINE liftShWith #-}
{-# INLINE restoreSh #-}
infix 0 <?>
(<?>) :: (Monad m, Monoid a) => ResultT a m b -> a -> ResultT a m b
m <?> b = ResultT $ do
a <- runResultT m
case a of
Pass a' -> return $ Pass a'
Fail a' -> return . Fail $ a' <> b
annotate :: (Monad m, Monoid a) => a -> ResultT a m b -> ResultT a m b
annotate = flip (<?>)
|
