@@ -2,147 +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 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 #-}
17โ{-# LANGUAGE UndecidableInstances #-}
5+{-# Language UndecidableInstances #-}
18โmodule Reflex.Vty.Widget
7+module Reflex.Vty.Widget where
24โ , mainWidgetWithHandle
25โ , HasDisplaySize(..)
57import Control.Applicative (liftA2)
9import Control.Applicative (liftA2)
58import Control.Monad.Fix (MonadFix)
10import Control.Monad.Fix (MonadFix)
59โimport Control.Monad.Trans (lift)
11+import Control.Monad.IO.Class (MonadIO)
60โimport Control.Monad.Trans.Reader (ReaderT, runReaderT, asks, ask)
12+import Control.Monad.Morph
13+import Control.Monad.NodeId
14+import Control.Monad.Reader (ReaderT, ask, local, runReaderT)
61โimport Control.Monad.Trans.Writer (WriterT, runWriterT, censor, tell)
15+import Control.Monad.Ref
62โimport Control.Monad.Writer.Adjustable ()
16+import Control.Monad.Trans (MonadTrans, lift)
63โimport Data.Default (Default(..))
64โimport Data.Text (Text)
17+import Data.Set (Set)
65โimport qualified Data.Text as T
18+import qualified Data.Set as Set
66โimport qualified Data.Text.Zipper as TZ
67import Graphics.Vty (Image)
19import Graphics.Vty (Image)
68import qualified Graphics.Vty as V
20import qualified Graphics.Vty as V
69import Reflex
21import Reflex
70โimport Reflex.Class.Switchable
22+import Reflex.Class ()
71โimport Reflex.NotReady.Class
72โimport Reflex.NotReady.Class.Orphans ()
23+import Reflex.Host.Class (MonadReflexCreateTrigger)
74import Reflex.Vty.Host
24import Reflex.Vty.Host
76โ-- | The context within which a 'VtyWidget' runs
26+-- * Running a vty application
77โdata VtyWidgetCtx t = VtyWidgetCtx
78โ { _vtyWidgetCtx_size :: Dynamic t (Int,Int)
79โ -- ^ The width and height of the region allocated to the widget.
80โ , _vtyWidgetCtx_focus :: Dynamic t Bool
81โ -- ^ Whether the widget should behave as if it has focus for keyboard input.
82โ , _vtyWidgetCtx_input :: Event t VtyEvent
83โ -- ^ User input events that the widget's parent chooses to share. These will generally
84โ -- be filtered for relevance:
85โ -- * Keyboard inputs are restricted to focused widgets
86โ -- * Mouse inputs are restricted to the region in which the widget resides and are
87โ -- translated into its internal coordinates.
90โ-- | The output of a 'VtyWidget'
91โdata VtyWidgetOut t = VtyWidgetOut
92โ { _vtyWidgetOut_images :: Behavior t [Image]
93โ -- ^ The visual output of the 'VtyWidget'
94โ , _vtyWidgetOut_shutdown :: Event t ()
97โinstance Reflex t => Semigroup (VtyWidgetOut t) where
98โ wo <> wo' = VtyWidgetOut
99โ { _vtyWidgetOut_images = _vtyWidgetOut_images wo <> _vtyWidgetOut_images wo'
100โ , _vtyWidgetOut_shutdown = _vtyWidgetOut_shutdown wo <> _vtyWidgetOut_shutdown wo'
103โinstance (Reflex t) => Monoid (VtyWidgetOut t) where
104โ mempty = VtyWidgetOut mempty mempty
105โ mappend wo wo' = wo <> wo'
107โinstance Reflex t => Switchable t (VtyWidgetOut t) where
108โ switching e0 e = do
109โ shutdown <- switching (_vtyWidgetOut_shutdown e0) $ fmap _vtyWidgetOut_shutdown e
110โ images <- switching (_vtyWidgetOut_images e0) $ fmap _vtyWidgetOut_images e
111โ return $ VtyWidgetOut
112โ { _vtyWidgetOut_images = images
113โ , _vtyWidgetOut_shutdown = shutdown
116โ-- | A widget that can read its context and produce image output
117โnewtype VtyWidget t m a = VtyWidget
118โ { unVtyWidget :: WriterT (VtyWidgetOut t) (ReaderT (VtyWidgetCtx t) m) a
120โ deriving (Functor, Applicative, Monad, MonadSample t, MonadHold t, MonadFix, NotReady t)
122โinstance (PostBuild t m, Reflex t) => PostBuild t (VtyWidget t m) where
123โ getPostBuild = VtyWidget $ lift getPostBuild
125โinstance (Adjustable t m, MonadHold t m, Reflex t) => Adjustable t (VtyWidget t m) where
126โ runWithReplace a0 a' = VtyWidget $ runWithReplace (unVtyWidget a0) $ fmap unVtyWidget a'
127โ traverseIntMapWithKeyWithAdjust f dm0 dm' = VtyWidget $
128โ traverseIntMapWithKeyWithAdjust (\k v -> unVtyWidget (f k v)) dm0 dm'
129โ traverseDMapWithKeyWithAdjust f dm0 dm' = VtyWidget $ do
130โ traverseDMapWithKeyWithAdjust (\k v -> unVtyWidget (f k v)) dm0 dm'
131โ traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = VtyWidget $ do
132โ traverseDMapWithKeyWithAdjustWithMove (\k v -> unVtyWidget (f k v)) dm0 dm'
134โ-- | Runs a 'VtyWidget' with a given context
138โ -> VtyWidget t m a
139โ -> m (a, VtyWidgetOut t)
140โrunVtyWidget ctx w = runReaderT (runWriterT (unVtyWidget w)) ctx
142โ-- | 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
143mainWidgetWithHandle
29mainWidgetWithHandle
145โ -> (forall t m. MonadVtyApp t m => VtyWidget t m ())
32+ ( MonadVtyApp t m
35+ , HasDisplayRegion t m
147mainWidgetWithHandle vty child =
41mainWidgetWithHandle vty child =
148 runVtyAppWithHandle vty $ \dr0 inp -> do
42 runVtyAppWithHandle vty $ \dr0 inp -> do
@@ -152,71 +46,178 @@ mainWidgetWithHandle vty child =
152 let inp' = fforMaybe inp $ \case
46 let inp' = fforMaybe inp $ \case
153 V.EvResize {} -> Nothing
47 V.EvResize {} -> Nothing
154 x -> Just x
48 x -> Just x
155โ let ctx = VtyWidgetCtx
49+ (shutdown, images) <- runThemeReader (constant V.defAttr) $
156โ { _vtyWidgetCtx_size = size
50+ runFocusReader (pure True) $
157โ , _vtyWidgetCtx_input = inp'
51+ runDisplayRegion (fmap (\(w, h) -> Region 0 0 w h) size) $
158โ , _vtyWidgetCtx_focus = constDyn True
52+ runImageWriter $
160โ ((), wo) <- runVtyWidget ctx $ do
54+ runInput inp' $ do
161โ 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]
163 return $ VtyResult
57 return $ VtyResult
164โ { _vtyResult_picture = fmap (V.picForLayers . reverse) (_vtyWidgetOut_images wo)
58+ { _vtyResult_picture = fmap (V.picForLayers . reverse) images
165โ , _vtyResult_shutdown = _vtyWidgetOut_shutdown wo
59+ , _vtyResult_shutdown = shutdown
62+-- | The output of a vty widget
63+data VtyWidgetOut t = VtyWidgetOut
64+ { _vtyWidgetOut_shutdown :: Event t ()
168-- | Like 'mainWidgetWithHandle', but uses a default vty configuration
67-- | Like 'mainWidgetWithHandle', but uses a default vty configuration
169mainWidget
68mainWidget
170โ :: (forall t m. MonadVtyApp t m => VtyWidget t m ())
70+ ( MonadVtyApp t m
73+ , HasDisplayRegion t m
172mainWidget child = do
79mainWidget child = do
173 vty <- getDefaultVty
80 vty <- getDefaultVty
174 mainWidgetWithHandle vty child
81 mainWidgetWithHandle vty child
176โ-- | A class for things that know their own display size dimensions
83+-- * Input Events
177โclass (Reflex t, Monad m) => HasDisplaySize t m | m -> t where
178โ displaySize :: m (Dynamic t (Int, Int))
180โinstance (Reflex t, Monad m) => HasDisplaySize t (VtyWidget t m) where
181โ displaySize = VtyWidget . lift $ asks _vtyWidgetCtx_size
183โ-- | Retrieve the display width (columns)
184โdisplayWidth :: HasDisplaySize t m => m (Dynamic t Int)
185โdisplayWidth = fmap fst <$> displaySize
187โ-- | Retrieve the display height (rows)
188โdisplayHeight :: HasDisplaySize t m => m (Dynamic t Int)
189โdisplayHeight = fmap snd <$> displaySize
191-- | A class for things that can receive vty events as input
85-- | A class for things that can receive vty events as input
192โclass HasVtyInput t m | m -> t where
86+class HasInput t m | m -> t where
193 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
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
195โinstance (Reflex t, Monad m) => HasVtyInput t (VtyWidget t m) where
181+-- | Filter the keyboard input that a child widget may receive
196โ input = VtyWidget . lift $ asks _vtyWidgetCtx_input
182+filterKeys :: (Reflex t, HasInput t m) => (KeyCombo -> Bool) -> m a -> m a
197โ
183+filterKeys f x = localInput (ffilter (\case
198โ-- | A class for things that can dynamically gain and lose focus
184+ V.EvKey k mods -> f (k, mods)
199โclass HasFocus t m | m -> t where
185+ _ -> True)) x
200โ focus :: m (Dynamic t Bool)
186+
201โ
187+-- | Filter mouse input events based on whether they target a particular region
202โinstance (Reflex t, Monad m) => HasFocus t (VtyWidget t m) where
188+-- and translate them to the internal coordinate system of that region.
203โ focus = VtyWidget . lift $ asks _vtyWidgetCtx_focus
189+--
204โ
190+-- NB: Non-mouse events are passed through unfiltered and unchanged
205โ-- | A class for widgets that can produce images to draw to the display
191+mouseInRegion :: Region -> VtyEvent -> Maybe VtyEvent
206โclass (Reflex t, Monad m) => ImageWriter t m | m -> t where
192+mouseInRegion (Region l t w h) e = case e of
207โ -- | Send images upstream for rendering
193+ V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
208โ tellImages :: Behavior t [Image] -> m ()
194+ V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
210โinstance (Reflex t, Monad m) => ImageWriter t (VtyWidget t m) where
196+ where
211โ tellImages imgs = VtyWidget $ tell (mempty { _vtyWidgetOut_images = imgs })
197+ mouse con x y
213โ-- | A class for things that can shut down the vty application
199+ , y < t
214โclass (Reflex t, Monad m) => Shutdown t m where
200+ , x >= l + w
215โ -- | Signals that the vty application should shut down
201+ , y >= t + h ] = Nothing
216โ tellShutdown :: Event t () -> m ()
202+ | otherwise =
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
218โinstance (Reflex t, Monad m) => Shutdown t (VtyWidget t m) where
220+-- * Getting and setting the display region
219โ tellShutdown sd = VtyWidget $ tell (mempty { _vtyWidgetOut_shutdown = sd })
221-- | A chunk of the display area
222-- | A chunk of the display area
222data Region = Region
223data Region = Region
@@ -227,14 +228,293 @@ data Region = Region
228 deriving (Show, Read, Eq, Ord)
229 deriving (Show, Read, Eq, Ord)
231+-- | A region that occupies no space.
233+nilRegion = Region 0 0 0 0
230-- | The width and height of a 'Region'
235-- | The width and height of a 'Region'
231regionSize :: Region -> (Int, Int)
236regionSize :: Region -> (Int, Int)
232regionSize (Region _ _ w h) = (w, h)
237regionSize (Region _ _ w h) = (w, h)
234-- | Produces an 'Image' that fills a region with space characters
239-- | Produces an 'Image' that fills a region with space characters
235โregionBlankImage :: Region -> Image
240+regionBlankImage :: V.Attr -> Region -> Image
236โregionBlankImage r@(Region _ _ width height) =
241+regionBlankImage attr r@(Region _ _ width height) =
237โ 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)
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
239-- | Translates and crops an 'Image' so that it is contained by
519-- | Translates and crops an 'Image' so that it is contained by
240-- the given 'Region'.
520-- the given 'Region'.
@@ -246,7 +526,17 @@ withinImage (Region left top width height)
246 | width < 0 || height < 0 = withinImage (Region left top 0 0)
526 | width < 0 || height < 0 = withinImage (Region left top 0 0)
247 | 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
249โ-- | Low-level widget combinator that runs a child 'VtyWidget' within
539+-- | Low-level widget combinator that runs a child widget within
250-- 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
251-- that the child widget receives such that:
541-- that the child widget receives such that:
252-- * unfocused widgets receive no key events
542-- * unfocused widgets receive no key events
@@ -254,298 +544,18 @@ withinImage (Region left top width height)
254-- * mouse inputs inside the region have their coordinates translated such
544-- * mouse inputs inside the region have their coordinates translated such
255-- that (0,0) is the top-left corner of the region
545-- that (0,0) is the top-left corner of the region
257โ :: (Reflex t, Monad m)
547+ :: (Reflex t, Monad m, HasInput t m, HasImageWriter t m, HasDisplayRegion t m, HasFocusReader t m)
258โ => Dynamic t Region -- ^ Region into which we should draw the widget (in coordinates relative to our own)
548+ => Dynamic t Region
259 -> 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.
260โ -> VtyWidget t m a
550+ -> m a
261โ -> VtyWidget t m a
551+ -> m a
262โpane reg foc child = VtyWidget $ do
552+pane dr foc child = localRegion (const dr) $
263โ ctx <- lift ask
553+ mapImages (imagesInRegion $ current dr) $
264โ let ctx' = VtyWidgetCtx
554+ localFocus (const foc) $
265โ { _vtyWidgetCtx_input = leftmost -- TODO: think about this leftmost more.
555+ inputInFocusedRegion >>= \e -> localInput (const e) child
266โ [ fmapMaybe id $
556+
267โ attachWith (\(r,f) e -> filterInput r f e)
557+-- * Misc
268โ (liftA2 (,) (current reg) (current foc))
558+
269โ (_vtyWidgetCtx_input ctx)
559+-- | A widget that draws nothing
271โ , _vtyWidgetCtx_focus = liftA2 (&&) (_vtyWidgetCtx_focus ctx) foc
272โ , _vtyWidgetCtx_size = fmap regionSize reg }
273โ (result, wo) <- lift . lift $ runVtyWidget ctx' child
274โ let images = _vtyWidgetOut_images wo
275โ images' = liftA2 (\r is -> map (withinImage r) is) (current reg) images
276โ wo' = wo { _vtyWidgetOut_images = images' }
280โ filterInput :: Region -> Bool -> VtyEvent -> Maybe VtyEvent
281โ filterInput (Region l t w h) focused e = case e of
282โ V.EvKey _ _ | not focused -> Nothing
283โ V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
284โ V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
291โ , y >= t + h ] = Nothing
293โ Just (con (x - l) (y - t))
295โ-- | Information about a drag operation
297โ { _drag_from :: (Int, Int) -- ^ Where the drag began
298โ , _drag_to :: (Int, Int) -- ^ Where the mouse currently is
299โ , _drag_button :: V.Button -- ^ Which mouse button is dragging
300โ , _drag_modifiers :: [V.Modifier] -- ^ What modifiers are held
301โ , _drag_end :: Bool -- ^ Whether the drag ended (the mouse button was released)
303โ deriving (Eq, Ord, Show)
305โ-- | Converts raw vty mouse drag events into an event stream of 'Drag's
307โ :: (Reflex t, MonadFix m, MonadHold t m)
309โ -> VtyWidget t m (Event t Drag)
312โ let f :: Maybe Drag -> V.Event -> Maybe Drag
314โ V.EvMouseDown x y btn' mods
315โ | btn == btn' -> Just $ Drag (x,y) (x,y) btn' mods False
316โ | otherwise -> Nothing
318โ f (Just (Drag from _ _ mods end)) = \case
319โ V.EvMouseDown x y btn' mods'
320โ | end -> Just $ Drag (x,y) (x,y) btn' mods' False
321โ | btn == btn' -> Just $ Drag from (x,y) btn mods' False
322โ | otherwise -> Nothing -- Ignore other buttons.
323โ V.EvMouseUp x y (Just btn')
325โ | btn == btn' -> Just $ Drag from (x,y) btn mods True
326โ | otherwise -> Nothing
327โ V.EvMouseUp x y Nothing -- Terminal doesn't specify mouse up button,
328โ -- assume it's the right one.
330โ | otherwise -> Just $ Drag from (x,y) btn mods True
332โ rec let newDrag = attachWithMaybe f (current dragD) inp
333โ dragD <- holdDyn Nothing $ Just <$> newDrag
334โ return (fmapMaybe id $ updated dragD)
336โ-- | Mouse down events for a particular mouse button
338โ :: (Reflex t, Monad m)
340โ -> VtyWidget t m (Event t MouseDown)
343โ return $ fforMaybe i $ \case
344โ V.EvMouseDown x y btn' mods -> if btn == btn'
345โ then Just $ MouseDown btn' (x, y) mods
349โ-- | Mouse up events for a particular mouse button
351โ :: (Reflex t, Monad m)
352โ => VtyWidget t m (Event t MouseUp)
355โ return $ fforMaybe i $ \case
356โ V.EvMouseUp x y btn' -> Just $ MouseUp btn' (x, y)
359โ-- | Information about a mouse down event
360โdata MouseDown = MouseDown
361โ { _mouseDown_button :: V.Button
362โ , _mouseDown_coordinates :: (Int, Int)
363โ , _mouseDown_modifiers :: [V.Modifier]
365โ deriving (Eq, Ord, Show)
367โ-- | Information about a mouse up event
368โdata MouseUp = MouseUp
369โ { _mouseUp_button :: Maybe V.Button
370โ , _mouseUp_coordinates :: (Int, Int)
372โ deriving (Eq, Ord, Show)
374โ-- | A plain split of the available space into vertically stacked panes.
375โ-- No visual separator is built in here.
376โsplitV :: (Reflex t, Monad m)
377โ => Dynamic t (Int -> Int)
378โ -- ^ Function used to determine size of first pane based on available size
379โ -> Dynamic t (Bool, Bool)
380โ -- ^ How to focus the two sub-panes, given that we are focused.
381โ -> VtyWidget t m a
382โ -- ^ Widget for first pane
383โ -> VtyWidget t m b
384โ -- ^ Widget for second pane
385โ -> VtyWidget t m (a,b)
386โsplitV sizeFunD focD wA wB = do
388โ let regA = (\f (w,h) -> Region 0 0 w (f h)) <$> sizeFunD <*> sz
389โ regB = (\(w,h) (Region _ _ _ hA) -> Region 0 hA w (h - hA)) <$> sz <*> regA
390โ ra <- pane regA (fst <$> focD) wA
391โ rb <- pane regB (snd <$> focD) wB
394โ-- | A split of the available space into two parts with a draggable separator.
395โ-- Starts with half the space allocated to each, and the first pane has focus.
396โ-- Clicking in a pane switches focus.
397โsplitVDrag :: (Reflex t, MonadFix m, MonadHold t m)
398โ => VtyWidget t m ()
399โ -> VtyWidget t m a
400โ -> VtyWidget t m b
401โ -> VtyWidget t m (a,b)
402โsplitVDrag wS wA wB = do
404โ (_, h0) <- sample $ current sz
405โ dragE <- drag V.BLeft
406โ let splitter0 = h0 `div` 2
407โ rec splitterCheckpoint <- holdDyn splitter0 $ leftmost [fst <$> ffilter snd dragSplitter, resizeSplitter]
408โ splitterPos <- holdDyn splitter0 $ leftmost [fst <$> dragSplitter, resizeSplitter]
409โ splitterFrac <- holdDyn ((1::Double) / 2) $ ffor (attach (current sz) (fst <$> dragSplitter)) $ \((_,h),x) ->
410โ fromIntegral x / fromIntegral h
411โ let dragSplitter = fforMaybe (attach (current splitterCheckpoint) dragE) $
412โ \(splitterY, Drag (_, fromY) (_, toY) _ _ end) ->
413โ if splitterY == fromY then Just (toY, end) else Nothing
414โ regA = (\(w,_) sp -> Region 0 0 w sp) <$> sz <*> splitterPos
415โ regS = (\(w,_) sp -> Region 0 sp w 1) <$> sz <*> splitterPos
416โ regB = (\(w,h) sp -> Region 0 (sp + 1) w (h - sp - 1)) <$> sz <*> splitterPos
417โ resizeSplitter = ffor (attach (current splitterFrac) (updated sz)) $
418โ \(frac, (_,h)) -> round (frac * fromIntegral h)
419โ focA <- holdDyn True $ leftmost
423โ (mA, rA) <- pane regA focA $ withMouseDown wA
424โ pane regS (pure False) wS
425โ (mB, rB) <- pane regB (not <$> focA) $ withMouseDown wB
428โ withMouseDown x = do
429โ m <- mouseDown V.BLeft
433โ-- | Fill the background with a particular character.
434โfill :: (Reflex t, Monad m) => Char -> VtyWidget t m ()
437โ let fillImg = ffor (current sz) $ \(w,h) -> [V.charFill V.defAttr c w h]
438โ tellImages fillImg
440โ-- | Fill the background with the bottom
441โhRule :: (Reflex t, Monad m) => BoxStyle -> VtyWidget t m ()
442โhRule boxStyle = fill (_boxStyle_s boxStyle)
444โ-- | Transform the images produces by a widget
446โ :: (Reflex t, MonadHold t m, MonadFix m)
447โ => Behavior t ([Image] -> [Image])
448โ -> VtyWidget t m a
449โ -> VtyWidget t m a
450โmodifyImages f (VtyWidget w) = VtyWidget $ flip censor w $ \wo ->
451โ wo { _vtyWidgetOut_images = f <*> (_vtyWidgetOut_images wo) }
453โ-- | Defines a set of symbols to use to draw the outlines of boxes
454โ-- C.f. https://en.wikipedia.org/wiki/Box-drawing_character
455โdata BoxStyle = BoxStyle
456โ { _boxStyle_nw :: Char
457โ , _boxStyle_n :: Char
458โ , _boxStyle_ne :: Char
459โ , _boxStyle_e :: Char
460โ , _boxStyle_se :: Char
461โ , _boxStyle_s :: Char
462โ , _boxStyle_sw :: Char
463โ , _boxStyle_w :: Char
466โinstance Default BoxStyle where
467โ def = singleBoxStyle
469โ-- | A box style that uses hyphens and pipe characters. Doesn't handle
470โ-- corners very well.
471โhyphenBoxStyle :: BoxStyle
472โhyphenBoxStyle = BoxStyle '-' '-' '-' '|' '-' '-' '-' '|'
474โ-- | A single line box style
475โsingleBoxStyle :: BoxStyle
476โsingleBoxStyle = BoxStyle 'โ' 'โ' 'โ' 'โ' 'โ' 'โ' 'โ' 'โ'
478โ-- | A thick single line box style
479โthickBoxStyle :: BoxStyle
480โthickBoxStyle = BoxStyle 'โ' 'โ' 'โ' 'โ' 'โ' 'โ' 'โ' 'โ'
482โ-- | A double line box style
483โdoubleBoxStyle :: BoxStyle
484โdoubleBoxStyle = BoxStyle 'โ' 'โ' 'โ' 'โ' 'โ' 'โ' 'โ' 'โ'
486โ-- | A single line box style with rounded corners
487โroundedBoxStyle :: BoxStyle
488โroundedBoxStyle = BoxStyle 'โญ' 'โ' 'โฎ' 'โ' 'โฏ' 'โ' 'โฐ' 'โ'
490โ-- | Draws a box in the provided style and a child widget inside of that box
491โbox :: (Monad m, Reflex t)
560+blank :: Monad m => m ()
492โ => BoxStyle
561+blank = return ()
493โ -> VtyWidget t m a
494โ -> VtyWidget t m a
495โbox style child = do
497โ let boxReg = ffor (current sz) $ \(w,h) -> Region 0 0 w h
498โ innerReg = ffor sz $ \(w,h) -> Region 1 1 (w - 2) (h - 2)
499โ tellImages (fmap boxImages boxReg)
500โ tellImages (fmap (\r -> [regionBlankImage r]) (current innerReg))
501โ pane innerReg (pure True) child
503โ boxImages :: Region -> [Image]
504โ boxImages (Region left top width height) =
505โ let right = left + width - 1
506โ bottom = top + height - 1
508โ [ withinImage (Region (left + 1) top (width - 2) 1) $
509โ V.charFill V.defAttr (_boxStyle_n style) (width - 2) 1
510โ , withinImage (Region right (top + 1) 1 (height - 2)) $
511โ V.charFill V.defAttr (_boxStyle_e style) 1 (height - 2)
512โ , withinImage (Region (left + 1) bottom (width - 2) 1) $
513โ V.charFill V.defAttr (_boxStyle_s style) (width - 2) 1
514โ , withinImage (Region left (top + 1) 1 (height - 2)) $
515โ V.charFill V.defAttr (_boxStyle_w style) 1 (height - 2)
518โ [ withinImage (Region left top 1 1) $
519โ V.char V.defAttr (_boxStyle_nw style)
520โ , withinImage (Region right top 1 1) $
521โ V.char V.defAttr (_boxStyle_ne style)
522โ , withinImage (Region right bottom 1 1) $
523โ V.char V.defAttr (_boxStyle_se style)
524โ , withinImage (Region left bottom 1 1) $
525โ V.char V.defAttr (_boxStyle_sw style)
527โ in sides ++ if width > 1 && height > 1 then corners else []
529โ-- | Renders text, wrapped to the container width
531โ :: (Reflex t, Monad m)
532โ => Behavior t Text
533โ -> VtyWidget t m ()
535โ dw <- displayWidth
536โ let img = (\w s -> [wrapText w V.defAttr s]) <$> current dw <*> msg
539โ wrapText maxWidth attrs = V.vertCat
540โ . concatMap (fmap (V.string attrs . T.unpack) . TZ.wrapWithOffset maxWidth 0)
541โ . T.split (=='\n')
543โ-- | Renders any behavior whose value can be converted to
544โ-- 'String' as text
546โ :: (Reflex t, Monad m, Show a)
548โ -> VtyWidget t m ()
549โdisplay a = text $ T.pack . show <$> a