@@ -2,156 +2,41 @@
2Module: Reflex.Vty.Widget
2Module: Reflex.Vty.Widget
3Description: Basic set of widgets and building blocks for reflex-vty applications
3Description: Basic set of widgets and building blocks for reflex-vty applications
5−{-# LANGUAGE DefaultSignatures #-}
6−{-# LANGUAGE DeriveFunctor #-}
7−{-# LANGUAGE FlexibleContexts #-}
8−{-# LANGUAGE FlexibleInstances #-}
9−{-# LANGUAGE FunctionalDependencies #-}
10−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
11−{-# LANGUAGE LambdaCase #-}
12−{-# LANGUAGE RankNTypes #-}
13−{-# LANGUAGE RecursiveDo #-}
14−{-# LANGUAGE ScopedTypeVariables #-}
15−{-# LANGUAGE StandaloneDeriving #-}
16−{-# LANGUAGE TupleSections #-}
17−{-# LANGUAGE TypeFamilies #-}
18−{-# LANGUAGE UndecidableInstances #-}
5+{-# Language UndecidableInstances #-}
20−module Reflex.Vty.Widget
7+module Reflex.Vty.Widget where
27− , mainWidgetWithHandle
67import Control.Applicative (liftA2)
9import Control.Applicative (liftA2)
68import Control.Monad.Fix (MonadFix)
10import Control.Monad.Fix (MonadFix)
69−import Control.Monad.Reader
11+import Control.Monad.IO.Class (MonadIO)
12+import Control.Monad.Morph
13+import Control.Monad.NodeId
14+import Control.Monad.Reader (ReaderT, ask, local, runReaderT)
15+import Control.Monad.Ref
70−import Control.Monad.Trans (lift)
16+import Control.Monad.Trans (MonadTrans, lift)
71−import Data.Default (Default(..))
72import Data.Set (Set)
17import Data.Set (Set)
73import qualified Data.Set as Set
18import qualified Data.Set as Set
74−import Data.Text (Text)
75−import qualified Data.Text as T
76−import qualified Data.Text.Zipper as TZ
77import Graphics.Vty (Image)
19import Graphics.Vty (Image)
78import qualified Graphics.Vty as V
20import qualified Graphics.Vty as V
79import Reflex
21import Reflex
80import Reflex.Class ()
22import Reflex.Class ()
81import Reflex.Host.Class (MonadReflexCreateTrigger)
23import Reflex.Host.Class (MonadReflexCreateTrigger)
83import Reflex.Vty.Host
24import Reflex.Vty.Host
85−import Control.Monad.NodeId
26+-- * Running a vty application
87−-- | The context within which a 'VtyWidget' runs
88−data VtyWidgetCtx t = VtyWidgetCtx
89− { _vtyWidgetCtx_width :: Dynamic t Int
90− -- ^ The width of the region allocated to the widget.
91− , _vtyWidgetCtx_height :: Dynamic t Int
92− -- ^ The height of the region allocated to the widget.
93− , _vtyWidgetCtx_focus :: Dynamic t Bool
94− -- ^ Whether the widget should behave as if it has focus for keyboard input.
95− , _vtyWidgetCtx_input :: Event t VtyEvent
96− -- ^ User input events that the widget's parent chooses to share. These will generally
97− -- be filtered for relevance:
98− -- * Keyboard inputs are restricted to focused widgets
99− -- * Mouse inputs are restricted to the region in which the widget resides and are
100− -- translated into its internal coordinates.
103−-- | The output of a 'VtyWidget'
104−data VtyWidgetOut t = VtyWidgetOut
105− { _vtyWidgetOut_shutdown :: Event t ()
108−instance (Adjustable t m, MonadHold t m, Reflex t) => Adjustable t (VtyWidget t m) where
109− runWithReplace a0 a' = VtyWidget $ runWithReplace (unVtyWidget a0) $ fmap unVtyWidget a'
110− traverseIntMapWithKeyWithAdjust f dm0 dm' = VtyWidget $
111− traverseIntMapWithKeyWithAdjust (\k v -> unVtyWidget (f k v)) dm0 dm'
112− traverseDMapWithKeyWithAdjust f dm0 dm' = VtyWidget $ do
113− traverseDMapWithKeyWithAdjust (\k v -> unVtyWidget (f k v)) dm0 dm'
114− traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = VtyWidget $ do
115− traverseDMapWithKeyWithAdjustWithMove (\k v -> unVtyWidget (f k v)) dm0 dm'
117−-- | A widget that can read its context and produce image output
118−newtype VtyWidget t m a = VtyWidget
119− { unVtyWidget :: BehaviorWriterT t [Image] (ReaderT (VtyWidgetCtx t) m) a
131− , MonadReflexCreateTrigger t
135−deriving instance PerformEvent t m => PerformEvent t (VtyWidget t m)
136−instance MonadTrans (VtyWidget t) where
137− lift f = VtyWidget $ lift $ lift f
139−instance MonadNodeId m => MonadNodeId (VtyWidget t m) where
140− getNextNodeId = VtyWidget $ do
141− lift $ lift $ getNextNodeId
143−-- | Runs a 'VtyWidget' with a given context
145− :: (Reflex t, MonadNodeId m)
148− -> m (a, Behavior t [Image])
149−runVtyWidget ctx w = runReaderT (runBehaviorWriterT (unVtyWidget w)) ctx
151−-- | Sets up the top-level context for a 'VtyWidget' and runs it with that context
28+-- | Sets up the top-level context for a vty widget and runs it with that context
152mainWidgetWithHandle
29mainWidgetWithHandle
154− -> (forall t m. (MonadVtyApp t m, MonadNodeId m) => VtyWidget t m (Event t ()))
32+ ( MonadVtyApp t m
35+ , HasDisplayRegion t m
156mainWidgetWithHandle vty child =
41mainWidgetWithHandle vty child =
157 runVtyAppWithHandle vty $ \dr0 inp -> do
42 runVtyAppWithHandle vty $ \dr0 inp -> do
@@ -161,71 +46,178 @@ mainWidgetWithHandle vty child =
161 let inp' = fforMaybe inp $ \case
46 let inp' = fforMaybe inp $ \case
162 V.EvResize {} -> Nothing
47 V.EvResize {} -> Nothing
163 x -> Just x
48 x -> Just x
164− let ctx = VtyWidgetCtx
49+ (shutdown, images) <- runThemeReader (constant V.defAttr) $
165− { _vtyWidgetCtx_width = fmap fst size
50+ runFocusReader (pure True) $
166− , _vtyWidgetCtx_height = fmap snd size
51+ runDisplayRegion (fmap (\(w, h) -> Region 0 0 w h) size) $
167− , _vtyWidgetCtx_input = inp'
52+ runImageWriter $
168− , _vtyWidgetCtx_focus = constDyn True
53+ runNodeIdT $
169− }
54+ runInput inp' $ do
170− (shutdown, images) <- runNodeIdT $ runVtyWidget ctx $ do
171− tellImages . ffor (current size) $ \(w, h) -> [V.charFill V.defAttr ' ' w h]
55+ tellImages . ffor (current size) $ \(w, h) -> [V.charFill V.defAttr ' ' w h]
173 return $ VtyResult
57 return $ VtyResult
174 { _vtyResult_picture = fmap (V.picForLayers . reverse) images
58 { _vtyResult_picture = fmap (V.picForLayers . reverse) images
175 , _vtyResult_shutdown = shutdown
59 , _vtyResult_shutdown = shutdown
62+-- | The output of a vty widget
63+data VtyWidgetOut t = VtyWidgetOut
64+ { _vtyWidgetOut_shutdown :: Event t ()
178-- | Like 'mainWidgetWithHandle', but uses a default vty configuration
67-- | Like 'mainWidgetWithHandle', but uses a default vty configuration
179mainWidget
68mainWidget
180− :: (forall t m. (MonadVtyApp t m, MonadNodeId m) => VtyWidget t m (Event t ()))
70+ ( MonadVtyApp t m
73+ , HasDisplayRegion t m
182mainWidget child = do
79mainWidget child = do
183 vty <- getDefaultVty
80 vty <- getDefaultVty
184 mainWidgetWithHandle vty child
81 mainWidgetWithHandle vty child
186−-- | A class for things that know their own display size dimensions
83+-- * Input Events
187−class (Reflex t, Monad m) => HasDisplaySize t m | m -> t where
188− -- | Retrieve the display width (columns)
189− displayWidth :: m (Dynamic t Int)
190− default displayWidth :: (f m' ~ m, MonadTrans f, HasDisplaySize t m') => m (Dynamic t Int)
191− displayWidth = lift displayWidth
192− -- | Retrieve the display height (rows)
193− displayHeight :: m (Dynamic t Int)
194− default displayHeight :: (f m' ~ m, MonadTrans f, HasDisplaySize t m') => m (Dynamic t Int)
195− displayHeight = lift displayHeight
197−instance (Reflex t, Monad m) => HasDisplaySize t (VtyWidget t m) where
198− displayWidth = VtyWidget . lift $ asks _vtyWidgetCtx_width
199− displayHeight = VtyWidget . lift $ asks _vtyWidgetCtx_height
201−instance HasDisplaySize t m => HasDisplaySize t (ReaderT x m)
202−instance HasDisplaySize t m => HasDisplaySize t (BehaviorWriterT t x m)
203−instance HasDisplaySize t m => HasDisplaySize t (DynamicWriterT t x m)
204−instance HasDisplaySize t m => HasDisplaySize t (EventWriterT t x m)
206−instance HasDisplaySize t m => HasDisplaySize t (NodeIdT m)
208-- | A class for things that can receive vty events as input
85-- | A class for things that can receive vty events as input
209−class HasVtyInput t m | m -> t where
86+class HasInput t m | m -> t where
210 input :: m (Event t VtyEvent)
87 input :: m (Event t VtyEvent)
88+ default input :: (f m' ~ m, Monad m', MonadTrans f, HasInput t m') => m (Event t VtyEvent)
90+ -- | User input events that the widget's parent chooses to share. These will generally
91+ -- be filtered for relevance.
92+ localInput :: (Event t VtyEvent -> Event t VtyEvent) -> m a -> m a
93+ default localInput :: (f m' ~ m, Monad m', MFunctor f, HasInput t m') => (Event t VtyEvent -> Event t VtyEvent) -> m a -> m a
94+ localInput f = hoist (localInput f)
96+instance (Reflex t, Monad m) => HasInput t (Input t m) where
98+ localInput f (Input m) = Input $ local f m
100+-- | A widget that can receive input events. See 'Graphics.Vty.Event'
101+newtype Input t m a = Input
102+ { unInput :: ReaderT (Event t VtyEvent) m a
212−instance (Reflex t, Monad m) => HasVtyInput t (VtyWidget t m) where
114+instance (Adjustable t m, MonadHold t m, Reflex t) => Adjustable t (Input t m) where
213− input = VtyWidget . lift $ asks _vtyWidgetCtx_input
115+ runWithReplace a0 a' = Input $ runWithReplace (unInput a0) $ fmap unInput a'
116+ traverseIntMapWithKeyWithAdjust f dm0 dm' = Input $
117+ traverseIntMapWithKeyWithAdjust (\k v -> unInput (f k v)) dm0 dm'
118+ traverseDMapWithKeyWithAdjust f dm0 dm' = Input $ do
119+ traverseDMapWithKeyWithAdjust (\k v -> unInput (f k v)) dm0 dm'
120+ traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = Input $ do
121+ traverseDMapWithKeyWithAdjustWithMove (\k v -> unInput (f k v)) dm0 dm'
123+deriving instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (Input t m)
124+deriving instance NotReady t m => NotReady t (Input t m)
125+deriving instance PerformEvent t m => PerformEvent t (Input t m)
126+deriving instance PostBuild t m => PostBuild t (Input t m)
127+deriving instance TriggerEvent t m => TriggerEvent t (Input t m)
128+instance HasImageWriter t m => HasImageWriter t (Input t m)
129+instance HasDisplayRegion t m => HasDisplayRegion t (Input t m)
130+instance HasFocusReader t m => HasFocusReader t (Input t m)
132+instance MonadTrans (Input t) where
133+ lift f = Input $ lift f
135+instance MFunctor (Input t) where
136+ hoist f = Input . hoist f . unInput
138+instance MonadNodeId m => MonadNodeId (Input t m)
140+-- | Runs an 'Input' with a given context
146+runInput e w = runReaderT (unInput w) e
148+-- ** Filtering input
215−-- | A class for things that can dynamically gain and lose focus
150+-- | Type synonym for a key and modifier combination
216−class HasFocus t m | m -> t where
151+type KeyCombo = (V.Key, [V.Modifier])
217− focus :: m (Dynamic t Bool)
219−instance (Reflex t, Monad m) => HasFocus t (VtyWidget t m) where
153+-- | Emits an event that fires on a particular key press (without modifiers)
220− focus = VtyWidget . lift $ asks _vtyWidgetCtx_focus
154+key :: (Monad m, Reflex t, HasInput t m) => V.Key -> m (Event t KeyCombo)
155+key = keyCombos . Set.singleton . (,[])
222−-- | A class for widgets that can produce images to draw to the display
157+-- | Emits an event that fires on particular key presses (without modifiers)
223−class (Reflex t, Monad m) => ImageWriter t m | m -> t where
158+keys :: (Monad m, Reflex t, HasInput t m) => [V.Key] -> m (Event t KeyCombo)
224− -- | Send images upstream for rendering
159+keys = keyCombos . Set.fromList . fmap (,[])
225− tellImages :: Behavior t [Image] -> m ()
227−instance (Monad m, Reflex t) => ImageWriter t (BehaviorWriterT t [Image] m) where
161+-- | Emit an event that fires whenever the provided key combination occurs
228− tellImages = tellBehavior
162+keyCombo
163+ :: (Reflex t, Monad m, HasInput t m)
165+ -> m (Event t KeyCombo)
166+keyCombo = keyCombos . Set.singleton
168+-- | Emit an event that fires whenever any of the provided key combinations occur
170+ :: (Reflex t, Monad m, HasInput t m)
172+ -> m (Event t KeyCombo)
175+ return $ fforMaybe i $ \case
176+ V.EvKey k m -> if Set.member (k, m) ks
181+-- | Filter the keyboard input that a child widget may receive
182+filterKeys :: (Reflex t, HasInput t m) => (KeyCombo -> Bool) -> m a -> m a
183+filterKeys f x = localInput (ffilter (\case
184+ V.EvKey k mods -> f (k, mods)
187+-- | Filter mouse input events based on whether they target a particular region
188+-- and translate them to the internal coordinate system of that region.
190+-- NB: Non-mouse events are passed through unfiltered and unchanged
191+mouseInRegion :: Region -> VtyEvent -> Maybe VtyEvent
192+mouseInRegion (Region l t w h) e = case e of
193+ V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
194+ V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
201+ , y >= t + h ] = Nothing
203+ Just (con (x - l) (y - t))
205+-- | Filter mouse input outside the current display region and
206+-- all input if the region is not focused
208+ :: (HasDisplayRegion t m, HasFocusReader t m, HasInput t m)
209+ => m (Event t VtyEvent)
210+inputInFocusedRegion = do
212+ reg <- current <$> askRegion
213+ foc <- current <$> focus
214+ pure $ fmapMaybe id $ attachWith filterInput ((,) <$> reg <*> foc) inp
216+ filterInput (r, f) = \case
217+ V.EvKey {} | not f -> Nothing
218+ x -> mouseInRegion r x
220+-- * Getting and setting the display region
230-- | A chunk of the display area
222-- | A chunk of the display area
231data Region = Region
223data Region = Region
@@ -236,26 +228,293 @@ data Region = Region
237 deriving (Show, Read, Eq, Ord)
229 deriving (Show, Read, Eq, Ord)
239−-- | A dynamic chunk of the display area
231+-- | A region that occupies no space.
240−data DynRegion t = DynRegion
232+nilRegion :: Region
241− { _dynRegion_left :: Dynamic t Int
233+nilRegion = Region 0 0 0 0
242− , _dynRegion_top :: Dynamic t Int
243− , _dynRegion_width :: Dynamic t Int
244− , _dynRegion_height :: Dynamic t Int
247-- | The width and height of a 'Region'
235-- | The width and height of a 'Region'
248regionSize :: Region -> (Int, Int)
236regionSize :: Region -> (Int, Int)
249regionSize (Region _ _ w h) = (w, h)
237regionSize (Region _ _ w h) = (w, h)
251-- | Produces an 'Image' that fills a region with space characters
239-- | Produces an 'Image' that fills a region with space characters
252−regionBlankImage :: Region -> Image
240+regionBlankImage :: V.Attr -> Region -> Image
253−regionBlankImage r@(Region _ _ width height) =
241+regionBlankImage attr r@(Region _ _ width height) =
254− withinImage r $ V.charFill V.defAttr ' ' width height
242+ withinImage r $ V.charFill attr ' ' width height
244+-- | A class for things that know their own display size dimensions
245+class (Reflex t, Monad m) => HasDisplayRegion t m | m -> t where
246+ -- | Retrieve the display region
247+ askRegion :: m (Dynamic t Region)
248+ default askRegion :: (f m' ~ m, MonadTrans f, HasDisplayRegion t m') => m (Dynamic t Region)
249+ askRegion = lift askRegion
250+ -- | Run an action in a local region, by applying a transformation to the region
251+ localRegion :: (Dynamic t Region -> Dynamic t Region) -> m a -> m a
252+ default localRegion :: (f m' ~ m, Monad m', MFunctor f, HasDisplayRegion t m') => (Dynamic t Region -> Dynamic t Region) -> m a -> m a
253+ localRegion f = hoist (localRegion f)
255+-- | Retrieve the display width
256+displayWidth :: HasDisplayRegion t m => m (Dynamic t Int)
257+displayWidth = fmap _region_width <$> askRegion
259+-- | Retrieve the display height
260+displayHeight :: HasDisplayRegion t m => m (Dynamic t Int)
261+displayHeight = fmap _region_height <$> askRegion
263+instance HasDisplayRegion t m => HasDisplayRegion t (ReaderT x m)
264+instance HasDisplayRegion t m => HasDisplayRegion t (BehaviorWriterT t x m)
265+instance HasDisplayRegion t m => HasDisplayRegion t (DynamicWriterT t x m)
266+instance HasDisplayRegion t m => HasDisplayRegion t (EventWriterT t x m)
267+instance HasDisplayRegion t m => HasDisplayRegion t (NodeIdT m)
269+-- | A widget that has access to a particular region of the vty display
270+newtype DisplayRegion t m a = DisplayRegion
271+ { unDisplayRegion :: ReaderT (Dynamic t Region) m a }
283+instance (Monad m, Reflex t) => HasDisplayRegion t (DisplayRegion t m) where
284+ askRegion = DisplayRegion ask
285+ localRegion f = DisplayRegion . local f . unDisplayRegion
287+deriving instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (DisplayRegion t m)
288+deriving instance NotReady t m => NotReady t (DisplayRegion t m)
289+deriving instance PerformEvent t m => PerformEvent t (DisplayRegion t m)
290+deriving instance PostBuild t m => PostBuild t (DisplayRegion t m)
291+deriving instance TriggerEvent t m => TriggerEvent t (DisplayRegion t m)
292+instance HasImageWriter t m => HasImageWriter t (DisplayRegion t m)
293+instance HasFocusReader t m => HasFocusReader t (DisplayRegion t m)
295+instance (Adjustable t m, MonadFix m, MonadHold t m) => Adjustable t (DisplayRegion t m) where
296+ runWithReplace (DisplayRegion a) e = DisplayRegion $ runWithReplace a $ fmap unDisplayRegion e
297+ traverseIntMapWithKeyWithAdjust f m e = DisplayRegion $ traverseIntMapWithKeyWithAdjust (\k v -> unDisplayRegion $ f k v) m e
298+ traverseDMapWithKeyWithAdjust f m e = DisplayRegion $ traverseDMapWithKeyWithAdjust (\k v -> unDisplayRegion $ f k v) m e
299+ traverseDMapWithKeyWithAdjustWithMove f m e = DisplayRegion $ traverseDMapWithKeyWithAdjustWithMove (\k v -> unDisplayRegion $ f k v) m e
301+instance MonadTrans (DisplayRegion t) where
302+ lift = DisplayRegion . lift
304+instance MFunctor (DisplayRegion t) where
305+ hoist f = DisplayRegion . hoist f . unDisplayRegion
307+instance MonadNodeId m => MonadNodeId (DisplayRegion t m)
309+-- | Run a 'DisplayRegion' action with a given 'Region'
311+ :: (Reflex t, Monad m)
313+ -> DisplayRegion t m a
315+runDisplayRegion r = flip runReaderT r . unDisplayRegion
317+-- * Getting focus state
319+-- | A class for things that can dynamically gain and lose focus
320+class (Reflex t, Monad m) => HasFocusReader t m | m -> t where
321+ focus :: m (Dynamic t Bool)
322+ default focus :: (f m' ~ m, Monad m', MonadTrans f, HasFocusReader t m') => m (Dynamic t Bool)
324+ localFocus :: (Dynamic t Bool -> Dynamic t Bool) -> m a -> m a
325+ default localFocus :: (f m' ~ m, Monad m', MFunctor f, HasFocusReader t m') => (Dynamic t Bool -> Dynamic t Bool) -> m a -> m a
326+ localFocus f = hoist (localFocus f)
328+instance HasFocusReader t m => HasFocusReader t (ReaderT x m)
329+instance HasFocusReader t m => HasFocusReader t (BehaviorWriterT t x m)
330+instance HasFocusReader t m => HasFocusReader t (DynamicWriterT t x m)
331+instance HasFocusReader t m => HasFocusReader t (EventWriterT t x m)
332+instance HasFocusReader t m => HasFocusReader t (NodeIdT m)
334+-- | A widget that has access to information about whether it is focused
335+newtype FocusReader t m a = FocusReader
336+ { unFocusReader :: ReaderT (Dynamic t Bool) m a }
348+instance (Monad m, Reflex t) => HasFocusReader t (FocusReader t m) where
349+ focus = FocusReader ask
350+ localFocus f = FocusReader . local f . unFocusReader
352+deriving instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (FocusReader t m)
353+deriving instance NotReady t m => NotReady t (FocusReader t m)
354+deriving instance PerformEvent t m => PerformEvent t (FocusReader t m)
355+deriving instance PostBuild t m => PostBuild t (FocusReader t m)
356+deriving instance TriggerEvent t m => TriggerEvent t (FocusReader t m)
357+instance HasImageWriter t m => HasImageWriter t (FocusReader t m)
256−-- | A behavior of the current display area represented by a 'DynRegion'
359+instance (Adjustable t m, MonadFix m, MonadHold t m) => Adjustable t (FocusReader t m) where
257−currentRegion :: Reflex t => DynRegion t -> Behavior t Region
360+ runWithReplace (FocusReader a) e = FocusReader $ runWithReplace a $ fmap unFocusReader e
258−currentRegion (DynRegion l t w h) = Region <$> current l <*> current t <*> current w <*> current h
361+ traverseIntMapWithKeyWithAdjust f m e = FocusReader $ traverseIntMapWithKeyWithAdjust (\k v -> unFocusReader $ f k v) m e
362+ traverseDMapWithKeyWithAdjust f m e = FocusReader $ traverseDMapWithKeyWithAdjust (\k v -> unFocusReader $ f k v) m e
363+ traverseDMapWithKeyWithAdjustWithMove f m e = FocusReader $ traverseDMapWithKeyWithAdjustWithMove (\k v -> unFocusReader $ f k v) m e
365+instance MonadTrans (FocusReader t) where
366+ lift = FocusReader . lift
368+instance MFunctor (FocusReader t) where
369+ hoist f = FocusReader . hoist f . unFocusReader
371+instance MonadNodeId m => MonadNodeId (FocusReader t m)
373+-- | Run a 'FocusReader' action with the given focus value
375+ :: (Reflex t, Monad m)
377+ -> FocusReader t m a
379+runFocusReader b = flip runReaderT b . unFocusReader
383+-- | A class for widgets that can produce images to draw to the display
384+class (Reflex t, Monad m) => HasImageWriter t m | m -> t where
385+ -- | Send images upstream for rendering
386+ tellImages :: Behavior t [Image] -> m ()
387+ default tellImages :: (f m' ~ m, Monad m', MonadTrans f, HasImageWriter t m') => Behavior t [Image] -> m ()
388+ tellImages = lift . tellImages
389+ -- | Apply a transformation to the images produced by the child actions
390+ mapImages :: (Behavior t [Image] -> Behavior t [Image]) -> m a -> m a
391+ default mapImages :: (f m' ~ m, Monad m', MFunctor f, HasImageWriter t m') => (Behavior t [Image] -> Behavior t [Image]) -> m a -> m a
392+ mapImages f = hoist (mapImages f)
394+-- | A widget that can produce images to draw onto the display
395+newtype ImageWriter t m a = ImageWriter
396+ { unImageWriter :: BehaviorWriterT t [Image] m a }
405+ , MonadReflexCreateTrigger t
413+instance MonadTrans (ImageWriter t) where
414+ lift = ImageWriter . lift
416+instance MFunctor (ImageWriter t) where
417+ hoist f = ImageWriter . (hoist f) . unImageWriter
419+instance (Adjustable t m, MonadFix m, MonadHold t m) => Adjustable t (ImageWriter t m) where
420+ runWithReplace (ImageWriter a) e = ImageWriter $ runWithReplace a $ fmap unImageWriter e
421+ traverseIntMapWithKeyWithAdjust f m e = ImageWriter $ traverseIntMapWithKeyWithAdjust (\k v -> unImageWriter $ f k v) m e
422+ traverseDMapWithKeyWithAdjust f m e = ImageWriter $ traverseDMapWithKeyWithAdjust (\k v -> unImageWriter $ f k v) m e
423+ traverseDMapWithKeyWithAdjustWithMove f m e = ImageWriter $ traverseDMapWithKeyWithAdjustWithMove (\k v -> unImageWriter $ f k v) m e
425+instance HasImageWriter t m => HasImageWriter t (ReaderT x m)
426+instance HasImageWriter t m => HasImageWriter t (BehaviorWriterT t x m)
427+instance HasImageWriter t m => HasImageWriter t (DynamicWriterT t x m)
428+instance HasImageWriter t m => HasImageWriter t (EventWriterT t x m)
429+instance HasImageWriter t m => HasImageWriter t (NodeIdT m)
431+instance (Monad m, Reflex t) => HasImageWriter t (ImageWriter t m) where
432+ tellImages = ImageWriter . tellBehavior
433+ mapImages f (ImageWriter x) = ImageWriter $ do
434+ (a, images) <- lift $ runBehaviorWriterT x
435+ tellBehavior $ f images
438+instance HasDisplayRegion t m => HasDisplayRegion t (ImageWriter t m)
439+instance HasFocusReader t m => HasFocusReader t (ImageWriter t m)
441+-- | Run a widget that can produce images
443+ :: (Reflex t, Monad m)
444+ => ImageWriter t m a
445+ -> m (a, Behavior t [Image])
446+runImageWriter = runBehaviorWriterT . unImageWriter
450+-- | A class for things that can be visually styled
451+class (Reflex t, Monad m) => HasTheme t m | m -> t where
452+ theme :: m (Behavior t V.Attr)
453+ default theme :: (f m' ~ m, Monad m', MonadTrans f, HasTheme t m') => m (Behavior t V.Attr)
455+ localTheme :: (Behavior t V.Attr -> Behavior t V.Attr) -> m a -> m a
456+ default localTheme :: (f m' ~ m, Monad m', MFunctor f, HasTheme t m') => (Behavior t V.Attr -> Behavior t V.Attr) -> m a -> m a
457+ localTheme f = hoist (localTheme f)
459+instance HasTheme t m => HasTheme t (ReaderT x m)
460+instance HasTheme t m => HasTheme t (BehaviorWriterT t x m)
461+instance HasTheme t m => HasTheme t (DynamicWriterT t x m)
462+instance HasTheme t m => HasTheme t (EventWriterT t x m)
463+instance HasTheme t m => HasTheme t (NodeIdT m)
464+instance HasTheme t m => HasTheme t (Input t m)
465+instance HasTheme t m => HasTheme t (ImageWriter t m)
466+instance HasTheme t m => HasTheme t (DisplayRegion t m)
467+instance HasTheme t m => HasTheme t (FocusReader t m)
469+-- | A widget that has access to theme information
470+newtype ThemeReader t m a = ThemeReader
471+ { unThemeReader :: ReaderT (Behavior t V.Attr) m a }
483+instance (Monad m, Reflex t) => HasTheme t (ThemeReader t m) where
484+ theme = ThemeReader ask
485+ localTheme f = ThemeReader . local f . unThemeReader
487+deriving instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (ThemeReader t m)
488+deriving instance NotReady t m => NotReady t (ThemeReader t m)
489+deriving instance PerformEvent t m => PerformEvent t (ThemeReader t m)
490+deriving instance PostBuild t m => PostBuild t (ThemeReader t m)
491+deriving instance TriggerEvent t m => TriggerEvent t (ThemeReader t m)
492+instance HasImageWriter t m => HasImageWriter t (ThemeReader t m)
494+instance (Adjustable t m, MonadFix m, MonadHold t m) => Adjustable t (ThemeReader t m) where
495+ runWithReplace (ThemeReader a) e = ThemeReader $ runWithReplace a $ fmap unThemeReader e
496+ traverseIntMapWithKeyWithAdjust f m e = ThemeReader $ traverseIntMapWithKeyWithAdjust (\k v -> unThemeReader $ f k v) m e
497+ traverseDMapWithKeyWithAdjust f m e = ThemeReader $ traverseDMapWithKeyWithAdjust (\k v -> unThemeReader $ f k v) m e
498+ traverseDMapWithKeyWithAdjustWithMove f m e = ThemeReader $ traverseDMapWithKeyWithAdjustWithMove (\k v -> unThemeReader $ f k v) m e
500+instance MonadTrans (ThemeReader t) where
501+ lift = ThemeReader . lift
503+instance MFunctor (ThemeReader t) where
504+ hoist f = ThemeReader . hoist f . unThemeReader
506+instance MonadNodeId m => MonadNodeId (ThemeReader t m)
508+-- | Run a 'ThemeReader' action with the given focus value
510+ :: (Reflex t, Monad m)
511+ => Behavior t V.Attr
512+ -> ThemeReader t m a
514+runThemeReader b = flip runReaderT b . unThemeReader
517+-- ** Manipulating images
260-- | Translates and crops an 'Image' so that it is contained by
519-- | Translates and crops an 'Image' so that it is contained by
261-- the given 'Region'.
520-- the given 'Region'.
@@ -267,7 +526,17 @@ withinImage (Region left top width height)
267 | width < 0 || height < 0 = withinImage (Region left top 0 0)
526 | width < 0 || height < 0 = withinImage (Region left top 0 0)
268 | otherwise = V.translate left top . V.crop width height
527 | otherwise = V.translate left top . V.crop width height
529+-- | Crop a behavior of images to a behavior of regions. See 'withinImage'.
532+ => Behavior t Region
533+ -> Behavior t [Image]
534+ -> Behavior t [Image]
535+imagesInRegion reg = liftA2 (\r is -> map (withinImage r) is) reg
537+-- * Running sub-widgets
270−-- | Low-level widget combinator that runs a child 'VtyWidget' within
539+-- | Low-level widget combinator that runs a child widget within
271-- a given region and context. This widget filters and modifies the input
540-- a given region and context. This widget filters and modifies the input
272-- that the child widget receives such that:
541-- that the child widget receives such that:
273-- * unfocused widgets receive no key events
542-- * unfocused widgets receive no key events
@@ -275,364 +544,18 @@ withinImage (Region left top width height)
275-- * mouse inputs inside the region have their coordinates translated such
544-- * mouse inputs inside the region have their coordinates translated such
276-- that (0,0) is the top-left corner of the region
545-- that (0,0) is the top-left corner of the region
278− :: (Reflex t, Monad m, MonadNodeId m)
547+ :: (Reflex t, Monad m, HasInput t m, HasImageWriter t m, HasDisplayRegion t m, HasFocusReader t m)
279− => DynRegion t
548+ => Dynamic t Region
280 -> Dynamic t Bool -- ^ Whether the widget should be focused when the parent is.
549 -> Dynamic t Bool -- ^ Whether the widget should be focused when the parent is.
281− -> VtyWidget t m a
550+ -> m a
282− -> VtyWidget t m a
551+ -> m a
283−pane dr foc child = VtyWidget $ do
552+pane dr foc child = localRegion (const dr) $
284− ctx <- lift ask
553+ mapImages (imagesInRegion $ current dr) $
285− let reg = currentRegion dr
554+ localFocus (const foc) $
286− let ctx' = VtyWidgetCtx
555+ inputInFocusedRegion >>= \e -> localInput (const e) child
287− { _vtyWidgetCtx_input = leftmost -- TODO: think about this leftmost more.
289− attachWith (\(r,f) e -> filterInput r f e)
290− (liftA2 (,) reg (current foc))
291− (_vtyWidgetCtx_input ctx)
293− , _vtyWidgetCtx_focus = liftA2 (&&) (_vtyWidgetCtx_focus ctx) foc
294− , _vtyWidgetCtx_width = _dynRegion_width dr
295− , _vtyWidgetCtx_height = _dynRegion_height dr
297− (result, images) <- lift . lift $ runVtyWidget ctx' child
298− let images' = liftA2 (\r is -> map (withinImage r) is) reg images
302− filterInput :: Region -> Bool -> VtyEvent -> Maybe VtyEvent
303− filterInput (Region l t w h) focused e = case e of
304− V.EvKey _ _ | not focused -> Nothing
305− V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
306− V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
313− , y >= t + h ] = Nothing
315− Just (con (x - l) (y - t))
317−-- | Information about a drag operation
319− { _drag_from :: (Int, Int) -- ^ Where the drag began
320− , _drag_to :: (Int, Int) -- ^ Where the mouse currently is
321− , _drag_button :: V.Button -- ^ Which mouse button is dragging
322− , _drag_modifiers :: [V.Modifier] -- ^ What modifiers are held
323− , _drag_end :: Bool -- ^ Whether the drag ended (the mouse button was released)
325− deriving (Eq, Ord, Show)
327−-- | Converts raw vty mouse drag events into an event stream of 'Drag's
329− :: (Reflex t, MonadFix m, MonadHold t m)
331− -> VtyWidget t m (Event t Drag)
334− let f :: Maybe Drag -> V.Event -> Maybe Drag
336− V.EvMouseDown x y btn' mods
337− | btn == btn' -> Just $ Drag (x,y) (x,y) btn' mods False
338− | otherwise -> Nothing
340− f (Just (Drag from _ _ mods end)) = \case
341− V.EvMouseDown x y btn' mods'
342− | end -> Just $ Drag (x,y) (x,y) btn' mods' False
343− | btn == btn' -> Just $ Drag from (x,y) btn mods' False
344− | otherwise -> Nothing -- Ignore other buttons.
345− V.EvMouseUp x y (Just btn')
347− | btn == btn' -> Just $ Drag from (x,y) btn mods True
348− | otherwise -> Nothing
349− V.EvMouseUp x y Nothing -- Terminal doesn't specify mouse up button,
350− -- assume it's the right one.
352− | otherwise -> Just $ Drag from (x,y) btn mods True
354− rec let newDrag = attachWithMaybe f (current dragD) inp
355− dragD <- holdDyn Nothing $ Just <$> newDrag
356− return (fmapMaybe id $ updated dragD)
358−-- | Mouse down events for a particular mouse button
360− :: (Reflex t, Monad m)
362− -> VtyWidget t m (Event t MouseDown)
365− return $ fforMaybe i $ \case
366− V.EvMouseDown x y btn' mods -> if btn == btn'
367− then Just $ MouseDown btn' (x, y) mods
371−-- | Mouse up events for a particular mouse button
373− :: (Reflex t, Monad m)
374− => VtyWidget t m (Event t MouseUp)
377− return $ fforMaybe i $ \case
378− V.EvMouseUp x y btn' -> Just $ MouseUp btn' (x, y)
381−-- | Information about a mouse down event
557+-- * Misc
382−data MouseDown = MouseDown
383− { _mouseDown_button :: V.Button
384− , _mouseDown_coordinates :: (Int, Int)
385− , _mouseDown_modifiers :: [V.Modifier]
387− deriving (Eq, Ord, Show)
389−-- | Information about a mouse up event
390−data MouseUp = MouseUp
391− { _mouseUp_button :: Maybe V.Button
392− , _mouseUp_coordinates :: (Int, Int)
394− deriving (Eq, Ord, Show)
396−-- | Type synonym for a key and modifier combination
397−type KeyCombo = (V.Key, [V.Modifier])
399−-- | Emits an event that fires on a particular key press (without modifiers)
400−key :: (Monad m, Reflex t) => V.Key -> VtyWidget t m (Event t KeyCombo)
401−key = keyCombos . Set.singleton . (,[])
403−-- | Emits an event that fires on particular key presses (without modifiers)
404−keys :: (Monad m, Reflex t) => [V.Key] -> VtyWidget t m (Event t KeyCombo)
405−keys = keyCombos . Set.fromList . fmap (,[])
407−-- | Emit an event that fires whenever the provided key combination occurs
409− :: (Reflex t, Monad m)
411− -> VtyWidget t m (Event t KeyCombo)
412−keyCombo = keyCombos . Set.singleton
414−-- | Emit an event that fires whenever any of the provided key combinations occur
416− :: (Reflex t, Monad m)
418− -> VtyWidget t m (Event t KeyCombo)
421− return $ fforMaybe i $ \case
422− V.EvKey k m -> if Set.member (k, m) ks
427−-- | A plain split of the available space into vertically stacked panes.
428−-- No visual separator is built in here.
429−splitV :: (Reflex t, Monad m, MonadNodeId m)
430− => Dynamic t (Int -> Int)
431− -- ^ Function used to determine size of first pane based on available size
432− -> Dynamic t (Bool, Bool)
433− -- ^ How to focus the two sub-panes, given that we are focused.
435− -- ^ Widget for first pane
437− -- ^ Widget for second pane
438− -> VtyWidget t m (a,b)
439−splitV sizeFunD focD wA wB = do
442− let regA = DynRegion
443− { _dynRegion_left = pure 0
444− , _dynRegion_top = pure 0
445− , _dynRegion_width = dw
446− , _dynRegion_height = sizeFunD <*> dh
449− { _dynRegion_left = pure 0
450− , _dynRegion_top = _dynRegion_height regA
451− , _dynRegion_width = dw
452− , _dynRegion_height = liftA2 (-) dh (_dynRegion_height regA)
454− ra <- pane regA (fst <$> focD) wA
455− rb <- pane regB (snd <$> focD) wB
458−-- | A split of the available space into two parts with a draggable separator.
459−-- Starts with half the space allocated to each, and the first pane has focus.
460−-- Clicking in a pane switches focus.
461−splitVDrag :: (Reflex t, MonadFix m, MonadHold t m, MonadNodeId m)
465− -> VtyWidget t m (a,b)
466−splitVDrag wS wA wB = do
469− h0 <- sample $ current dh -- TODO
470− dragE <- drag V.BLeft
471− let splitter0 = h0 `div` 2
472− rec splitterCheckpoint <- holdDyn splitter0 $ leftmost [fst <$> ffilter snd dragSplitter, resizeSplitter]
473− splitterPos <- holdDyn splitter0 $ leftmost [fst <$> dragSplitter, resizeSplitter]
474− splitterFrac <- holdDyn ((1::Double) / 2) $ ffor (attach (current dh) (fst <$> dragSplitter)) $ \(h, x) ->
475− fromIntegral x / (max 1 (fromIntegral h))
476− let dragSplitter = fforMaybe (attach (current splitterCheckpoint) dragE) $
477− \(splitterY, Drag (_, fromY) (_, toY) _ _ end) ->
478− if splitterY == fromY then Just (toY, end) else Nothing
479− regA = DynRegion 0 0 dw splitterPos
480− regS = DynRegion 0 splitterPos dw 1
481− regB = DynRegion 0 (splitterPos + 1) dw (dh - splitterPos - 1)
482− resizeSplitter = ffor (attach (current splitterFrac) (updated dh)) $
483− \(frac, h) -> round (frac * fromIntegral h)
484− focA <- holdDyn True $ leftmost
488− (mA, rA) <- pane regA focA $ withMouseDown wA
489− pane regS (pure False) wS
490− (mB, rB) <- pane regB (not <$> focA) $ withMouseDown wB
493− withMouseDown x = do
494− m <- mouseDown V.BLeft
498−-- | Fill the background with a particular character.
499−fill :: (Reflex t, Monad m) => Char -> VtyWidget t m ()
503− let fillImg = current $ liftA2 (\w h -> [V.charFill V.defAttr c w h]) dw dh
506−-- | Fill the background with the bottom
507−hRule :: (Reflex t, Monad m) => BoxStyle -> VtyWidget t m ()
508−hRule boxStyle = fill (_boxStyle_s boxStyle)
510−-- | Defines a set of symbols to use to draw the outlines of boxes
511−-- C.f. https://en.wikipedia.org/wiki/Box-drawing_character
512−data BoxStyle = BoxStyle
513− { _boxStyle_nw :: Char
514− , _boxStyle_n :: Char
515− , _boxStyle_ne :: Char
516− , _boxStyle_e :: Char
517− , _boxStyle_se :: Char
518− , _boxStyle_s :: Char
519− , _boxStyle_sw :: Char
520− , _boxStyle_w :: Char
523−instance Default BoxStyle where
524− def = singleBoxStyle
526−-- | A box style that uses hyphens and pipe characters. Doesn't handle
527−-- corners very well.
528−hyphenBoxStyle :: BoxStyle
529−hyphenBoxStyle = BoxStyle '-' '-' '-' '|' '-' '-' '-' '|'
531−-- | A single line box style
532−singleBoxStyle :: BoxStyle
533−singleBoxStyle = BoxStyle '┌' '─' '┐' '│' '┘' '─' '└' '│'
535−-- | A thick single line box style
536−thickBoxStyle :: BoxStyle
537−thickBoxStyle = BoxStyle '┏' '━' '┓' '┃' '┛' '━' '┗' '┃'
539−-- | A double line box style
540−doubleBoxStyle :: BoxStyle
541−doubleBoxStyle = BoxStyle '╔' '═' '╗' '║' '╝' '═' '╚' '║'
543−-- | A single line box style with rounded corners
544−roundedBoxStyle :: BoxStyle
545−roundedBoxStyle = BoxStyle '╭' '─' '╮' '│' '╯' '─' '╰' '│'
547−-- | Draws a box in the provided style and a child widget inside of that box
548−box :: (Monad m, Reflex t, MonadNodeId m)
549− => Behavior t BoxStyle
552−box boxStyle child = do
555− let boxReg = DynRegion (pure 0) (pure 0) dw dh
556− innerReg = DynRegion (pure 1) (pure 1) (subtract 2 <$> dw) (subtract 2 <$> dh)
557− tellImages (boxImages <$> boxStyle <*> currentRegion boxReg)
558− tellImages (fmap (\r -> [regionBlankImage r]) (currentRegion innerReg))
559− pane innerReg (pure True) child
561− boxImages :: BoxStyle -> Region -> [Image]
562− boxImages style (Region left top width height) =
563− let right = left + width - 1
564− bottom = top + height - 1
566− [ withinImage (Region (left + 1) top (width - 2) 1) $
567− V.charFill V.defAttr (_boxStyle_n style) (width - 2) 1
568− , withinImage (Region right (top + 1) 1 (height - 2)) $
569− V.charFill V.defAttr (_boxStyle_e style) 1 (height - 2)
570− , withinImage (Region (left + 1) bottom (width - 2) 1) $
571− V.charFill V.defAttr (_boxStyle_s style) (width - 2) 1
572− , withinImage (Region left (top + 1) 1 (height - 2)) $
573− V.charFill V.defAttr (_boxStyle_w style) 1 (height - 2)
576− [ withinImage (Region left top 1 1) $
577− V.char V.defAttr (_boxStyle_nw style)
578− , withinImage (Region right top 1 1) $
579− V.char V.defAttr (_boxStyle_ne style)
580− , withinImage (Region right bottom 1 1) $
581− V.char V.defAttr (_boxStyle_se style)
582− , withinImage (Region left bottom 1 1) $
583− V.char V.defAttr (_boxStyle_sw style)
585− in sides ++ if width > 1 && height > 1 then corners else []
587−-- | A box whose style is static
589− :: (Reflex t, Monad m, MonadNodeId m)
593−boxStatic = box . pure
595−-- | Configuration options for displaying "rich" text
596−data RichTextConfig t = RichTextConfig
597− { _richTextConfig_attributes :: Behavior t V.Attr
600−instance Reflex t => Default (RichTextConfig t) where
601− def = RichTextConfig $ pure V.defAttr
603−-- | A widget that displays text with custom time-varying attributes
605− :: (Reflex t, Monad m)
611− let img = (\w a s -> [wrapText w a s])
613− <*> _richTextConfig_attributes cfg
617− wrapText maxWidth attrs = V.vertCat
618− . concatMap (fmap (V.string attrs . T.unpack) . TZ.wrapWithOffset maxWidth 0)
621−-- | Renders text, wrapped to the container width
623− :: (Reflex t, Monad m)
628−-- | Renders any behavior whose value can be converted to
631− :: (Reflex t, Monad m, Show a)
634−display a = text $ T.pack . show <$> a
636-- | A widget that draws nothing
559-- | A widget that draws nothing
637−blank :: Monad m => VtyWidget t m ()
560+blank :: Monad m => m ()
638blank = return ()
561blank = return ()