on develop help sign in
Rename MonadBehaviorWriter -> BehaviorWriter; deprecate old name
49b9395Jack Kelly
ChangeLog.md+6
@@ -1,5 +1,11 @@
1# Revision history for reflex
1# Revision history for reflex
2
2
3+## Unreleased
4+
5+* Rename class `MonadBehaviorWriter` -> `BehaviorWriter` for
6+ consistency with `EventWriter`/`DynamicWriter`.
7+* Introduce deprecated alias `MonadBehaviorWriter = BehaviorWriter`.
8+
3## 0.6.4.1
9## 0.6.4.1
4
10
5* Fix a bug in the Reflex Profiled transformer where
11* Fix a bug in the Reflex Profiled transformer where
src/Reflex/BehaviorWriter/Base.hs+3−3
@@ -1,6 +1,6 @@
1{-|
1{-|
2Module: Reflex.BehaviorWriter.Base
2Module: Reflex.BehaviorWriter.Base
3−Description: Implementation of MonadBehaviorWriter
3+Description: Implementation of BehaviorWriter
4-}
4-}
5{-# LANGUAGE CPP #-}
5{-# LANGUAGE CPP #-}
6{-# LANGUAGE FlexibleInstances #-}
6{-# LANGUAGE FlexibleInstances #-}
@@ -46,7 +46,7 @@ import Reflex.Query.Class
46import Reflex.Requester.Class
46import Reflex.Requester.Class
47import Reflex.TriggerEvent.Class
47import Reflex.TriggerEvent.Class
48
48
49−-- | A basic implementation of 'MonadBehaviorWriter'.
49+-- | A basic implementation of 'BehaviorWriter'.
50newtype BehaviorWriterT t w m a = BehaviorWriterT { unBehaviorWriterT :: StateT [Behavior t w] m a }
50newtype BehaviorWriterT t w m a = BehaviorWriterT { unBehaviorWriterT :: StateT [Behavior t w] m a }
51 deriving (Functor, Applicative, Monad, MonadIO, MonadFix, MonadAsyncException, MonadException) -- The list is kept in reverse order
51 deriving (Functor, Applicative, Monad, MonadIO, MonadFix, MonadAsyncException, MonadException) -- The list is kept in reverse order
52
52
@@ -89,7 +89,7 @@ instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (BehaviorWri
89 newEventWithTrigger = lift . newEventWithTrigger
89 newEventWithTrigger = lift . newEventWithTrigger
90 newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
90 newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
91
91
92−instance (Monad m, Monoid w, Reflex t) => MonadBehaviorWriter t w (BehaviorWriterT t w m) where
92+instance (Monad m, Monoid w, Reflex t) => BehaviorWriter t w (BehaviorWriterT t w m) where
93 tellBehavior w = BehaviorWriterT $ modify (w :)
93 tellBehavior w = BehaviorWriterT $ modify (w :)
94
94
95instance MonadReader r m => MonadReader r (BehaviorWriterT t w m) where
95instance MonadReader r m => MonadReader r (BehaviorWriterT t w m) where
src/Reflex/BehaviorWriter/Class.hs+11−5
@@ -1,8 +1,9 @@
1{-|
1{-|
2Module: Reflex.BehaviorWriter.Class
2Module: Reflex.BehaviorWriter.Class
3−Description: This module defines the 'MonadBehaviorWriter' class
3+Description: This module defines the 'BehaviorWriter' class
4-}
4-}
5{-# LANGUAGE CPP #-}
5{-# LANGUAGE CPP #-}
6+{-# LANGUAGE ConstraintKinds #-}
6{-# LANGUAGE FlexibleInstances #-}
7{-# LANGUAGE FlexibleInstances #-}
7{-# LANGUAGE FunctionalDependencies #-}
8{-# LANGUAGE FunctionalDependencies #-}
8{-# LANGUAGE UndecidableInstances #-}
9{-# LANGUAGE UndecidableInstances #-}
@@ -10,16 +11,21 @@ Description: This module defines the 'MonadBehaviorWriter' class
10{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
11{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
11#endif
12#endif
12module Reflex.BehaviorWriter.Class
13module Reflex.BehaviorWriter.Class
13− ( MonadBehaviorWriter (..)
14+ ( MonadBehaviorWriter
15+ , BehaviorWriter(..)
14 ) where
16 ) where
15
17
16import Control.Monad.Reader (ReaderT, lift)
18import Control.Monad.Reader (ReaderT, lift)
17import Reflex.Class (Behavior)
19import Reflex.Class (Behavior)
18
20
21+{-# DEPRECATED MonadBehaviorWriter "Use 'BehaviorWriter' instead" #-}
22+-- | Type synonym for 'BehaviorWriter'
23+type MonadBehaviorWriter = BehaviorWriter
24+
19−-- | 'MonadBehaviorWriter' efficiently collects 'Behavior' values using 'tellBehavior'
25+-- | 'BehaviorWriter' efficiently collects 'Behavior' values using 'tellBehavior'
20-- and combines them monoidally to provide a 'Behavior' result.
26-- and combines them monoidally to provide a 'Behavior' result.
21−class (Monad m, Monoid w) => MonadBehaviorWriter t w m | m -> t w where
27+class (Monad m, Monoid w) => BehaviorWriter t w m | m -> t w where
22 tellBehavior :: Behavior t w -> m ()
28 tellBehavior :: Behavior t w -> m ()
23
29
24−instance MonadBehaviorWriter t w m => MonadBehaviorWriter t w (ReaderT r m) where
30+instance BehaviorWriter t w m => BehaviorWriter t w (ReaderT r m) where
25 tellBehavior = lift . tellBehavior
31 tellBehavior = lift . tellBehavior