@@ -4,145 +4,39 @@ Description: Basic set of widgets and building blocks for reflex-vty application
5{-# Language UndecidableInstances #-}
5{-# Language UndecidableInstances #-}
7−module Reflex.Vty.Widget
7+module Reflex.Vty.Widget where
14− , mainWidgetWithHandle
27− , ScrollDirection(..)
57import Control.Applicative (liftA2)
9import Control.Applicative (liftA2)
58import Control.Monad.Fix (MonadFix)
10import Control.Monad.Fix (MonadFix)
59import Control.Monad.IO.Class (MonadIO)
11import Control.Monad.IO.Class (MonadIO)
12+import Control.Monad.Morph
13+import Control.Monad.NodeId
60−import Control.Monad.Reader (ReaderT, ask, asks, runReaderT)
14+import Control.Monad.Reader (ReaderT, ask, local, runReaderT)
15+import Control.Monad.Ref
61import Control.Monad.Trans (MonadTrans, lift)
16import Control.Monad.Trans (MonadTrans, lift)
62−import Data.Default (Default(..))
63import Data.Set (Set)
17import Data.Set (Set)
64import qualified Data.Set as Set
18import qualified Data.Set as Set
65−import Data.Text (Text)
66−import qualified Data.Text as T
67−import qualified Data.Text.Zipper as TZ
68import Graphics.Vty (Image)
19import Graphics.Vty (Image)
69import qualified Graphics.Vty as V
20import qualified Graphics.Vty as V
70import Reflex
21import Reflex
71import Reflex.Class ()
22import Reflex.Class ()
72import Reflex.Host.Class (MonadReflexCreateTrigger)
23import Reflex.Host.Class (MonadReflexCreateTrigger)
74import Reflex.Vty.Host
24import Reflex.Vty.Host
76−import Control.Monad.NodeId
26+-- * Running a vty application
78−-- | The context within which a 'VtyWidget' runs
79−data VtyWidgetCtx t = VtyWidgetCtx
80− { _vtyWidgetCtx_width :: Dynamic t Int
81− -- ^ The width of the region allocated to the widget.
82− , _vtyWidgetCtx_height :: Dynamic t Int
83− -- ^ The 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_shutdown :: Event t ()
99−instance (Adjustable t m, MonadHold t m, Reflex t) => Adjustable t (VtyWidget t m) where
100− runWithReplace a0 a' = VtyWidget $ runWithReplace (unVtyWidget a0) $ fmap unVtyWidget a'
101− traverseIntMapWithKeyWithAdjust f dm0 dm' = VtyWidget $
102− traverseIntMapWithKeyWithAdjust (\k v -> unVtyWidget (f k v)) dm0 dm'
103− traverseDMapWithKeyWithAdjust f dm0 dm' = VtyWidget $ do
104− traverseDMapWithKeyWithAdjust (\k v -> unVtyWidget (f k v)) dm0 dm'
105− traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = VtyWidget $ do
106− traverseDMapWithKeyWithAdjustWithMove (\k v -> unVtyWidget (f k v)) dm0 dm'
108−-- | A widget that can read its context and produce image output
109−newtype VtyWidget t m a = VtyWidget
110− { unVtyWidget :: BehaviorWriterT t [Image] (ReaderT (VtyWidgetCtx t) m) a
122− , MonadReflexCreateTrigger t
126−deriving instance PerformEvent t m => PerformEvent t (VtyWidget t m)
127−instance MonadTrans (VtyWidget t) where
128− lift f = VtyWidget $ lift $ lift f
130−instance MonadNodeId m => MonadNodeId (VtyWidget t m) where
131− getNextNodeId = VtyWidget $ do
132− lift $ lift getNextNodeId
134−-- | Runs a 'VtyWidget' with a given context
136− :: (Reflex t, MonadNodeId m)
139− -> m (a, Behavior t [Image])
140−runVtyWidget ctx w = runReaderT (runBehaviorWriterT (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, MonadNodeId m) => VtyWidget t m (Event t ()))
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,73 +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_width = fmap fst size
50+ runFocusReader (pure True) $
157− , _vtyWidgetCtx_height = fmap snd size
51+ runDisplayRegion (fmap (\(w, h) -> Region 0 0 w h) size) $
158− , _vtyWidgetCtx_input = inp'
52+ runImageWriter $
159− , _vtyWidgetCtx_focus = constDyn True
53+ runNodeIdT $
160− }
54+ runInput inp' $ do
161− (shutdown, images) <- runNodeIdT $ runVtyWidget ctx $ do
162− 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]
164 return $ VtyResult
57 return $ VtyResult
165 { _vtyResult_picture = fmap (V.picForLayers . reverse) images
58 { _vtyResult_picture = fmap (V.picForLayers . reverse) images
166 , _vtyResult_shutdown = shutdown
59 , _vtyResult_shutdown = shutdown
62+-- | The output of a vty widget
63+data VtyWidgetOut t = VtyWidgetOut
64+ { _vtyWidgetOut_shutdown :: Event t ()
169-- | Like 'mainWidgetWithHandle', but uses a default vty configuration
67-- | Like 'mainWidgetWithHandle', but uses a default vty configuration
170mainWidget
68mainWidget
171− :: (forall t m. (MonadVtyApp t m, MonadNodeId m) => VtyWidget t m (Event t ()))
70+ ( MonadVtyApp t m
73+ , HasDisplayRegion t m
173mainWidget child = do
79mainWidget child = do
174 vty <- getDefaultVty
80 vty <- getDefaultVty
175 mainWidgetWithHandle vty child
81 mainWidgetWithHandle vty child
177−-- | A class for things that know their own display size dimensions
83+-- * Input Events
178−class (Reflex t, Monad m) => HasDisplaySize t m | m -> t where
179− -- | Retrieve the display width (columns)
180− displayWidth :: m (Dynamic t Int)
181− default displayWidth :: (f m' ~ m, MonadTrans f, HasDisplaySize t m') => m (Dynamic t Int)
182− displayWidth = lift displayWidth
183− -- | Retrieve the display height (rows)
184− displayHeight :: m (Dynamic t Int)
185− default displayHeight :: (f m' ~ m, MonadTrans f, HasDisplaySize t m') => m (Dynamic t Int)
186− displayHeight = lift displayHeight
188−instance (Reflex t, Monad m) => HasDisplaySize t (VtyWidget t m) where
189− displayWidth = VtyWidget . lift $ asks _vtyWidgetCtx_width
190− displayHeight = VtyWidget . lift $ asks _vtyWidgetCtx_height
192−instance HasDisplaySize t m => HasDisplaySize t (ReaderT x m)
193−instance HasDisplaySize t m => HasDisplaySize t (BehaviorWriterT t x m)
194−instance HasDisplaySize t m => HasDisplaySize t (DynamicWriterT t x m)
195−instance HasDisplaySize t m => HasDisplaySize t (EventWriterT t x m)
197−instance HasDisplaySize t m => HasDisplaySize t (NodeIdT m)
199-- | A class for things that can receive vty events as input
85-- | A class for things that can receive vty events as input
200−class HasVtyInput t m | m -> t where
86+class HasInput t m | m -> t where
201 input :: m (Event t VtyEvent)
87 input :: m (Event t VtyEvent)
202− default input :: (f m' ~ m, Monad m', MonadTrans f, HasVtyInput t m') => m (Event t VtyEvent)
88+ default input :: (f m' ~ m, Monad m', MonadTrans f, HasInput t m') => m (Event t VtyEvent)
203 input = lift input
89 input = lift input
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
205−instance (Reflex t, Monad m) => HasVtyInput t (VtyWidget t m) where
114+instance (Adjustable t m, MonadHold t m, Reflex t) => Adjustable t (Input t m) where
206− input = VtyWidget . lift $ asks _vtyWidgetCtx_input
115+ runWithReplace a0 a' = Input $ runWithReplace (unInput a0) $ fmap unInput a'
116+ traverseIntMapWithKeyWithAdjust f dm0 dm' = Input $
117+ traverseIntMapWithKeyWithAdjust (\k v -> unInput (f k v)) dm0 dm'
118+ traverseDMapWithKeyWithAdjust f dm0 dm' = Input $ do
119+ traverseDMapWithKeyWithAdjust (\k v -> unInput (f k v)) dm0 dm'
120+ traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = Input $ do
121+ traverseDMapWithKeyWithAdjustWithMove (\k v -> unInput (f k v)) dm0 dm'
123+deriving instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (Input t m)
124+deriving instance NotReady t m => NotReady t (Input t m)
125+deriving instance PerformEvent t m => PerformEvent t (Input t m)
126+deriving instance PostBuild t m => PostBuild t (Input t m)
127+deriving instance TriggerEvent t m => TriggerEvent t (Input t m)
128+instance HasImageWriter t m => HasImageWriter t (Input t m)
129+instance HasDisplayRegion t m => HasDisplayRegion t (Input t m)
130+instance HasFocusReader t m => HasFocusReader t (Input t m)
132+instance MonadTrans (Input t) where
133+ lift f = Input $ lift f
135+instance MFunctor (Input t) where
136+ hoist f = Input . hoist f . unInput
138+instance MonadNodeId m => MonadNodeId (Input t m)
140+-- | Runs an 'Input' with a given context
146+runInput e w = runReaderT (unInput w) e
148+-- ** Filtering input
208−-- | A class for things that can dynamically gain and lose focus
150+-- | Type synonym for a key and modifier combination
209−class HasFocus t m | m -> t where
151+type KeyCombo = (V.Key, [V.Modifier])
210− focus :: m (Dynamic t Bool)
212−instance (Reflex t, Monad m) => HasFocus t (VtyWidget t m) where
153+-- | Emits an event that fires on a particular key press (without modifiers)
213− focus = VtyWidget . lift $ asks _vtyWidgetCtx_focus
154+key :: (Monad m, Reflex t, HasInput t m) => V.Key -> m (Event t KeyCombo)
155+key = keyCombos . Set.singleton . (,[])
215−-- | A class for widgets that can produce images to draw to the display
157+-- | Emits an event that fires on particular key presses (without modifiers)
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
216−class (Reflex t, Monad m) => ImageWriter t m | m -> t where
163+ :: (Reflex t, Monad m, HasInput t m)
217− -- | Send images upstream for rendering
164+ => KeyCombo
218− tellImages :: Behavior t [Image] -> m ()
165+ -> m (Event t KeyCombo)
166+keyCombo = keyCombos . Set.singleton
220−instance (Monad m, Reflex t) => ImageWriter t (BehaviorWriterT t [Image] m) where
168+-- | Emit an event that fires whenever any of the provided key combinations occur
221− tellImages = tellBehavior
169+keyCombos
170+ :: (Reflex t, Monad m, HasInput t m)
172+ -> m (Event t KeyCombo)
175+ return $ fforMaybe i $ \case
176+ V.EvKey k m -> if Set.member (k, m) ks
181+-- | Filter the keyboard input that a child widget may receive
182+filterKeys :: (Reflex t, HasInput t m) => (KeyCombo -> Bool) -> m a -> m a
183+filterKeys f x = localInput (ffilter (\case
184+ V.EvKey k mods -> f (k, mods)
187+-- | Filter mouse input events based on whether they target a particular region
188+-- and translate them to the internal coordinate system of that region.
190+-- NB: Non-mouse events are passed through unfiltered and unchanged
191+mouseInRegion :: Region -> VtyEvent -> Maybe VtyEvent
192+mouseInRegion (Region l t w h) e = case e of
193+ V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
194+ V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
201+ , y >= t + h ] = Nothing
203+ Just (con (x - l) (y - t))
205+-- | Filter mouse input outside the current display region and
206+-- all input if the region is not focused
208+ :: (HasDisplayRegion t m, HasFocusReader t m, HasInput t m)
209+ => m (Event t VtyEvent)
210+inputInFocusedRegion = do
212+ reg <- current <$> askRegion
213+ foc <- current <$> focus
214+ pure $ fmapMaybe id $ attachWith filterInput ((,) <$> reg <*> foc) inp
216+ filterInput (r, f) = \case
217+ V.EvKey {} | not f -> Nothing
218+ x -> mouseInRegion r x
220+-- * Getting and setting the display region
223-- | A chunk of the display area
222-- | A chunk of the display area
224data Region = Region
223data Region = Region
@@ -229,14 +228,293 @@ data Region = Region
230 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
232-- | The width and height of a 'Region'
235-- | The width and height of a 'Region'
233regionSize :: Region -> (Int, Int)
236regionSize :: Region -> (Int, Int)
234regionSize (Region _ _ w h) = (w, h)
237regionSize (Region _ _ w h) = (w, h)
236-- | Produces an 'Image' that fills a region with space characters
239-- | Produces an 'Image' that fills a region with space characters
237−regionBlankImage :: Region -> Image
240+regionBlankImage :: V.Attr -> Region -> Image
238−regionBlankImage r@(Region _ _ width height) =
241+regionBlankImage attr r@(Region _ _ width height) =
239− 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
241-- | Translates and crops an 'Image' so that it is contained by
519-- | Translates and crops an 'Image' so that it is contained by
242-- the given 'Region'.
520-- the given 'Region'.
@@ -248,449 +526,36 @@ withinImage (Region left top width height)
248 | width < 0 || height < 0 = withinImage (Region left top 0 0)
526 | width < 0 || height < 0 = withinImage (Region left top 0 0)
249 | 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
251−-- | Low-level widget combinator that runs a child 'VtyWidget' within
539+-- | Low-level widget combinator that runs a child widget within
252-- 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
253-- that the child widget receives such that:
541-- that the child widget receives such that:
254-- * unfocused widgets receive no key events
542-- * unfocused widgets receive no key events
255-- * mouse inputs outside the region are ignored
543-- * mouse inputs outside the region are ignored
256-- * mouse inputs inside the region have their coordinates translated such
544-- * mouse inputs inside the region have their coordinates translated such
257-- that (0,0) is the top-left corner of the region
545-- that (0,0) is the top-left corner of the region
258−-- TODO make this polymorphic
260− :: (Reflex t, Monad m, MonadNodeId m)
547+ :: (Reflex t, Monad m, HasInput t m, HasImageWriter t m, HasDisplayRegion t m, HasFocusReader t m)
261 => Dynamic t Region
548 => Dynamic t Region
262 -> 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.
263− -> VtyWidget t m a
550+ -> m a
264− -> VtyWidget t m a
551+ -> m a
265−pane dr foc child = VtyWidget $ do
552+pane dr foc child = localRegion (const dr) $
266− ctx <- lift ask
553+ mapImages (imagesInRegion $ current dr) $
267− let reg = current dr
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.
271− attachWith (\(r,f) e -> filterInput r f e)
272− (liftA2 (,) reg (current foc))
273− (_vtyWidgetCtx_input ctx)
275− , _vtyWidgetCtx_focus = liftA2 (&&) (_vtyWidgetCtx_focus ctx) foc
276− , _vtyWidgetCtx_width = _region_width <$> dr
277− , _vtyWidgetCtx_height = _region_height <$> dr
279− (result, images) <- lift . lift $ runVtyWidget ctx' child -- TODO can we use a local-based implementation?
280− let images' = liftA2 (\r is -> map (withinImage r) is) reg 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, HasVtyInput t m)
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 && btn == btn' -> 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, HasVtyInput t m)
344− -> 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, HasVtyInput t m)
356− => 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−-- | Mouse scroll direction
379−data ScrollDirection = ScrollDirection_Up | ScrollDirection_Down
380− deriving (Eq, Ord, Show)
382−-- | Produce an event that fires when the mouse wheel is scrolled
384− :: (Reflex t, Monad m, HasVtyInput t m)
385− => m (Event t ScrollDirection)
387− up <- mouseDown V.BScrollUp
388− down <- mouseDown V.BScrollDown
390− [ ScrollDirection_Up <$ up
391− , ScrollDirection_Down <$ down
394−-- | Type synonym for a key and modifier combination
395−type KeyCombo = (V.Key, [V.Modifier])
397−-- | Emits an event that fires on a particular key press (without modifiers)
398−key :: (Monad m, Reflex t, HasVtyInput t m) => V.Key -> m (Event t KeyCombo)
399−key = keyCombos . Set.singleton . (,[])
401−-- | Emits an event that fires on particular key presses (without modifiers)
402−keys :: (Monad m, Reflex t, HasVtyInput t m) => [V.Key] -> m (Event t KeyCombo)
403−keys = keyCombos . Set.fromList . fmap (,[])
405−-- | Emit an event that fires whenever the provided key combination occurs
407− :: (Reflex t, Monad m, HasVtyInput t m)
409− -> m (Event t KeyCombo)
410−keyCombo = keyCombos . Set.singleton
412−-- | Emit an event that fires whenever any of the provided key combinations occur
414− :: (Reflex t, Monad m, HasVtyInput t m)
416− -> m (Event t KeyCombo)
419− return $ fforMaybe i $ \case
420− V.EvKey k m -> if Set.member (k, m) ks
425−-- | A plain split of the available space into vertically stacked panes.
426−-- No visual separator is built in here.
427−splitV :: (Reflex t, Monad m, MonadNodeId m)
428− => Dynamic t (Int -> Int)
429− -- ^ Function used to determine size of first pane based on available size
430− -> Dynamic t (Bool, Bool)
431− -- ^ How to focus the two sub-panes, given that we are focused.
433− -- ^ Widget for first pane
435− -- ^ Widget for second pane
436− -> VtyWidget t m (a,b)
437−splitV sizeFunD focD wA wB = do
440− let regA = Region 0 0 <$> dw <*> (sizeFunD <*> dh)
441− regB = Region 0 <$> (_region_height <$> regA) <*> dw <*> liftA2 (-) dh (_region_height <$> regA)
442− ra <- pane regA (fst <$> focD) wA
443− rb <- pane regB (snd <$> focD) wB
446−-- | A plain split of the available space into horizontally stacked panes.
447−-- No visual separator is built in here.
448−splitH :: (Reflex t, Monad m, MonadNodeId m)
449− => Dynamic t (Int -> Int)
450− -- ^ Function used to determine size of first pane based on available size
451− -> Dynamic t (Bool, Bool)
452− -- ^ How to focus the two sub-panes, given that we are focused.
454− -- ^ Widget for first pane
456− -- ^ Widget for second pane
457− -> VtyWidget t m (a,b)
458−splitH sizeFunD focD wA wB = do
461− let regA = Region 0 0 <$> (sizeFunD <*> dw) <*> dh
462− regB = Region <$> (_region_width <$> regA) <*> 0 <*> liftA2 (-) dw (_region_width <$> regA) <*> dh
463− liftA2 (,) (pane regA (fmap fst focD) wA) (pane regB (fmap snd focD) wB)
465−-- | A split of the available space into two parts with a draggable separator.
466−-- Starts with half the space allocated to each, and the first pane has focus.
467−-- Clicking in a pane switches focus.
468−splitVDrag :: (Reflex t, MonadFix m, MonadHold t m, MonadNodeId m)
472− -> VtyWidget t m (a,b)
473−splitVDrag wS wA wB = do
476− h0 <- sample $ current dh -- TODO
477− dragE <- drag V.BLeft
478− let splitter0 = h0 `div` 2
479− rec splitterCheckpoint <- holdDyn splitter0 $ leftmost [fst <$> ffilter snd dragSplitter, resizeSplitter]
480− splitterPos <- holdDyn splitter0 $ leftmost [fst <$> dragSplitter, resizeSplitter]
481− splitterFrac <- holdDyn ((1::Double) / 2) $ ffor (attach (current dh) (fst <$> dragSplitter)) $ \(h, x) ->
482− fromIntegral x / max 1 (fromIntegral h)
483− let dragSplitter = fforMaybe (attach (current splitterCheckpoint) dragE) $
484− \(splitterY, Drag (_, fromY) (_, toY) _ _ end) ->
485− if splitterY == fromY then Just (toY, end) else Nothing
486− regA = Region 0 0 <$> dw <*> splitterPos
487− regS = Region 0 <$> splitterPos <*> dw <*> 1
488− regB = Region 0 <$> (splitterPos + 1) <*> dw <*> (dh - splitterPos - 1)
489− resizeSplitter = ffor (attach (current splitterFrac) (updated dh)) $
490− \(frac, h) -> round (frac * fromIntegral h)
491− focA <- holdDyn True $ leftmost
495− (mA, rA) <- pane regA focA $ withMouseDown wA
496− pane regS (pure False) wS
497− (mB, rB) <- pane regB (not <$> focA) $ withMouseDown wB
500− withMouseDown x = do
501− m <- mouseDown V.BLeft
505−-- | Fill the background with a particular character.
506−fill :: (Reflex t, Monad m) => Char -> VtyWidget t m ()
510− let fillImg = current $ liftA2 (\w h -> [V.charFill V.defAttr c w h]) dw dh
513−-- | Fill the background with the bottom
514−hRule :: (Reflex t, Monad m) => BoxStyle -> VtyWidget t m ()
515−hRule boxStyle = fill (_boxStyle_s boxStyle)
517−-- | Defines a set of symbols to use to draw the outlines of boxes
518−-- C.f. https://en.wikipedia.org/wiki/Box-drawing_character
519−data BoxStyle = BoxStyle
520− { _boxStyle_nw :: Char
521− , _boxStyle_n :: Char
522− , _boxStyle_ne :: Char
523− , _boxStyle_e :: Char
524− , _boxStyle_se :: Char
525− , _boxStyle_s :: Char
526− , _boxStyle_sw :: Char
527− , _boxStyle_w :: Char
530−instance Default BoxStyle where
531− def = singleBoxStyle
533−-- | A box style that uses hyphens and pipe characters. Doesn't handle
534−-- corners very well.
535−hyphenBoxStyle :: BoxStyle
536−hyphenBoxStyle = BoxStyle '-' '-' '-' '|' '-' '-' '-' '|'
538−-- | A single line box style
539−singleBoxStyle :: BoxStyle
540−singleBoxStyle = BoxStyle '┌' '─' '┐' '│' '┘' '─' '└' '│'
542−-- | A thick single line box style
543−thickBoxStyle :: BoxStyle
544−thickBoxStyle = BoxStyle '┏' '━' '┓' '┃' '┛' '━' '┗' '┃'
546−-- | A double line box style
547−doubleBoxStyle :: BoxStyle
548−doubleBoxStyle = BoxStyle '╔' '═' '╗' '║' '╝' '═' '╚' '║'
550−-- | A single line box style with rounded corners
551−roundedBoxStyle :: BoxStyle
552−roundedBoxStyle = BoxStyle '╭' '─' '╮' '│' '╯' '─' '╰' '│'
554−-- | Draws a titled box in the provided style and a child widget inside of that box
555−boxTitle :: (Monad m, Reflex t, MonadNodeId m)
556− => Behavior t BoxStyle
560−boxTitle boxStyle title child = do
563− let boxReg = Region 0 0 <$> dw <*> dh
564− innerReg = Region 1 1 <$> (subtract 2 <$> dw) <*> (subtract 2 <$> dh)
565− tellImages (boxImages <$> boxStyle <*> current boxReg)
566− tellImages (fmap (\r -> [regionBlankImage r]) (current innerReg))
567− pane innerReg (pure True) child
569− boxImages :: BoxStyle -> Region -> [Image]
570− boxImages style (Region left top width height) =
571− let right = left + width - 1
572− bottom = top + height - 1
574− [ withinImage (Region (left + 1) top (width - 2) 1) $
576− hPadText title (_boxStyle_n style) (width - 2)
577− , withinImage (Region right (top + 1) 1 (height - 2)) $
578− V.charFill V.defAttr (_boxStyle_e style) 1 (height - 2)
579− , withinImage (Region (left + 1) bottom (width - 2) 1) $
580− V.charFill V.defAttr (_boxStyle_s style) (width - 2) 1
581− , withinImage (Region left (top + 1) 1 (height - 2)) $
582− V.charFill V.defAttr (_boxStyle_w style) 1 (height - 2)
585− [ withinImage (Region left top 1 1) $
586− V.char V.defAttr (_boxStyle_nw style)
587− , withinImage (Region right top 1 1) $
588− V.char V.defAttr (_boxStyle_ne style)
589− , withinImage (Region right bottom 1 1) $
590− V.char V.defAttr (_boxStyle_se style)
591− , withinImage (Region left bottom 1 1) $
592− V.char V.defAttr (_boxStyle_sw style)
594− in sides ++ if width > 1 && height > 1 then corners else []
595− hPadText :: T.Text -> Char -> Int -> T.Text
596− hPadText t c l = if lt >= l
598− else left <> t <> right
602− mkHalf n = T.replicate (n `div` 2) (T.singleton c)
603− left = mkHalf $ delta + 1
604− right = mkHalf delta
606−-- | A box without a title
607−box :: (Monad m, Reflex t, MonadNodeId m)
608− => Behavior t BoxStyle
611−box boxStyle = boxTitle boxStyle mempty
613−-- | A box whose style is static
615− :: (Reflex t, Monad m, MonadNodeId m)
619−boxStatic = box . pure
621−-- | Configuration options for displaying "rich" text
622−data RichTextConfig t = RichTextConfig
623− { _richTextConfig_attributes :: Behavior t V.Attr
626−instance Reflex t => Default (RichTextConfig t) where
627− def = RichTextConfig $ pure V.defAttr
629−-- | A widget that displays text with custom time-varying attributes
631− :: (Reflex t, Monad m)
637− let img = (\w a s -> [wrapText w a s])
639− <*> _richTextConfig_attributes cfg
643− wrapText maxWidth attrs = V.vertCat
644− . concatMap (fmap (V.string attrs . T.unpack) . TZ.wrapWithOffset maxWidth 0)
647−-- | Renders text, wrapped to the container width
649− :: (Reflex t, Monad m)
654−-- | Scrollable text widget. The output pair exposes the current scroll position and total number of lines (including those
657− :: forall t m. (Reflex t, MonadHold t m, MonadFix m)
659− -- ^ Number of lines to scroll by
661− -> VtyWidget t m (Behavior t (Int, Int))
662− -- ^ (Current scroll position, total number of lines)
663−scrollableText scrollBy t = do
665− let imgs = wrap <$> current dw <*> t
667− kdown <- key V.KDown
669− let requestedScroll :: Event t Int
670− requestedScroll = leftmost
674− ScrollDirection_Up -> (-1)
675− ScrollDirection_Down -> 1
678− updateLine maxN delta ix = min (max 0 (ix + delta)) maxN
679− lineIndex :: Dynamic t Int <- foldDyn (\(maxN, delta) ix -> updateLine (maxN - 1) delta ix) 0 $
680− attach (length <$> imgs) requestedScroll
681− tellImages $ fmap ((:[]) . V.vertCat) $ drop <$> current lineIndex <*> imgs
682− return $ (,) <$> ((+) <$> current lineIndex <*> pure 1) <*> (length <$> imgs)
684− wrap maxWidth = concatMap (fmap (V.string V.defAttr . T.unpack) . TZ.wrapWithOffset maxWidth 0) . T.split (=='\n')
686−-- | Renders any behavior whose value can be converted to
557+-- * Misc
689− :: (Reflex t, Monad m, Show a)
692−display a = text $ T.pack . show <$> a
694-- | A widget that draws nothing
559-- | A widget that draws nothing
695−blank :: Monad m => VtyWidget t m ()
560+blank :: Monad m => m ()
696blank = return ()
561blank = return ()