@@ -2,41 +2,151 @@
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 FlexibleContexts #-}
6+{-# LANGUAGE FlexibleInstances #-}
7+{-# LANGUAGE FunctionalDependencies #-}
8+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
9+{-# LANGUAGE LambdaCase #-}
10+{-# LANGUAGE MultiParamTypeClasses #-}
11+{-# LANGUAGE OverloadedStrings #-}
12+{-# LANGUAGE RankNTypes #-}
13+{-# LANGUAGE RecursiveDo #-}
14+{-# LANGUAGE ScopedTypeVariables #-}
15+{-# LANGUAGE StandaloneDeriving #-}
16+{-# LANGUAGE TypeFamilies #-}
5−{-# Language UndecidableInstances #-}
17+{-# LANGUAGE UndecidableInstances #-}
7−module Reflex.Vty.Widget where
18+module Reflex.Vty.Widget
24+ , mainWidgetWithHandle
9import Control.Applicative (liftA2)
61import Control.Applicative (liftA2)
10import Control.Monad.Fix (MonadFix)
62import Control.Monad.Fix (MonadFix)
11−import Control.Monad.IO.Class (MonadIO)
63+import Control.Monad.Trans (lift)
12−import Control.Monad.Morph
64+import Control.Monad.Trans.Reader (ReaderT, runReaderT, asks, ask)
13−import Control.Monad.NodeId
14−import Control.Monad.Reader (ReaderT, ask, local, runReaderT)
15−import Control.Monad.Ref
65+import Control.Monad.Trans.Writer (WriterT, runWriterT, censor, tell)
16−import Control.Monad.Trans (MonadTrans, lift)
66+import Control.Monad.Writer.Adjustable ()
67+import Data.Default (Default(..))
17−import Data.Set (Set)
68+import Data.Text (Text)
18−import qualified Data.Set as Set
69+import qualified Data.Text as T
70+import qualified Data.Text.Zipper as TZ
19import Graphics.Vty (Image)
71import Graphics.Vty (Image)
20import qualified Graphics.Vty as V
72import qualified Graphics.Vty as V
21import Reflex
73import Reflex
22−import Reflex.Class ()
74+import Reflex.Class.Switchable
75+import Reflex.NotReady.Class
23−import Reflex.Host.Class (MonadReflexCreateTrigger)
76+import Reflex.NotReady.Class.Orphans ()
24import Reflex.Vty.Host
78import Reflex.Vty.Host
26−-- * Running a vty application
80+-- | The context within which a 'VtyWidget' runs
81+data VtyWidgetCtx t = VtyWidgetCtx
82+ { _vtyWidgetCtx_size :: Dynamic t (Int,Int)
83+ -- ^ The width and height of the region allocated to the widget.
84+ , _vtyWidgetCtx_focus :: Dynamic t Bool
85+ -- ^ Whether the widget should behave as if it has focus for keyboard input.
86+ , _vtyWidgetCtx_input :: Event t VtyEvent
87+ -- ^ User input events that the widget's parent chooses to share. These will generally
88+ -- be filtered for relevance:
89+ -- * Keyboard inputs are restricted to focused widgets
90+ -- * Mouse inputs are restricted to the region in which the widget resides and are
91+ -- translated into its internal coordinates.
94+-- | The output of a 'VtyWidget'
95+data VtyWidgetOut t = VtyWidgetOut
96+ { _vtyWidgetOut_images :: Behavior t [Image]
97+ -- ^ The visual output of the 'VtyWidget'
98+ , _vtyWidgetOut_shutdown :: Event t ()
101+instance Reflex t => Semigroup (VtyWidgetOut t) where
102+ wo <> wo' = VtyWidgetOut
103+ { _vtyWidgetOut_images = _vtyWidgetOut_images wo <> _vtyWidgetOut_images wo'
104+ , _vtyWidgetOut_shutdown = _vtyWidgetOut_shutdown wo <> _vtyWidgetOut_shutdown wo'
107+instance (Reflex t) => Monoid (VtyWidgetOut t) where
108+ mempty = VtyWidgetOut mempty mempty
109+ mappend wo wo' = wo <> wo'
111+instance Reflex t => Switchable t (VtyWidgetOut t) where
113+ shutdown <- switching (_vtyWidgetOut_shutdown e0) $ fmap _vtyWidgetOut_shutdown e
114+ images <- switching (_vtyWidgetOut_images e0) $ fmap _vtyWidgetOut_images e
115+ return $ VtyWidgetOut
116+ { _vtyWidgetOut_images = images
117+ , _vtyWidgetOut_shutdown = shutdown
120+-- | A widget that can read its context and produce image output
121+newtype VtyWidget t m a = VtyWidget
122+ { unVtyWidget :: WriterT (VtyWidgetOut t) (ReaderT (VtyWidgetCtx t) m) a
124+ deriving (Functor, Applicative, Monad, MonadSample t, MonadHold t, MonadFix, NotReady t)
126+instance (PostBuild t m, Reflex t) => PostBuild t (VtyWidget t m) where
127+ getPostBuild = VtyWidget $ lift getPostBuild
129+instance (Adjustable t m, MonadHold t m, Reflex t) => Adjustable t (VtyWidget t m) where
130+ runWithReplace a0 a' = VtyWidget $ runWithReplace (unVtyWidget a0) $ fmap unVtyWidget a'
131+ traverseIntMapWithKeyWithAdjust f dm0 dm' = VtyWidget $
132+ traverseIntMapWithKeyWithAdjust (\k v -> unVtyWidget (f k v)) dm0 dm'
133+ traverseDMapWithKeyWithAdjust f dm0 dm' = VtyWidget $ do
134+ traverseDMapWithKeyWithAdjust (\k v -> unVtyWidget (f k v)) dm0 dm'
135+ traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = VtyWidget $ do
136+ traverseDMapWithKeyWithAdjustWithMove (\k v -> unVtyWidget (f k v)) dm0 dm'
138+-- | Runs a 'VtyWidget' with a given context
143+ -> m (a, VtyWidgetOut t)
144+runVtyWidget ctx w = runReaderT (runWriterT (unVtyWidget w)) ctx
28−-- | Sets up the top-level context for a vty widget and runs it with that context
146+-- | Sets up the top-level context for a 'VtyWidget' and runs it with that context
29mainWidgetWithHandle
147mainWidgetWithHandle
32− ( MonadVtyApp t m
149+ -> (forall t m. MonadVtyApp t m => VtyWidget t m ())
35− , HasDisplayRegion t m
41mainWidgetWithHandle vty child =
151mainWidgetWithHandle vty child =
42 runVtyAppWithHandle vty $ \dr0 inp -> do
152 runVtyAppWithHandle vty $ \dr0 inp -> do
@@ -46,178 +156,71 @@ mainWidgetWithHandle vty child =
46 let inp' = fforMaybe inp $ \case
156 let inp' = fforMaybe inp $ \case
47 V.EvResize {} -> Nothing
157 V.EvResize {} -> Nothing
48 x -> Just x
158 x -> Just x
49− (shutdown, images) <- runThemeReader (constant V.defAttr) $
159+ let ctx = VtyWidgetCtx
50− runFocusReader (pure True) $
160+ { _vtyWidgetCtx_size = size
51− runDisplayRegion (fmap (\(w, h) -> Region 0 0 w h) size) $
161+ , _vtyWidgetCtx_input = inp'
52− runImageWriter $
162+ , _vtyWidgetCtx_focus = constDyn True
54− runInput inp' $ do
164+ ((), wo) <- runVtyWidget ctx $ do
55− tellImages . ffor (current size) $ \(w, h) -> [V.charFill V.defAttr ' ' w h]
165+ tellImages . ffor (current size) $ \(w, h) -> [V.charFill V.defAttr ' ' w h]
57 return $ VtyResult
167 return $ VtyResult
58− { _vtyResult_picture = fmap (V.picForLayers . reverse) images
168+ { _vtyResult_picture = fmap (V.picForLayers . reverse) (_vtyWidgetOut_images wo)
59− , _vtyResult_shutdown = shutdown
169+ , _vtyResult_shutdown = _vtyWidgetOut_shutdown wo
62−-- | The output of a vty widget
63−data VtyWidgetOut t = VtyWidgetOut
64− { _vtyWidgetOut_shutdown :: Event t ()
67-- | Like 'mainWidgetWithHandle', but uses a default vty configuration
172-- | Like 'mainWidgetWithHandle', but uses a default vty configuration
68mainWidget
173mainWidget
70− ( MonadVtyApp t m
174+ :: (forall t m. MonadVtyApp t m => VtyWidget t m ())
73− , HasDisplayRegion t m
79mainWidget child = do
176mainWidget child = do
80 vty <- getDefaultVty
177 vty <- getDefaultVty
81 mainWidgetWithHandle vty child
178 mainWidgetWithHandle vty child
83−-- * Input Events
180+-- | A class for things that know their own display size dimensions
181+class (Reflex t, Monad m) => HasDisplaySize t m | m -> t where
182+ displaySize :: m (Dynamic t (Int, Int))
184+instance (Reflex t, Monad m) => HasDisplaySize t (VtyWidget t m) where
185+ displaySize = VtyWidget . lift $ asks _vtyWidgetCtx_size
187+-- | Retrieve the display width (columns)
188+displayWidth :: HasDisplaySize t m => m (Dynamic t Int)
189+displayWidth = fmap fst <$> displaySize
191+-- | Retrieve the display height (rows)
192+displayHeight :: HasDisplaySize t m => m (Dynamic t Int)
193+displayHeight = fmap snd <$> displaySize
85-- | A class for things that can receive vty events as input
195-- | A class for things that can receive vty events as input
86−class HasInput t m | m -> t where
196+class HasVtyInput t m | m -> t where
87 input :: m (Event t VtyEvent)
197 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
114−instance (Adjustable t m, MonadHold t m, Reflex t) => Adjustable t (Input t m) where
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
150−-- | Type synonym for a key and modifier combination
151−type KeyCombo = (V.Key, [V.Modifier])
153−-- | Emits an event that fires on a particular key press (without modifiers)
154−key :: (Monad m, Reflex t, HasInput t m) => V.Key -> m (Event t KeyCombo)
155−key = keyCombos . Set.singleton . (,[])
157−-- | Emits an event that fires on particular key presses (without modifiers)
158−keys :: (Monad m, Reflex t, HasInput t m) => [V.Key] -> m (Event t KeyCombo)
159−keys = keyCombos . Set.fromList . fmap (,[])
161−-- | Emit an event that fires whenever the provided key combination occurs
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
199+instance (Reflex t, Monad m) => HasVtyInput t (VtyWidget t m) where
182−filterKeys :: (Reflex t, HasInput t m) => (KeyCombo -> Bool) -> m a -> m a
200+ input = VtyWidget . lift $ asks _vtyWidgetCtx_input
183−filterKeys f x = localInput (ffilter (\case
201+
184− V.EvKey k mods -> f (k, mods)
202+-- | A class for things that can dynamically gain and lose focus
185− _ -> True)) x
203+class HasFocus t m | m -> t where
186−
204+ focus :: m (Dynamic t Bool)
187−-- | Filter mouse input events based on whether they target a particular region
205+
188−-- and translate them to the internal coordinate system of that region.
206+instance (Reflex t, Monad m) => HasFocus t (VtyWidget t m) where
189−--
207+ focus = VtyWidget . lift $ asks _vtyWidgetCtx_focus
190−-- NB: Non-mouse events are passed through unfiltered and unchanged
208+
191−mouseInRegion :: Region -> VtyEvent -> Maybe VtyEvent
209+-- | A class for widgets that can produce images to draw to the display
192−mouseInRegion (Region l t w h) e = case e of
210+class (Reflex t, Monad m) => ImageWriter t m | m -> t where
193− V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
211+ -- | Send images upstream for rendering
194− V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
212+ tellImages :: Behavior t [Image] -> m ()
196− where
214+instance (Reflex t, Monad m) => ImageWriter t (VtyWidget t m) where
197− mouse con x y
215+ tellImages imgs = VtyWidget $ tell (mempty { _vtyWidgetOut_images = imgs })
199− , y < t
217+-- | A class for things that can shut down the vty application
200− , x >= l + w
218+class (Reflex t, Monad m) => Shutdown t m where
201− , y >= t + h ] = Nothing
219+ -- | Signals that the vty application should shut down
202− | otherwise =
220+ tellShutdown :: Event t () -> m ()
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
222+instance (Reflex t, Monad m) => Shutdown t (VtyWidget t m) where
223+ tellShutdown sd = VtyWidget $ tell (mempty { _vtyWidgetOut_shutdown = sd })
222-- | A chunk of the display area
225-- | A chunk of the display area
223data Region = Region
226data Region = Region
@@ -228,293 +231,14 @@ data Region = Region
229 deriving (Show, Read, Eq, Ord)
232 deriving (Show, Read, Eq, Ord)
231−-- | A region that occupies no space.
233−nilRegion = Region 0 0 0 0
235-- | The width and height of a 'Region'
234-- | The width and height of a 'Region'
236regionSize :: Region -> (Int, Int)
235regionSize :: Region -> (Int, Int)
237regionSize (Region _ _ w h) = (w, h)
236regionSize (Region _ _ w h) = (w, h)
239-- | Produces an 'Image' that fills a region with space characters
238-- | Produces an 'Image' that fills a region with space characters
240−regionBlankImage :: V.Attr -> Region -> Image
239+regionBlankImage :: Region -> Image
241−regionBlankImage attr r@(Region _ _ width height) =
240+regionBlankImage r@(Region _ _ width height) =
242− withinImage r $ V.charFill attr ' ' width height
241+ withinImage r $ V.charFill V.defAttr ' ' 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)
359−instance (Adjustable t m, MonadFix m, MonadHold t m) => Adjustable t (FocusReader t m) where
360− runWithReplace (FocusReader a) e = FocusReader $ runWithReplace a $ fmap unFocusReader e
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
519-- | Translates and crops an 'Image' so that it is contained by
243-- | Translates and crops an 'Image' so that it is contained by
520-- the given 'Region'.
244-- the given 'Region'.
@@ -526,17 +250,7 @@ withinImage (Region left top width height)
526 | width < 0 || height < 0 = withinImage (Region left top 0 0)
250 | width < 0 || height < 0 = withinImage (Region left top 0 0)
527 | otherwise = V.translate left top . V.crop width height
251 | 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
539−-- | Low-level widget combinator that runs a child widget within
253+-- | Low-level widget combinator that runs a child 'VtyWidget' within
540-- a given region and context. This widget filters and modifies the input
254-- a given region and context. This widget filters and modifies the input
541-- that the child widget receives such that:
255-- that the child widget receives such that:
542-- * unfocused widgets receive no key events
256-- * unfocused widgets receive no key events
@@ -544,18 +258,323 @@ imagesInRegion reg = liftA2 (\r is -> map (withinImage r) is) reg
544-- * mouse inputs inside the region have their coordinates translated such
258-- * mouse inputs inside the region have their coordinates translated such
545-- that (0,0) is the top-left corner of the region
259-- that (0,0) is the top-left corner of the region
547− :: (Reflex t, Monad m, HasInput t m, HasImageWriter t m, HasDisplayRegion t m, HasFocusReader t m)
261+ :: (Reflex t, Monad m)
548− => Dynamic t Region
262+ => Dynamic t Region -- ^ Region into which we should draw the widget (in coordinates relative to our own)
549 -> Dynamic t Bool -- ^ Whether the widget should be focused when the parent is.
263 -> Dynamic t Bool -- ^ Whether the widget should be focused when the parent is.
550− -> m a
264+ -> VtyWidget t m a
551− -> m a
265+ -> VtyWidget t m a
552−pane dr foc child = localRegion (const dr) $
266+pane reg foc child = VtyWidget $ do
553− mapImages (imagesInRegion $ current dr) $
267+ ctx <- lift ask
554− localFocus (const foc) $
268+ let ctx' = VtyWidgetCtx
555− inputInFocusedRegion >>= \e -> localInput (const e) child
269+ { _vtyWidgetCtx_input = leftmost -- TODO: think about this leftmost more.
556−
270+ [ fmapMaybe id $
557−-- * Misc
271+ attachWith (\(r,f) e -> filterInput r f e)
558−
272+ (liftA2 (,) (current reg) (current foc))
559−-- | A widget that draws nothing
273+ (_vtyWidgetCtx_input ctx)
275+ , _vtyWidgetCtx_focus = liftA2 (&&) (_vtyWidgetCtx_focus ctx) foc
276+ , _vtyWidgetCtx_size = fmap regionSize reg }
277+ (result, wo) <- lift . lift $ runVtyWidget ctx' child
278+ let images = _vtyWidgetOut_images wo
279+ images' = liftA2 (\r is -> map (withinImage r) is) (current reg) images
280+ wo' = wo { _vtyWidgetOut_images = images' }
284+ filterInput :: Region -> Bool -> VtyEvent -> Maybe VtyEvent
285+ filterInput (Region l t w h) focused e = case e of
286+ V.EvKey _ _ | not focused -> Nothing
287+ V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
288+ V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
295+ , y >= t + h ] = Nothing
297+ Just (con (x - l) (y - t))
299+-- | Information about a drag operation
301+ { _drag_from :: (Int, Int) -- ^ Where the drag began
302+ , _drag_to :: (Int, Int) -- ^ Where the mouse currently is
303+ , _drag_button :: V.Button -- ^ Which mouse button is dragging
304+ , _drag_modifiers :: [V.Modifier] -- ^ What modifiers are held
305+ , _drag_end :: Bool -- ^ Whether the drag ended (the mouse button was released)
307+ deriving (Eq, Ord, Show)
309+-- | Converts raw vty mouse drag events into an event stream of 'Drag's
311+ :: (Reflex t, MonadFix m, MonadHold t m)
313+ -> VtyWidget t m (Event t Drag)
316+ let f :: Maybe Drag -> V.Event -> Maybe Drag
318+ V.EvMouseDown x y btn' mods
319+ | btn == btn' -> Just $ Drag (x,y) (x,y) btn' mods False
320+ | otherwise -> Nothing
322+ f (Just (Drag from _ _ mods end)) = \case
323+ V.EvMouseDown x y btn' mods'
324+ | end -> Just $ Drag (x,y) (x,y) btn' mods' False
325+ | btn == btn' -> Just $ Drag from (x,y) btn mods' False
326+ | otherwise -> Nothing -- Ignore other buttons.
327+ V.EvMouseUp x y (Just btn')
329+ | btn == btn' -> Just $ Drag from (x,y) btn mods True
330+ | otherwise -> Nothing
331+ V.EvMouseUp x y Nothing -- Terminal doesn't specify mouse up button,
332+ -- assume it's the right one.
334+ | otherwise -> Just $ Drag from (x,y) btn mods True
336+ rec let newDrag = attachWithMaybe f (current dragD) inp
337+ dragD <- holdDyn Nothing $ Just <$> newDrag
338+ return (fmapMaybe id $ updated dragD)
340+-- | Mouse down events for a particular mouse button
342+ :: (Reflex t, Monad m)
344+ -> VtyWidget t m (Event t MouseDown)
347+ return $ fforMaybe i $ \case
348+ V.EvMouseDown x y btn' mods -> if btn == btn'
349+ then Just $ MouseDown btn' (x, y) mods
353+-- | Mouse up events for a particular mouse button
355+ :: (Reflex t, Monad m)
356+ => VtyWidget t m (Event t MouseUp)
359+ return $ fforMaybe i $ \case
360+ V.EvMouseUp x y btn' -> Just $ MouseUp btn' (x, y)
363+-- | Information about a mouse down event
364+data MouseDown = MouseDown
365+ { _mouseDown_button :: V.Button
366+ , _mouseDown_coordinates :: (Int, Int)
367+ , _mouseDown_modifiers :: [V.Modifier]
369+ deriving (Eq, Ord, Show)
371+-- | Information about a mouse up event
372+data MouseUp = MouseUp
373+ { _mouseUp_button :: Maybe V.Button
374+ , _mouseUp_coordinates :: (Int, Int)
376+ deriving (Eq, Ord, Show)
378+-- | A plain split of the available space into vertically stacked panes.
379+-- No visual separator is built in here.
380+splitV :: (Reflex t, Monad m)
381+ => Dynamic t (Int -> Int)
382+ -- ^ Function used to determine size of first pane based on available size
383+ -> Dynamic t (Bool, Bool)
384+ -- ^ How to focus the two sub-panes, given that we are focused.
386+ -- ^ Widget for first pane
388+ -- ^ Widget for second pane
389+ -> VtyWidget t m (a,b)
390+splitV sizeFunD focD wA wB = do
392+ let regA = (\f (w,h) -> Region 0 0 w (f h)) <$> sizeFunD <*> sz
393+ regB = (\(w,h) (Region _ _ _ hA) -> Region 0 hA w (h - hA)) <$> sz <*> regA
394+ ra <- pane regA (fst <$> focD) wA
395+ rb <- pane regB (snd <$> focD) wB
398+-- | A split of the available space into two parts with a draggable separator.
399+-- Starts with half the space allocated to each, and the first pane has focus.
400+-- Clicking in a pane switches focus.
401+splitVDrag :: (Reflex t, MonadFix m, MonadHold t m)
405+ -> VtyWidget t m (a,b)
406+splitVDrag wS wA wB = do
408+ (_, h0) <- sample $ current sz
409+ dragE <- drag V.BLeft
410+ let splitter0 = h0 `div` 2
411+ rec splitterCheckpoint <- holdDyn splitter0 $ leftmost [fst <$> ffilter snd dragSplitter, resizeSplitter]
412+ splitterPos <- holdDyn splitter0 $ leftmost [fst <$> dragSplitter, resizeSplitter]
413+ splitterFrac <- holdDyn ((1::Double) / 2) $ ffor (attach (current sz) (fst <$> dragSplitter)) $ \((_,h),x) ->
414+ fromIntegral x / fromIntegral h
415+ let dragSplitter = fforMaybe (attach (current splitterCheckpoint) dragE) $
416+ \(splitterY, Drag (_, fromY) (_, toY) _ _ end) ->
417+ if splitterY == fromY then Just (toY, end) else Nothing
418+ regA = (\(w,_) sp -> Region 0 0 w sp) <$> sz <*> splitterPos
419+ regS = (\(w,_) sp -> Region 0 sp w 1) <$> sz <*> splitterPos
420+ regB = (\(w,h) sp -> Region 0 (sp + 1) w (h - sp - 1)) <$> sz <*> splitterPos
421+ resizeSplitter = ffor (attach (current splitterFrac) (updated sz)) $
422+ \(frac, (_,h)) -> round (frac * fromIntegral h)
423+ focA <- holdDyn True $ leftmost
427+ (mA, rA) <- pane regA focA $ withMouseDown wA
428+ pane regS (pure False) wS
429+ (mB, rB) <- pane regB (not <$> focA) $ withMouseDown wB
432+ withMouseDown x = do
433+ m <- mouseDown V.BLeft
437+-- | Fill the background with a particular character.
438+fill :: (Reflex t, Monad m) => Char -> VtyWidget t m ()
441+ let fillImg = ffor (current sz) $ \(w,h) -> [V.charFill V.defAttr c w h]
444+-- | Fill the background with the bottom
445+hRule :: (Reflex t, Monad m) => BoxStyle -> VtyWidget t m ()
446+hRule boxStyle = fill (_boxStyle_s boxStyle)
448+-- | Transform the images produces by a widget
450+ :: (Reflex t, MonadHold t m, MonadFix m)
451+ => Behavior t ([Image] -> [Image])
454+modifyImages f (VtyWidget w) = VtyWidget $ flip censor w $ \wo ->
455+ wo { _vtyWidgetOut_images = f <*> (_vtyWidgetOut_images wo) }
457+-- | Defines a set of symbols to use to draw the outlines of boxes
458+-- C.f. https://en.wikipedia.org/wiki/Box-drawing_character
459+data BoxStyle = BoxStyle
460+ { _boxStyle_nw :: Char
461+ , _boxStyle_n :: Char
462+ , _boxStyle_ne :: Char
463+ , _boxStyle_e :: Char
464+ , _boxStyle_se :: Char
465+ , _boxStyle_s :: Char
466+ , _boxStyle_sw :: Char
467+ , _boxStyle_w :: Char
470+instance Default BoxStyle where
471+ def = singleBoxStyle
473+-- | A box style that uses hyphens and pipe characters. Doesn't handle
474+-- corners very well.
475+hyphenBoxStyle :: BoxStyle
476+hyphenBoxStyle = BoxStyle '-' '-' '-' '|' '-' '-' '-' '|'
478+-- | A single line box style
479+singleBoxStyle :: BoxStyle
480+singleBoxStyle = BoxStyle '┌' '─' '┐' '│' '┘' '─' '└' '│'
482+-- | A thick single line box style
483+thickBoxStyle :: BoxStyle
484+thickBoxStyle = BoxStyle '┏' '━' '┓' '┃' '┛' '━' '┗' '┃'
486+-- | A double line box style
487+doubleBoxStyle :: BoxStyle
488+doubleBoxStyle = BoxStyle '╔' '═' '╗' '║' '╝' '═' '╚' '║'
490+-- | A single line box style with rounded corners
491+roundedBoxStyle :: BoxStyle
492+roundedBoxStyle = BoxStyle '╭' '─' '╮' '│' '╯' '─' '╰' '│'
494+-- | Draws a box in the provided style and a child widget inside of that box
495+box :: (Monad m, Reflex t)
496+ => Behavior t BoxStyle
499+box boxStyle child = do
501+ let boxReg = ffor (current sz) $ \(w,h) -> Region 0 0 w h
502+ innerReg = ffor sz $ \(w,h) -> Region 1 1 (w - 2) (h - 2)
503+ tellImages (boxImages <$> boxStyle <*> boxReg)
504+ tellImages (fmap (\r -> [regionBlankImage r]) (current innerReg))
505+ pane innerReg (pure True) child
507+ boxImages :: BoxStyle -> Region -> [Image]
508+ boxImages style (Region left top width height) =
509+ let right = left + width - 1
510+ bottom = top + height - 1
512+ [ withinImage (Region (left + 1) top (width - 2) 1) $
513+ V.charFill V.defAttr (_boxStyle_n style) (width - 2) 1
514+ , withinImage (Region right (top + 1) 1 (height - 2)) $
515+ V.charFill V.defAttr (_boxStyle_e style) 1 (height - 2)
516+ , withinImage (Region (left + 1) bottom (width - 2) 1) $
517+ V.charFill V.defAttr (_boxStyle_s style) (width - 2) 1
518+ , withinImage (Region left (top + 1) 1 (height - 2)) $
519+ V.charFill V.defAttr (_boxStyle_w style) 1 (height - 2)
522+ [ withinImage (Region left top 1 1) $
523+ V.char V.defAttr (_boxStyle_nw style)
524+ , withinImage (Region right top 1 1) $
525+ V.char V.defAttr (_boxStyle_ne style)
526+ , withinImage (Region right bottom 1 1) $
527+ V.char V.defAttr (_boxStyle_se style)
528+ , withinImage (Region left bottom 1 1) $
529+ V.char V.defAttr (_boxStyle_sw style)
531+ in sides ++ if width > 1 && height > 1 then corners else []
533+-- | A box whose style is static
560−blank :: Monad m => m ()
535+ :: (Reflex t, Monad m)
561−blank = return ()
536+ => BoxStyle
539+boxStatic = box . pure
541+-- | Configuration options for displaying "rich" text
542+data RichTextConfig t = RichTextConfig
543+ { _richTextConfig_attributes :: Behavior t V.Attr
546+instance Reflex t => Default (RichTextConfig t) where
547+ def = RichTextConfig $ pure V.defAttr
549+-- | A widget that displays text with custom time-varying attributes
551+ :: (Reflex t, Monad m)
557+ let img = (\w a s -> [wrapText w a s])
559+ <*> _richTextConfig_attributes cfg
563+ wrapText maxWidth attrs = V.vertCat
564+ . concatMap (fmap (V.string attrs . T.unpack) . TZ.wrapWithOffset maxWidth 0)
567+-- | Renders text, wrapped to the container width
569+ :: (Reflex t, Monad m)
574+-- | Renders any behavior whose value can be converted to
577+ :: (Reflex t, Monad m, Show a)
580+display a = text $ T.pack . show <$> a