@@ -2,41 +2,155 @@
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 #-}
5−{-# Language UndecidableInstances #-}
18+{-# LANGUAGE UndecidableInstances #-}
7−module Reflex.Vty.Widget where
20+module Reflex.Vty.Widget
27+ , mainWidgetWithHandle
9import Control.Applicative (liftA2)
66import Control.Applicative (liftA2)
10import Control.Monad.Fix (MonadFix)
67import Control.Monad.Fix (MonadFix)
11−import Control.Monad.IO.Class (MonadIO)
68+import Control.Monad.Reader
12−import Control.Monad.Morph
13−import Control.Monad.NodeId
14−import Control.Monad.Reader (ReaderT, ask, local, runReaderT)
15−import Control.Monad.Ref
16−import Control.Monad.Trans (MonadTrans, lift)
69+import Control.Monad.Trans (lift)
70+import Data.Default (Default(..))
17import Data.Set (Set)
71import Data.Set (Set)
18import qualified Data.Set as Set
72import qualified Data.Set as Set
73+import Data.Text (Text)
74+import qualified Data.Text as T
75+import qualified Data.Text.Zipper as TZ
19import Graphics.Vty (Image)
76import Graphics.Vty (Image)
20import qualified Graphics.Vty as V
77import qualified Graphics.Vty as V
21import Reflex
78import Reflex
22import Reflex.Class ()
79import Reflex.Class ()
23import Reflex.Host.Class (MonadReflexCreateTrigger)
80import Reflex.Host.Class (MonadReflexCreateTrigger)
24import Reflex.Vty.Host
82import Reflex.Vty.Host
26−-- * Running a vty application
84+import Control.Monad.NodeId
86+-- | The context within which a 'VtyWidget' runs
87+data VtyWidgetCtx t = VtyWidgetCtx
88+ { _vtyWidgetCtx_width :: Dynamic t Int
89+ -- ^ The width of the region allocated to the widget.
90+ , _vtyWidgetCtx_height :: Dynamic t Int
91+ -- ^ The height of the region allocated to the widget.
92+ , _vtyWidgetCtx_focus :: Dynamic t Bool
93+ -- ^ Whether the widget should behave as if it has focus for keyboard input.
94+ , _vtyWidgetCtx_input :: Event t VtyEvent
95+ -- ^ User input events that the widget's parent chooses to share. These will generally
96+ -- be filtered for relevance:
97+ -- * Keyboard inputs are restricted to focused widgets
98+ -- * Mouse inputs are restricted to the region in which the widget resides and are
99+ -- translated into its internal coordinates.
102+-- | The output of a 'VtyWidget'
103+data VtyWidgetOut t = VtyWidgetOut
104+ { _vtyWidgetOut_shutdown :: Event t ()
107+instance (Adjustable t m, MonadHold t m, Reflex t) => Adjustable t (VtyWidget t m) where
108+ runWithReplace a0 a' = VtyWidget $ runWithReplace (unVtyWidget a0) $ fmap unVtyWidget a'
109+ traverseIntMapWithKeyWithAdjust f dm0 dm' = VtyWidget $
110+ traverseIntMapWithKeyWithAdjust (\k v -> unVtyWidget (f k v)) dm0 dm'
111+ traverseDMapWithKeyWithAdjust f dm0 dm' = VtyWidget $ do
112+ traverseDMapWithKeyWithAdjust (\k v -> unVtyWidget (f k v)) dm0 dm'
113+ traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = VtyWidget $ do
114+ traverseDMapWithKeyWithAdjustWithMove (\k v -> unVtyWidget (f k v)) dm0 dm'
116+-- | A widget that can read its context and produce image output
117+newtype VtyWidget t m a = VtyWidget
118+ { unVtyWidget :: BehaviorWriterT t [Image] (ReaderT (VtyWidgetCtx t) m) a
130+ , MonadReflexCreateTrigger t
134+deriving instance PerformEvent t m => PerformEvent t (VtyWidget t m)
135+instance MonadTrans (VtyWidget t) where
136+ lift f = VtyWidget $ lift $ lift f
138+instance MonadNodeId m => MonadNodeId (VtyWidget t m) where
139+ getNextNodeId = VtyWidget $ do
140+ lift $ lift $ getNextNodeId
142+-- | Runs a 'VtyWidget' with a given context
144+ :: (Reflex t, MonadNodeId m)
147+ -> m (a, Behavior t [Image])
148+runVtyWidget ctx w = runReaderT (runBehaviorWriterT (unVtyWidget w)) ctx
28−-- | Sets up the top-level context for a vty widget and runs it with that context
150+-- | Sets up the top-level context for a 'VtyWidget' and runs it with that context
29mainWidgetWithHandle
151mainWidgetWithHandle
32− ( MonadVtyApp t m
153+ -> (forall t m. (MonadVtyApp t m, MonadNodeId m) => VtyWidget t m (Event t ()))
35− , HasDisplayRegion t m
41mainWidgetWithHandle vty child =
155mainWidgetWithHandle vty child =
42 runVtyAppWithHandle vty $ \dr0 inp -> do
156 runVtyAppWithHandle vty $ \dr0 inp -> do
@@ -46,178 +160,71 @@ mainWidgetWithHandle vty child =
46 let inp' = fforMaybe inp $ \case
160 let inp' = fforMaybe inp $ \case
47 V.EvResize {} -> Nothing
161 V.EvResize {} -> Nothing
48 x -> Just x
162 x -> Just x
49− (shutdown, images) <- runThemeReader (constant V.defAttr) $
163+ let ctx = VtyWidgetCtx
50− runFocusReader (pure True) $
164+ { _vtyWidgetCtx_width = fmap fst size
51− runDisplayRegion (fmap (\(w, h) -> Region 0 0 w h) size) $
165+ , _vtyWidgetCtx_height = fmap snd size
52− runImageWriter $
166+ , _vtyWidgetCtx_input = inp'
53− runNodeIdT $
167+ , _vtyWidgetCtx_focus = constDyn True
54− runInput inp' $ do
168+ }
169+ (shutdown, images) <- runNodeIdT $ runVtyWidget ctx $ do
55− tellImages . ffor (current size) $ \(w, h) -> [V.charFill V.defAttr ' ' w h]
170+ tellImages . ffor (current size) $ \(w, h) -> [V.charFill V.defAttr ' ' w h]
57 return $ VtyResult
172 return $ VtyResult
58 { _vtyResult_picture = fmap (V.picForLayers . reverse) images
173 { _vtyResult_picture = fmap (V.picForLayers . reverse) images
59 , _vtyResult_shutdown = shutdown
174 , _vtyResult_shutdown = shutdown
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
177-- | Like 'mainWidgetWithHandle', but uses a default vty configuration
68mainWidget
178mainWidget
70− ( MonadVtyApp t m
179+ :: (forall t m. (MonadVtyApp t m, MonadNodeId m) => VtyWidget t m (Event t ()))
73− , HasDisplayRegion t m
79mainWidget child = do
181mainWidget child = do
80 vty <- getDefaultVty
182 vty <- getDefaultVty
81 mainWidgetWithHandle vty child
183 mainWidgetWithHandle vty child
83−-- * Input Events
185+-- | A class for things that know their own display size dimensions
186+class (Reflex t, Monad m) => HasDisplaySize t m | m -> t where
187+ -- | Retrieve the display width (columns)
188+ displayWidth :: m (Dynamic t Int)
189+ default displayWidth :: (f m' ~ m, MonadTrans f, HasDisplaySize t m') => m (Dynamic t Int)
190+ displayWidth = lift displayWidth
191+ -- | Retrieve the display height (rows)
192+ displayHeight :: m (Dynamic t Int)
193+ default displayHeight :: (f m' ~ m, MonadTrans f, HasDisplaySize t m') => m (Dynamic t Int)
194+ displayHeight = lift displayHeight
196+instance (Reflex t, Monad m) => HasDisplaySize t (VtyWidget t m) where
197+ displayWidth = VtyWidget . lift $ asks _vtyWidgetCtx_width
198+ displayHeight = VtyWidget . lift $ asks _vtyWidgetCtx_height
200+instance HasDisplaySize t m => HasDisplaySize t (ReaderT x m)
201+instance HasDisplaySize t m => HasDisplaySize t (BehaviorWriterT t x m)
202+instance HasDisplaySize t m => HasDisplaySize t (DynamicWriterT t x m)
203+instance HasDisplaySize t m => HasDisplaySize t (EventWriterT t x m)
205+instance HasDisplaySize t m => HasDisplaySize t (NodeIdT m)
85-- | A class for things that can receive vty events as input
207-- | A class for things that can receive vty events as input
86−class HasInput t m | m -> t where
208+class HasVtyInput t m | m -> t where
87 input :: m (Event t VtyEvent)
209 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)
211+instance (Reflex t, Monad m) => HasVtyInput t (VtyWidget t m) where
158−keys :: (Monad m, Reflex t, HasInput t m) => [V.Key] -> m (Event t KeyCombo)
212+ input = VtyWidget . lift $ asks _vtyWidgetCtx_input
159−keys = keyCombos . Set.fromList . fmap (,[])
161−-- | Emit an event that fires whenever the provided key combination occurs
214+-- | A class for things that can dynamically gain and lose focus
162−keyCombo
215+class HasFocus t m | m -> t where
163− :: (Reflex t, Monad m, HasInput t m)
216+ focus :: m (Dynamic t Bool)
165− -> m (Event t KeyCombo)
166−keyCombo = keyCombos . Set.singleton
168−-- | Emit an event that fires whenever any of the provided key combinations occur
218+instance (Reflex t, Monad m) => HasFocus t (VtyWidget t m) where
169−keyCombos
219+ focus = VtyWidget . lift $ asks _vtyWidgetCtx_focus
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
221+-- | A class for widgets that can produce images to draw to the display
182−filterKeys :: (Reflex t, HasInput t m) => (KeyCombo -> Bool) -> m a -> m a
222+class (Reflex t, Monad m) => ImageWriter t m | m -> t where
183−filterKeys f x = localInput (ffilter (\case
223+ -- | Send images upstream for rendering
184− V.EvKey k mods -> f (k, mods)
224+ tellImages :: Behavior t [Image] -> m ()
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
226+instance (Monad m, Reflex t) => ImageWriter t (BehaviorWriterT t [Image] m) where
227+ tellImages = tellBehavior
222-- | A chunk of the display area
229-- | A chunk of the display area
223data Region = Region
230data Region = Region
@@ -228,293 +235,26 @@ data Region = Region
229 deriving (Show, Read, Eq, Ord)
236 deriving (Show, Read, Eq, Ord)
231−-- | A region that occupies no space.
238+-- | A dynamic chunk of the display area
232−nilRegion :: Region
239+data DynRegion t = DynRegion
233−nilRegion = Region 0 0 0 0
240+ { _dynRegion_left :: Dynamic t Int
241+ , _dynRegion_top :: Dynamic t Int
242+ , _dynRegion_width :: Dynamic t Int
243+ , _dynRegion_height :: Dynamic t Int
235-- | The width and height of a 'Region'
246-- | The width and height of a 'Region'
236regionSize :: Region -> (Int, Int)
247regionSize :: Region -> (Int, Int)
237regionSize (Region _ _ w h) = (w, h)
248regionSize (Region _ _ w h) = (w, h)
239-- | Produces an 'Image' that fills a region with space characters
250-- | Produces an 'Image' that fills a region with space characters
240−regionBlankImage :: V.Attr -> Region -> Image
251+regionBlankImage :: Region -> Image
241−regionBlankImage attr r@(Region _ _ width height) =
252+regionBlankImage r@(Region _ _ width height) =
242− withinImage r $ V.charFill attr ' ' width height
253+ 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)
255+-- | A behavior of the current display area represented by a 'DynRegion'
353−deriving instance NotReady t m => NotReady t (FocusReader t m)
256+currentRegion :: Reflex t => DynRegion t -> Behavior t Region
354−deriving instance PerformEvent t m => PerformEvent t (FocusReader t m)
257+currentRegion (DynRegion l t w h) = Region <$> current l <*> current t <*> current w <*> current h
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
259-- | Translates and crops an 'Image' so that it is contained by
520-- the given 'Region'.
260-- the given 'Region'.
@@ -526,17 +266,7 @@ withinImage (Region left top width height)
526 | width < 0 || height < 0 = withinImage (Region left top 0 0)
266 | width < 0 || height < 0 = withinImage (Region left top 0 0)
527 | otherwise = V.translate left top . V.crop width height
267 | 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
269+-- | Low-level widget combinator that runs a child 'VtyWidget' within
540-- a given region and context. This widget filters and modifies the input
270-- a given region and context. This widget filters and modifies the input
541-- that the child widget receives such that:
271-- that the child widget receives such that:
542-- * unfocused widgets receive no key events
272-- * unfocused widgets receive no key events
@@ -544,18 +274,357 @@ imagesInRegion reg = liftA2 (\r is -> map (withinImage r) is) reg
544-- * mouse inputs inside the region have their coordinates translated such
274-- * mouse inputs inside the region have their coordinates translated such
545-- that (0,0) is the top-left corner of the region
275-- 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)
277+ :: (Reflex t, Monad m, MonadNodeId m)
548− => Dynamic t Region
278+ => DynRegion t
549 -> Dynamic t Bool -- ^ Whether the widget should be focused when the parent is.
279 -> Dynamic t Bool -- ^ Whether the widget should be focused when the parent is.
550− -> m a
280+ -> VtyWidget t m a
551− -> m a
281+ -> VtyWidget t m a
552−pane dr foc child = localRegion (const dr) $
282+pane dr foc child = VtyWidget $ do
553− mapImages (imagesInRegion $ current dr) $
283+ ctx <- lift ask
554− localFocus (const foc) $
284+ let reg = currentRegion dr
555− inputInFocusedRegion >>= \e -> localInput (const e) child
285+ let ctx' = VtyWidgetCtx
286+ { _vtyWidgetCtx_input = leftmost -- TODO: think about this leftmost more.
288+ attachWith (\(r,f) e -> filterInput r f e)
289+ (liftA2 (,) reg (current foc))
290+ (_vtyWidgetCtx_input ctx)
292+ , _vtyWidgetCtx_focus = liftA2 (&&) (_vtyWidgetCtx_focus ctx) foc
293+ , _vtyWidgetCtx_width = _dynRegion_width dr
294+ , _vtyWidgetCtx_height = _dynRegion_height dr
296+ (result, images) <- lift . lift $ runVtyWidget ctx' child
297+ let images' = liftA2 (\r is -> map (withinImage r) is) reg images
301+ filterInput :: Region -> Bool -> VtyEvent -> Maybe VtyEvent
302+ filterInput (Region l t w h) focused e = case e of
303+ V.EvKey _ _ | not focused -> Nothing
304+ V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
305+ V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
312+ , y >= t + h ] = Nothing
314+ Just (con (x - l) (y - t))
316+-- | Information about a drag operation
318+ { _drag_from :: (Int, Int) -- ^ Where the drag began
319+ , _drag_to :: (Int, Int) -- ^ Where the mouse currently is
320+ , _drag_button :: V.Button -- ^ Which mouse button is dragging
321+ , _drag_modifiers :: [V.Modifier] -- ^ What modifiers are held
322+ , _drag_end :: Bool -- ^ Whether the drag ended (the mouse button was released)
324+ deriving (Eq, Ord, Show)
326+-- | Converts raw vty mouse drag events into an event stream of 'Drag's
328+ :: (Reflex t, MonadFix m, MonadHold t m)
330+ -> VtyWidget t m (Event t Drag)
333+ let f :: Maybe Drag -> V.Event -> Maybe Drag
335+ V.EvMouseDown x y btn' mods
336+ | btn == btn' -> Just $ Drag (x,y) (x,y) btn' mods False
337+ | otherwise -> Nothing
339+ f (Just (Drag from _ _ mods end)) = \case
340+ V.EvMouseDown x y btn' mods'
341+ | end -> Just $ Drag (x,y) (x,y) btn' mods' False
342+ | btn == btn' -> Just $ Drag from (x,y) btn mods' False
343+ | otherwise -> Nothing -- Ignore other buttons.
344+ V.EvMouseUp x y (Just btn')
346+ | btn == btn' -> Just $ Drag from (x,y) btn mods True
347+ | otherwise -> Nothing
348+ V.EvMouseUp x y Nothing -- Terminal doesn't specify mouse up button,
349+ -- assume it's the right one.
351+ | otherwise -> Just $ Drag from (x,y) btn mods True
353+ rec let newDrag = attachWithMaybe f (current dragD) inp
354+ dragD <- holdDyn Nothing $ Just <$> newDrag
355+ return (fmapMaybe id $ updated dragD)
357+-- | Mouse down events for a particular mouse button
359+ :: (Reflex t, Monad m)
361+ -> VtyWidget t m (Event t MouseDown)
364+ return $ fforMaybe i $ \case
365+ V.EvMouseDown x y btn' mods -> if btn == btn'
366+ then Just $ MouseDown btn' (x, y) mods
370+-- | Mouse up events for a particular mouse button
372+ :: (Reflex t, Monad m)
373+ => VtyWidget t m (Event t MouseUp)
376+ return $ fforMaybe i $ \case
377+ V.EvMouseUp x y btn' -> Just $ MouseUp btn' (x, y)
380+-- | Information about a mouse down event
381+data MouseDown = MouseDown
382+ { _mouseDown_button :: V.Button
383+ , _mouseDown_coordinates :: (Int, Int)
384+ , _mouseDown_modifiers :: [V.Modifier]
386+ deriving (Eq, Ord, Show)
388+-- | Information about a mouse up event
389+data MouseUp = MouseUp
390+ { _mouseUp_button :: Maybe V.Button
391+ , _mouseUp_coordinates :: (Int, Int)
393+ deriving (Eq, Ord, Show)
395+-- | Type synonym for a key and modifier combination
396+type KeyCombo = (V.Key, [V.Modifier])
398+-- | Emits an event that fires on a particular key press (without modifiers)
399+key :: (Monad m, Reflex t) => V.Key -> VtyWidget t m (Event t KeyCombo)
400+key = keyCombos . Set.singleton . (,[])
402+-- | Emits an event that fires on particular key presses (without modifiers)
403+keys :: (Monad m, Reflex t) => [V.Key] -> VtyWidget t m (Event t KeyCombo)
404+keys = keyCombos . Set.fromList . fmap (,[])
557−-- * Misc
406+-- | Emit an event that fires whenever any of the provided key combinations occur
408+ :: (Reflex t, Monad m)
410+ -> VtyWidget t m (Event t KeyCombo)
413+ return $ fforMaybe i $ \case
414+ V.EvKey k m -> if Set.member (k, m) ks
419+-- | A plain split of the available space into vertically stacked panes.
420+-- No visual separator is built in here.
421+splitV :: (Reflex t, Monad m, MonadNodeId m)
422+ => Dynamic t (Int -> Int)
423+ -- ^ Function used to determine size of first pane based on available size
424+ -> Dynamic t (Bool, Bool)
425+ -- ^ How to focus the two sub-panes, given that we are focused.
427+ -- ^ Widget for first pane
429+ -- ^ Widget for second pane
430+ -> VtyWidget t m (a,b)
431+splitV sizeFunD focD wA wB = do
434+ let regA = DynRegion
435+ { _dynRegion_left = pure 0
436+ , _dynRegion_top = pure 0
437+ , _dynRegion_width = dw
438+ , _dynRegion_height = sizeFunD <*> dh
441+ { _dynRegion_left = pure 0
442+ , _dynRegion_top = _dynRegion_height regA
443+ , _dynRegion_width = dw
444+ , _dynRegion_height = liftA2 (-) dh (_dynRegion_height regA)
446+ ra <- pane regA (fst <$> focD) wA
447+ rb <- pane regB (snd <$> focD) wB
450+-- | A split of the available space into two parts with a draggable separator.
451+-- Starts with half the space allocated to each, and the first pane has focus.
452+-- Clicking in a pane switches focus.
453+splitVDrag :: (Reflex t, MonadFix m, MonadHold t m, MonadNodeId m)
457+ -> VtyWidget t m (a,b)
458+splitVDrag wS wA wB = do
461+ h0 <- sample $ current dh -- TODO
462+ dragE <- drag V.BLeft
463+ let splitter0 = h0 `div` 2
464+ rec splitterCheckpoint <- holdDyn splitter0 $ leftmost [fst <$> ffilter snd dragSplitter, resizeSplitter]
465+ splitterPos <- holdDyn splitter0 $ leftmost [fst <$> dragSplitter, resizeSplitter]
466+ splitterFrac <- holdDyn ((1::Double) / 2) $ ffor (attach (current dh) (fst <$> dragSplitter)) $ \(h, x) ->
467+ fromIntegral x / (max 1 (fromIntegral h))
468+ let dragSplitter = fforMaybe (attach (current splitterCheckpoint) dragE) $
469+ \(splitterY, Drag (_, fromY) (_, toY) _ _ end) ->
470+ if splitterY == fromY then Just (toY, end) else Nothing
471+ regA = DynRegion 0 0 dw splitterPos
472+ regS = DynRegion 0 splitterPos dw 1
473+ regB = DynRegion 0 (splitterPos + 1) dw (dh - splitterPos - 1)
474+ resizeSplitter = ffor (attach (current splitterFrac) (updated dh)) $
475+ \(frac, h) -> round (frac * fromIntegral h)
476+ focA <- holdDyn True $ leftmost
480+ (mA, rA) <- pane regA focA $ withMouseDown wA
481+ pane regS (pure False) wS
482+ (mB, rB) <- pane regB (not <$> focA) $ withMouseDown wB
485+ withMouseDown x = do
486+ m <- mouseDown V.BLeft
490+-- | Fill the background with a particular character.
491+fill :: (Reflex t, Monad m) => Char -> VtyWidget t m ()
495+ let fillImg = current $ liftA2 (\w h -> [V.charFill V.defAttr c w h]) dw dh
498+-- | Fill the background with the bottom
499+hRule :: (Reflex t, Monad m) => BoxStyle -> VtyWidget t m ()
500+hRule boxStyle = fill (_boxStyle_s boxStyle)
502+-- | Defines a set of symbols to use to draw the outlines of boxes
503+-- C.f. https://en.wikipedia.org/wiki/Box-drawing_character
504+data BoxStyle = BoxStyle
505+ { _boxStyle_nw :: Char
506+ , _boxStyle_n :: Char
507+ , _boxStyle_ne :: Char
508+ , _boxStyle_e :: Char
509+ , _boxStyle_se :: Char
510+ , _boxStyle_s :: Char
511+ , _boxStyle_sw :: Char
512+ , _boxStyle_w :: Char
515+instance Default BoxStyle where
516+ def = singleBoxStyle
518+-- | A box style that uses hyphens and pipe characters. Doesn't handle
519+-- corners very well.
520+hyphenBoxStyle :: BoxStyle
521+hyphenBoxStyle = BoxStyle '-' '-' '-' '|' '-' '-' '-' '|'
523+-- | A single line box style
524+singleBoxStyle :: BoxStyle
525+singleBoxStyle = BoxStyle '┌' '─' '┐' '│' '┘' '─' '└' '│'
527+-- | A thick single line box style
528+thickBoxStyle :: BoxStyle
529+thickBoxStyle = BoxStyle '┏' '━' '┓' '┃' '┛' '━' '┗' '┃'
531+-- | A double line box style
532+doubleBoxStyle :: BoxStyle
533+doubleBoxStyle = BoxStyle '╔' '═' '╗' '║' '╝' '═' '╚' '║'
535+-- | A single line box style with rounded corners
536+roundedBoxStyle :: BoxStyle
537+roundedBoxStyle = BoxStyle '╭' '─' '╮' '│' '╯' '─' '╰' '│'
539+-- | Draws a box in the provided style and a child widget inside of that box
540+box :: (Monad m, Reflex t, MonadNodeId m)
541+ => Behavior t BoxStyle
544+box boxStyle child = do
547+ let boxReg = DynRegion (pure 0) (pure 0) dw dh
548+ innerReg = DynRegion (pure 1) (pure 1) (subtract 2 <$> dw) (subtract 2 <$> dh)
549+ tellImages (boxImages <$> boxStyle <*> currentRegion boxReg)
550+ tellImages (fmap (\r -> [regionBlankImage r]) (currentRegion innerReg))
551+ pane innerReg (pure True) child
553+ boxImages :: BoxStyle -> Region -> [Image]
554+ boxImages style (Region left top width height) =
555+ let right = left + width - 1
556+ bottom = top + height - 1
558+ [ withinImage (Region (left + 1) top (width - 2) 1) $
559+ V.charFill V.defAttr (_boxStyle_n style) (width - 2) 1
560+ , withinImage (Region right (top + 1) 1 (height - 2)) $
561+ V.charFill V.defAttr (_boxStyle_e style) 1 (height - 2)
562+ , withinImage (Region (left + 1) bottom (width - 2) 1) $
563+ V.charFill V.defAttr (_boxStyle_s style) (width - 2) 1
564+ , withinImage (Region left (top + 1) 1 (height - 2)) $
565+ V.charFill V.defAttr (_boxStyle_w style) 1 (height - 2)
568+ [ withinImage (Region left top 1 1) $
569+ V.char V.defAttr (_boxStyle_nw style)
570+ , withinImage (Region right top 1 1) $
571+ V.char V.defAttr (_boxStyle_ne style)
572+ , withinImage (Region right bottom 1 1) $
573+ V.char V.defAttr (_boxStyle_se style)
574+ , withinImage (Region left bottom 1 1) $
575+ V.char V.defAttr (_boxStyle_sw style)
577+ in sides ++ if width > 1 && height > 1 then corners else []
579+-- | A box whose style is static
581+ :: (Reflex t, Monad m, MonadNodeId m)
585+boxStatic = box . pure
587+-- | Configuration options for displaying "rich" text
588+data RichTextConfig t = RichTextConfig
589+ { _richTextConfig_attributes :: Behavior t V.Attr
592+instance Reflex t => Default (RichTextConfig t) where
593+ def = RichTextConfig $ pure V.defAttr
595+-- | A widget that displays text with custom time-varying attributes
597+ :: (Reflex t, Monad m)
603+ let img = (\w a s -> [wrapText w a s])
605+ <*> _richTextConfig_attributes cfg
609+ wrapText maxWidth attrs = V.vertCat
610+ . concatMap (fmap (V.string attrs . T.unpack) . TZ.wrapWithOffset maxWidth 0)
613+-- | Renders text, wrapped to the container width
615+ :: (Reflex t, Monad m)
620+-- | Renders any behavior whose value can be converted to
623+ :: (Reflex t, Monad m, Show a)
626+display a = text $ T.pack . show <$> a
559-- | A widget that draws nothing
628-- | A widget that draws nothing
560−blank :: Monad m => m ()
629+blank :: Monad m => VtyWidget t m ()
561blank = return ()
630blank = return ()