@@ -4,70 +4,18 @@ Description: Basic set of widgets and building blocks for reflex-vty application
44-}
55{-# Language UndecidableInstances #-}
66
7−module Reflex.Vty.Widget
8− ( VtyWidgetCtx(..)
9− , VtyWidget(..)
10− , VtyWidgetOut(..)
11− , ImageWriter(..)
12− , runVtyWidget
13− , mainWidget
14− , mainWidgetWithHandle
15− , HasDisplaySize(..)
16− , HasFocus(..)
17− , HasVtyInput(..)
18− , HasVtyWidgetCtx(..)
19− , Region(..)
20− , regionSize
21− , regionBlankImage
22− , Drag(..)
23− , drag
24− , MouseDown(..)
25− , MouseUp(..)
26− , mouseDown
27− , mouseUp
28− , ScrollDirection(..)
29− , mouseScroll
30− , pane
31− , splitV
32− , splitH
33− , splitVDrag
34− , boxTitle
35− , box
36− , boxStatic
37− , RichTextConfig(..)
38− , richText
39− , text
40− , scrollableText
41− , display
42− , BoxStyle(..)
43− , hyphenBoxStyle
44− , singleBoxStyle
45− , roundedBoxStyle
46− , thickBoxStyle
47− , doubleBoxStyle
48− , fill
49− , hRule
50− , filterKeys
51− , KeyCombo
52− , key
53− , keys
54− , keyCombo
55− , keyCombos
56− , blank
57− ) where
7+module Reflex.Vty.Widget where
588
599import Control.Applicative (liftA2)
6010import Control.Monad.Fix (MonadFix)
6111import Control.Monad.IO.Class (MonadIO)
12+import Control.Monad.Morph
6213import Control.Monad.NodeId
63−import Control.Monad.Reader (ReaderT, ask, asks, local, runReaderT)
14+import Control.Monad.Reader (ReaderT, ask, local, runReaderT)
15+import Control.Monad.Ref
6416import Control.Monad.Trans (MonadTrans, lift)
65−import Data.Default (Default(..))
6617import Data.Set (Set)
6718import qualified Data.Set as Set
68−import Data.Text (Text)
69−import qualified Data.Text as T
70−import qualified Data.Text.Zipper as TZ
7119import Graphics.Vty (Image)
7220import qualified Graphics.Vty as V
7321import Reflex
@@ -75,85 +23,20 @@ import Reflex.Class ()
7523import Reflex.Host.Class (MonadReflexCreateTrigger)
7624import Reflex.Vty.Host
7725
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− }
87−
88−-- | The output of a 'VtyWidget'
89−data VtyWidgetOut t = VtyWidgetOut
90− { _vtyWidgetOut_shutdown :: Event t ()
91− }
92−
93−instance (Adjustable t m, MonadHold t m, Reflex t) => Adjustable t (VtyWidget t m) where
94− runWithReplace a0 a' = VtyWidget $ runWithReplace (unVtyWidget a0) $ fmap unVtyWidget a'
95− traverseIntMapWithKeyWithAdjust f dm0 dm' = VtyWidget $
96− traverseIntMapWithKeyWithAdjust (\k v -> unVtyWidget (f k v)) dm0 dm'
97− traverseDMapWithKeyWithAdjust f dm0 dm' = VtyWidget $ do
98− traverseDMapWithKeyWithAdjust (\k v -> unVtyWidget (f k v)) dm0 dm'
99− traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = VtyWidget $ do
100− traverseDMapWithKeyWithAdjustWithMove (\k v -> unVtyWidget (f k v)) dm0 dm'
101−
102−-- | A widget that can read its context and produce image output
103−newtype VtyWidget t m a = VtyWidget
104− { unVtyWidget :: BehaviorWriterT t [Image]
105− (ReaderT (VtyWidgetCtx t)
106− (ReaderT (Event t VtyEvent) m)) a
107− } deriving
108− ( Functor
109− , Applicative
110− , Monad
111− , MonadSample t
112− , MonadHold t
113− , MonadFix
114− , NotReady t
115− , ImageWriter t
116− , PostBuild t
117− , TriggerEvent t
118− , MonadReflexCreateTrigger t
119− , MonadIO
120− )
121−
122−deriving instance PerformEvent t m => PerformEvent t (VtyWidget t m)
123−instance MonadTrans (VtyWidget t) where
124− lift f = VtyWidget $ lift $ lift $ lift f
125−
126−instance MonadNodeId m => MonadNodeId (VtyWidget t m) where
127− getNextNodeId = VtyWidget $ do
128− lift $ lift getNextNodeId
129−
130−-- | A reader-like class for the vty widget context. Allows actions to be run in a sub-context.
131−class HasVtyWidgetCtx t m | m -> t where
132− askCtx :: m (VtyWidgetCtx t)
133− default askCtx :: (f m' ~ m, Monad m', MonadTrans f, HasVtyWidgetCtx t m') => m (VtyWidgetCtx t)
134− askCtx = lift askCtx
135− localCtx :: (VtyWidgetCtx t -> VtyWidgetCtx t) -> (Behavior t [Image] -> Behavior t [Image]) -> m a -> m a
136−
137−instance (Monad m, Reflex t) => HasVtyWidgetCtx t (VtyWidget t m) where
138− askCtx = VtyWidget $ lift ask
139− localCtx f g (VtyWidget x) = VtyWidget $ do
140− (a, images) :: (a, Behavior t [Image]) <- lift $ local f $ runBehaviorWriterT x
141− tellImages $ g images
142− pure a
26+-- * Running a vty application
14327
144−-- | Runs a 'VtyWidget' with a given context
145−runVtyWidget
146− :: (Reflex t, MonadNodeId m)
147− => Event t VtyEvent
148− -> VtyWidgetCtx t
149− -> VtyWidget t m a
150− -> m (a, Behavior t [Image])
151−runVtyWidget e ctx w = runReaderT (runReaderT (runBehaviorWriterT (unVtyWidget w)) ctx) e
152−
153−-- | 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
15429mainWidgetWithHandle
15530 :: V.Vty
156− -> (forall t m. (MonadVtyApp t m, MonadNodeId m) => VtyWidget t m (Event t ()))
31+ -> (forall t m.
32+ ( MonadVtyApp t m
33+ , HasImageWriter t m
34+ , MonadNodeId m
35+ , HasDisplayRegion t m
36+ , HasFocusReader t m
37+ , HasInput t m
38+ , HasTheme t m
39+ ) => m (Event t ()))
15740 -> IO ()
15841mainWidgetWithHandle vty child =
15942 runVtyAppWithHandle vty $ \dr0 inp -> do
@@ -163,89 +46,178 @@ mainWidgetWithHandle vty child =
16346 let inp' = fforMaybe inp $ \case
16447 V.EvResize {} -> Nothing
16548 x -> Just x
166− let ctx = VtyWidgetCtx
167− { _vtyWidgetCtx_width = fmap fst size
168− , _vtyWidgetCtx_height = fmap snd size
169− , _vtyWidgetCtx_focus = constDyn True
170− }
171− (shutdown, images) <- runNodeIdT $ runVtyWidget inp' ctx $ do
172− tellImages . ffor (current size) $ \(w, h) -> [V.charFill V.defAttr ' ' w h]
173− child
49+ (shutdown, images) <- runThemeReader (constant V.defAttr) $
50+ runFocusReader (pure True) $
51+ runDisplayRegion (fmap (\(w, h) -> Region 0 0 w h) size) $
52+ runImageWriter $
53+ runNodeIdT $
54+ runInput inp' $ do
55+ tellImages . ffor (current size) $ \(w, h) -> [V.charFill V.defAttr ' ' w h]
56+ child
17457 return $ VtyResult
17558 { _vtyResult_picture = fmap (V.picForLayers . reverse) images
17659 , _vtyResult_shutdown = shutdown
17760 }
17861
62+-- | The output of a vty widget
63+data VtyWidgetOut t = VtyWidgetOut
64+ { _vtyWidgetOut_shutdown :: Event t ()
65+ }
66+
17967-- | Like 'mainWidgetWithHandle', but uses a default vty configuration
18068mainWidget
181− :: (forall t m. (MonadVtyApp t m, MonadNodeId m) => VtyWidget t m (Event t ()))
69+ :: (forall t m.
70+ ( MonadVtyApp t m
71+ , HasImageWriter t m
72+ , MonadNodeId m
73+ , HasDisplayRegion t m
74+ , HasFocusReader t m
75+ , HasTheme t m
76+ , HasInput t m
77+ ) => m (Event t ()))
18278 -> IO ()
18379mainWidget child = do
18480 vty <- getDefaultVty
18581 mainWidgetWithHandle vty child
18682
187−-- | A class for things that know their own display size dimensions
188−class (Reflex t, Monad m) => HasDisplaySize t m | m -> t where
189− -- | Retrieve the display width (columns)
190− displayWidth :: m (Dynamic t Int)
191− default displayWidth :: (f m' ~ m, MonadTrans f, HasDisplaySize t m') => m (Dynamic t Int)
192− displayWidth = lift displayWidth
193− -- | Retrieve the display height (rows)
194− displayHeight :: m (Dynamic t Int)
195− default displayHeight :: (f m' ~ m, MonadTrans f, HasDisplaySize t m') => m (Dynamic t Int)
196− displayHeight = lift displayHeight
197−
198−instance (Reflex t, Monad m) => HasDisplaySize t (VtyWidget t m) where
199− displayWidth = VtyWidget . lift $ asks _vtyWidgetCtx_width
200− displayHeight = VtyWidget . lift $ asks _vtyWidgetCtx_height
201−
202−instance HasDisplaySize t m => HasDisplaySize t (ReaderT x m)
203−instance HasDisplaySize t m => HasDisplaySize t (BehaviorWriterT t x m)
204−instance HasDisplaySize t m => HasDisplaySize t (DynamicWriterT t x m)
205−instance HasDisplaySize t m => HasDisplaySize t (EventWriterT t x m)
206−instance HasDisplaySize t m => HasDisplaySize t (NodeIdT m)
83+-- * Input Events
20784
20885-- | A class for things that can receive vty events as input
209−class HasVtyInput t m | m -> t where
86+class HasInput t m | m -> t where
21087 input :: m (Event t VtyEvent)
211− 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)
21289 input = lift input
21390 -- | User input events that the widget's parent chooses to share. These will generally
21491 -- be filtered for relevance.
21592 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)
95+
96+instance (Reflex t, Monad m) => HasInput t (Input t m) where
97+ input = Input ask
98+ localInput f (Input m) = Input $ local f m
99+
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
103+ } deriving
104+ ( Functor
105+ , Applicative
106+ , Monad
107+ , MonadSample t
108+ , MonadHold t
109+ , MonadFix
110+ , MonadIO
111+ , MonadRef
112+ )
113+
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'
122+
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)
131+
132+instance MonadTrans (Input t) where
133+ lift f = Input $ lift f
134+
135+instance MFunctor (Input t) where
136+ hoist f = Input . hoist f . unInput
137+
138+instance MonadNodeId m => MonadNodeId (Input t m)
139+
140+-- | Runs an 'Input' with a given context
141+runInput
142+ :: Reflex t
143+ => Event t VtyEvent
144+ -> Input t m a
145+ -> m a
146+runInput e w = runReaderT (unInput w) e
147+
148+-- ** Filtering input
149+
150+-- | Type synonym for a key and modifier combination
151+type KeyCombo = (V.Key, [V.Modifier])
152+
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 . (,[])
156+
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 (,[])
160+
161+-- | Emit an event that fires whenever the provided key combination occurs
162+keyCombo
163+ :: (Reflex t, Monad m, HasInput t m)
164+ => KeyCombo
165+ -> m (Event t KeyCombo)
166+keyCombo = keyCombos . Set.singleton
167+
168+-- | Emit an event that fires whenever any of the provided key combinations occur
169+keyCombos
170+ :: (Reflex t, Monad m, HasInput t m)
171+ => Set KeyCombo
172+ -> m (Event t KeyCombo)
173+keyCombos ks = do
174+ i <- input
175+ return $ fforMaybe i $ \case
176+ V.EvKey k m -> if Set.member (k, m) ks
177+ then Just (k, m)
178+ else Nothing
179+ _ -> Nothing
216180
217181-- | Filter the keyboard input that a child widget may receive
218−filterKeys :: (Reflex t, HasVtyInput t m) => (KeyCombo -> Bool) -> m a -> m a
182+filterKeys :: (Reflex t, HasInput t m) => (KeyCombo -> Bool) -> m a -> m a
219183filterKeys f x = localInput (ffilter (\case
220184 V.EvKey k mods -> f (k, mods)
221185 _ -> True)) x
222186
223−instance (Reflex t, Monad m) => HasVtyInput t (VtyWidget t m) where
224− input = VtyWidget . lift $ lift $ ask
225− localInput f (VtyWidget m) = VtyWidget $ do
226− ctx <- ask
227− (a, images) <- lift $ lift $ local f $ runReaderT (runBehaviorWriterT m) ctx
228− tellImages images
229− pure a
230−
231−-- | A class for things that can dynamically gain and lose focus
232−class HasFocus t m | m -> t where
233− focus :: m (Dynamic t Bool)
234− default focus :: (f m' ~ m, Monad m', MonadTrans f, HasFocus t m') => m (Dynamic t Bool)
235− focus = lift focus
236−
237−instance (Reflex t, Monad m) => HasFocus t (VtyWidget t m) where
238− focus = VtyWidget . lift $ asks _vtyWidgetCtx_focus
239−
240−-- | A class for widgets that can produce images to draw to the display
241−class (Reflex t, Monad m) => ImageWriter t m | m -> t where
242− -- | Send images upstream for rendering
243− tellImages :: Behavior t [Image] -> m ()
244− default tellImages :: (f m' ~ m, Monad m', MonadTrans f, ImageWriter t m') => Behavior t [Image] -> m ()
245− tellImages = lift . tellImages
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.
189+--
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
195+ _ -> Just e
196+ where
197+ mouse con x y
198+ | or [ x < l
199+ , y < t
200+ , x >= l + w
201+ , y >= t + h ] = Nothing
202+ | otherwise =
203+ Just (con (x - l) (y - t))
204+
205+-- | Filter mouse input outside the current display region and
206+-- all input if the region is not focused
207+inputInFocusedRegion
208+ :: (HasDisplayRegion t m, HasFocusReader t m, HasInput t m)
209+ => m (Event t VtyEvent)
210+inputInFocusedRegion = do
211+ inp <- input
212+ reg <- current <$> askRegion
213+ foc <- current <$> focus
214+ pure $ fmapMaybe id $ attachWith filterInput ((,) <$> reg <*> foc) inp
215+ where
216+ filterInput (r, f) = \case
217+ V.EvKey {} | not f -> Nothing
218+ x -> mouseInRegion r x
246219
247−instance (Monad m, Reflex t) => ImageWriter t (BehaviorWriterT t [Image] m) where
248− tellImages = tellBehavior
220+-- * Getting and setting the display region
249221
250222-- | A chunk of the display area
251223data Region = Region
@@ -256,14 +228,293 @@ data Region = Region
256228 }
257229 deriving (Show, Read, Eq, Ord)
258230
231+-- | A region that occupies no space.
232+nilRegion :: Region
233+nilRegion = Region 0 0 0 0
234+
259235-- | The width and height of a 'Region'
260236regionSize :: Region -> (Int, Int)
261237regionSize (Region _ _ w h) = (w, h)
262238
263239-- | Produces an 'Image' that fills a region with space characters
264−regionBlankImage :: Region -> Image
265−regionBlankImage r@(Region _ _ width height) =
266− withinImage r $ V.charFill V.defAttr ' ' width height
240+regionBlankImage :: V.Attr -> Region -> Image
241+regionBlankImage attr r@(Region _ _ width height) =
242+ withinImage r $ V.charFill attr ' ' width height
243+
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)
254+
255+-- | Retrieve the display width
256+displayWidth :: HasDisplayRegion t m => m (Dynamic t Int)
257+displayWidth = fmap _region_width <$> askRegion
258+
259+-- | Retrieve the display height
260+displayHeight :: HasDisplayRegion t m => m (Dynamic t Int)
261+displayHeight = fmap _region_height <$> askRegion
262+
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)
268+
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 }
272+ deriving
273+ ( Functor
274+ , Applicative
275+ , Monad
276+ , MonadFix
277+ , MonadHold t
278+ , MonadIO
279+ , MonadRef
280+ , MonadSample t
281+ )
282+
283+instance (Monad m, Reflex t) => HasDisplayRegion t (DisplayRegion t m) where
284+ askRegion = DisplayRegion ask
285+ localRegion f = DisplayRegion . local f . unDisplayRegion
286+
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)
294+
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
300+
301+instance MonadTrans (DisplayRegion t) where
302+ lift = DisplayRegion . lift
303+
304+instance MFunctor (DisplayRegion t) where
305+ hoist f = DisplayRegion . hoist f . unDisplayRegion
306+
307+instance MonadNodeId m => MonadNodeId (DisplayRegion t m)
308+
309+-- | Run a 'DisplayRegion' action with a given 'Region'
310+runDisplayRegion
311+ :: (Reflex t, Monad m)
312+ => Dynamic t Region
313+ -> DisplayRegion t m a
314+ -> m a
315+runDisplayRegion r = flip runReaderT r . unDisplayRegion
316+
317+-- * Getting focus state
318+
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)
323+ focus = lift focus
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)
327+
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)
333+
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 }
337+ deriving
338+ ( Functor
339+ , Applicative
340+ , Monad
341+ , MonadFix
342+ , MonadHold t
343+ , MonadIO
344+ , MonadRef
345+ , MonadSample t
346+ )
347+
348+instance (Monad m, Reflex t) => HasFocusReader t (FocusReader t m) where
349+ focus = FocusReader ask
350+ localFocus f = FocusReader . local f . unFocusReader
351+
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)
358+
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
364+
365+instance MonadTrans (FocusReader t) where
366+ lift = FocusReader . lift
367+
368+instance MFunctor (FocusReader t) where
369+ hoist f = FocusReader . hoist f . unFocusReader
370+
371+instance MonadNodeId m => MonadNodeId (FocusReader t m)
372+
373+-- | Run a 'FocusReader' action with the given focus value
374+runFocusReader
375+ :: (Reflex t, Monad m)
376+ => Dynamic t Bool
377+ -> FocusReader t m a
378+ -> m a
379+runFocusReader b = flip runReaderT b . unFocusReader
380+
381+-- * "Image" output
382+
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)
393+
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 }
397+ deriving
398+ ( Functor
399+ , Applicative
400+ , Monad
401+ , MonadFix
402+ , MonadHold t
403+ , MonadIO
404+ , MonadRef
405+ , MonadReflexCreateTrigger t
406+ , MonadSample t
407+ , NotReady t
408+ , PerformEvent t
409+ , PostBuild t
410+ , TriggerEvent t
411+ )
412+
413+instance MonadTrans (ImageWriter t) where
414+ lift = ImageWriter . lift
415+
416+instance MFunctor (ImageWriter t) where
417+ hoist f = ImageWriter . (hoist f) . unImageWriter
418+
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
424+
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)
430+
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
436+ pure a
437+
438+instance HasDisplayRegion t m => HasDisplayRegion t (ImageWriter t m)
439+instance HasFocusReader t m => HasFocusReader t (ImageWriter t m)
440+
441+-- | Run a widget that can produce images
442+runImageWriter
443+ :: (Reflex t, Monad m)
444+ => ImageWriter t m a
445+ -> m (a, Behavior t [Image])
446+runImageWriter = runBehaviorWriterT . unImageWriter
447+
448+-- * Theming
449+
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)
454+ theme = lift theme
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)
458+
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)
468+
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 }
472+ deriving
473+ ( Functor
474+ , Applicative
475+ , Monad
476+ , MonadFix
477+ , MonadHold t
478+ , MonadIO
479+ , MonadRef
480+ , MonadSample t
481+ )
482+
483+instance (Monad m, Reflex t) => HasTheme t (ThemeReader t m) where
484+ theme = ThemeReader ask
485+ localTheme f = ThemeReader . local f . unThemeReader
486+
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)
493+
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
499+
500+instance MonadTrans (ThemeReader t) where
501+ lift = ThemeReader . lift
502+
503+instance MFunctor (ThemeReader t) where
504+ hoist f = ThemeReader . hoist f . unThemeReader
505+
506+instance MonadNodeId m => MonadNodeId (ThemeReader t m)
507+
508+-- | Run a 'ThemeReader' action with the given focus value
509+runThemeReader
510+ :: (Reflex t, Monad m)
511+ => Behavior t V.Attr
512+ -> ThemeReader t m a
513+ -> m a
514+runThemeReader b = flip runReaderT b . unThemeReader
515+
516+
517+-- ** Manipulating images
267518
268519-- | Translates and crops an 'Image' so that it is contained by
269520-- the given 'Region'.
@@ -275,7 +526,17 @@ withinImage (Region left top width height)
275526 | width < 0 || height < 0 = withinImage (Region left top 0 0)
276527 | otherwise = V.translate left top . V.crop width height
277528
278−-- | Low-level widget combinator that runs a child 'VtyWidget' within
529+-- | Crop a behavior of images to a behavior of regions. See 'withinImage'.
530+imagesInRegion
531+ :: Reflex t
532+ => Behavior t Region
533+ -> Behavior t [Image]
534+ -> Behavior t [Image]
535+imagesInRegion reg = liftA2 (\r is -> map (withinImage r) is) reg
536+
537+-- * Running sub-widgets
538+
539+-- | Low-level widget combinator that runs a child widget within
279540-- a given region and context. This widget filters and modifies the input
280541-- that the child widget receives such that:
281542-- * unfocused widgets receive no key events
@@ -283,433 +544,17 @@ withinImage (Region left top width height)
283544-- * mouse inputs inside the region have their coordinates translated such
284545-- that (0,0) is the top-left corner of the region
285546pane
286− :: (Reflex t, Monad m, MonadNodeId m, HasVtyWidgetCtx t m, HasVtyInput t m)
547+ :: (Reflex t, Monad m, HasInput t m, HasImageWriter t m, HasDisplayRegion t m, HasFocusReader t m)
287548 => Dynamic t Region
288549 -> Dynamic t Bool -- ^ Whether the widget should be focused when the parent is.
289550 -> m a
290551 -> m a
291−pane dr foc child = do
292− let reg = current dr
293− let subContext ctx = VtyWidgetCtx
294− { _vtyWidgetCtx_focus = liftA2 (&&) (_vtyWidgetCtx_focus ctx) foc
295− , _vtyWidgetCtx_width = _region_width <$> dr
296− , _vtyWidgetCtx_height = _region_height <$> dr
297− }
298− inputFilter = fmapMaybe id .
299− attachWith (\(r,f) e -> filterInput r f e)
300− (liftA2 (,) reg (current foc))
301− let imagesWithinRegion images = liftA2 (\is r -> map (withinImage r) is) images reg
302− localInput inputFilter $ localCtx subContext imagesWithinRegion child
303− where
304− filterInput :: Region -> Bool -> VtyEvent -> Maybe VtyEvent
305− filterInput (Region l t w h) focused e = case e of
306− V.EvKey _ _ | not focused -> Nothing
307− V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
308− V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
309− _ -> Just e
310− where
311− mouse con x y
312− | or [ x < l
313− , y < t
314− , x >= l + w
315− , y >= t + h ] = Nothing
316− | otherwise =
317− Just (con (x - l) (y - t))
318−
319−-- | Information about a drag operation
320−data Drag = Drag
321− { _drag_from :: (Int, Int) -- ^ Where the drag began
322− , _drag_to :: (Int, Int) -- ^ Where the mouse currently is
323− , _drag_button :: V.Button -- ^ Which mouse button is dragging
324− , _drag_modifiers :: [V.Modifier] -- ^ What modifiers are held
325− , _drag_end :: Bool -- ^ Whether the drag ended (the mouse button was released)
326− }
327− deriving (Eq, Ord, Show)
328−
329−-- | Converts raw vty mouse drag events into an event stream of 'Drag's
330−drag
331− :: (Reflex t, MonadFix m, MonadHold t m, HasVtyInput t m)
332− => V.Button
333− -> m (Event t Drag)
334−drag btn = do
335− inp <- input
336− let f :: Maybe Drag -> V.Event -> Maybe Drag
337− f Nothing = \case
338− V.EvMouseDown x y btn' mods
339− | btn == btn' -> Just $ Drag (x,y) (x,y) btn' mods False
340− | otherwise -> Nothing
341− _ -> Nothing
342− f (Just (Drag from _ _ mods end)) = \case
343− V.EvMouseDown x y btn' mods'
344− | end && btn == btn' -> Just $ Drag (x,y) (x,y) btn' mods' False
345− | btn == btn' -> Just $ Drag from (x,y) btn mods' False
346− | otherwise -> Nothing -- Ignore other buttons.
347− V.EvMouseUp x y (Just btn')
348− | end -> Nothing
349− | btn == btn' -> Just $ Drag from (x,y) btn mods True
350− | otherwise -> Nothing
351− V.EvMouseUp x y Nothing -- Terminal doesn't specify mouse up button,
352− -- assume it's the right one.
353− | end -> Nothing
354− | otherwise -> Just $ Drag from (x,y) btn mods True
355− _ -> Nothing
356− rec let newDrag = attachWithMaybe f (current dragD) inp
357− dragD <- holdDyn Nothing $ Just <$> newDrag
358− return (fmapMaybe id $ updated dragD)
359−
360−-- | Mouse down events for a particular mouse button
361−mouseDown
362− :: (Reflex t, Monad m, HasVtyInput t m)
363− => V.Button
364− -> m (Event t MouseDown)
365−mouseDown btn = do
366− i <- input
367− return $ fforMaybe i $ \case
368− V.EvMouseDown x y btn' mods -> if btn == btn'
369− then Just $ MouseDown btn' (x, y) mods
370− else Nothing
371− _ -> Nothing
372−
373−-- | Mouse up events for a particular mouse button
374−mouseUp
375− :: (Reflex t, Monad m, HasVtyInput t m)
376− => m (Event t MouseUp)
377−mouseUp = do
378− i <- input
379− return $ fforMaybe i $ \case
380− V.EvMouseUp x y btn' -> Just $ MouseUp btn' (x, y)
381− _ -> Nothing
382−
383−-- | Information about a mouse down event
384−data MouseDown = MouseDown
385− { _mouseDown_button :: V.Button
386− , _mouseDown_coordinates :: (Int, Int)
387− , _mouseDown_modifiers :: [V.Modifier]
388− }
389− deriving (Eq, Ord, Show)
552+pane dr foc child = localRegion (const dr) $
553+ mapImages (imagesInRegion $ current dr) $
554+ localFocus (const foc) $
555+ inputInFocusedRegion >>= \e -> localInput (const e) child
390556
391−-- | Information about a mouse up event
392−data MouseUp = MouseUp
393− { _mouseUp_button :: Maybe V.Button
394− , _mouseUp_coordinates :: (Int, Int)
395− }
396− deriving (Eq, Ord, Show)
397−
398−-- | Mouse scroll direction
399−data ScrollDirection = ScrollDirection_Up | ScrollDirection_Down
400− deriving (Eq, Ord, Show)
401−
402−-- | Produce an event that fires when the mouse wheel is scrolled
403−mouseScroll
404− :: (Reflex t, Monad m, HasVtyInput t m)
405− => m (Event t ScrollDirection)
406−mouseScroll = do
407− up <- mouseDown V.BScrollUp
408− down <- mouseDown V.BScrollDown
409− return $ leftmost
410− [ ScrollDirection_Up <$ up
411− , ScrollDirection_Down <$ down
412− ]
413−
414−-- | Type synonym for a key and modifier combination
415−type KeyCombo = (V.Key, [V.Modifier])
416−
417−-- | Emits an event that fires on a particular key press (without modifiers)
418−key :: (Monad m, Reflex t, HasVtyInput t m) => V.Key -> m (Event t KeyCombo)
419−key = keyCombos . Set.singleton . (,[])
420−
421−-- | Emits an event that fires on particular key presses (without modifiers)
422−keys :: (Monad m, Reflex t, HasVtyInput t m) => [V.Key] -> m (Event t KeyCombo)
423−keys = keyCombos . Set.fromList . fmap (,[])
424−
425−-- | Emit an event that fires whenever the provided key combination occurs
426−keyCombo
427− :: (Reflex t, Monad m, HasVtyInput t m)
428− => KeyCombo
429− -> m (Event t KeyCombo)
430−keyCombo = keyCombos . Set.singleton
431−
432−-- | Emit an event that fires whenever any of the provided key combinations occur
433−keyCombos
434− :: (Reflex t, Monad m, HasVtyInput t m)
435− => Set KeyCombo
436− -> m (Event t KeyCombo)
437−keyCombos ks = do
438− i <- input
439− return $ fforMaybe i $ \case
440− V.EvKey k m -> if Set.member (k, m) ks
441− then Just (k, m)
442− else Nothing
443− _ -> Nothing
444−
445−-- | A plain split of the available space into vertically stacked panes.
446−-- No visual separator is built in here.
447−splitV :: (Reflex t, Monad m, MonadNodeId m, HasVtyWidgetCtx t m, HasDisplaySize t m, HasVtyInput t m)
448− => Dynamic t (Int -> Int)
449− -- ^ Function used to determine size of first pane based on available size
450− -> Dynamic t (Bool, Bool)
451− -- ^ How to focus the two sub-panes, given that we are focused.
452− -> m a
453− -- ^ Widget for first pane
454− -> m b
455− -- ^ Widget for second pane
456− -> m (a,b)
457−splitV sizeFunD focD wA wB = do
458− dw <- displayWidth
459− dh <- displayHeight
460− let regA = Region 0 0 <$> dw <*> (sizeFunD <*> dh)
461− regB = Region 0 <$> (_region_height <$> regA) <*> dw <*> liftA2 (-) dh (_region_height <$> regA)
462− ra <- pane regA (fst <$> focD) wA
463− rb <- pane regB (snd <$> focD) wB
464− return (ra,rb)
465−
466−-- | A plain split of the available space into horizontally stacked panes.
467−-- No visual separator is built in here.
468−splitH :: (Reflex t, Monad m, MonadNodeId m, HasDisplaySize t m, HasVtyWidgetCtx t m, HasVtyInput t m)
469− => Dynamic t (Int -> Int)
470− -- ^ Function used to determine size of first pane based on available size
471− -> Dynamic t (Bool, Bool)
472− -- ^ How to focus the two sub-panes, given that we are focused.
473− -> m a
474− -- ^ Widget for first pane
475− -> m b
476− -- ^ Widget for second pane
477− -> m (a,b)
478−splitH sizeFunD focD wA wB = do
479− dw <- displayWidth
480− dh <- displayHeight
481− let regA = Region 0 0 <$> (sizeFunD <*> dw) <*> dh
482− regB = Region <$> (_region_width <$> regA) <*> 0 <*> liftA2 (-) dw (_region_width <$> regA) <*> dh
483− liftA2 (,) (pane regA (fmap fst focD) wA) (pane regB (fmap snd focD) wB)
484−
485−-- | A split of the available space into two parts with a draggable separator.
486−-- Starts with half the space allocated to each, and the first pane has focus.
487−-- Clicking in a pane switches focus.
488−splitVDrag :: (Reflex t, MonadFix m, MonadHold t m, MonadNodeId m, HasDisplaySize t m, HasVtyInput t m, HasVtyWidgetCtx t m)
489− => m ()
490− -> m a
491− -> m b
492− -> m (a,b)
493−splitVDrag wS wA wB = do
494− dh <- displayHeight
495− dw <- displayWidth
496− h0 <- sample $ current dh -- TODO
497− dragE <- drag V.BLeft
498− let splitter0 = h0 `div` 2
499− rec splitterCheckpoint <- holdDyn splitter0 $ leftmost [fst <$> ffilter snd dragSplitter, resizeSplitter]
500− splitterPos <- holdDyn splitter0 $ leftmost [fst <$> dragSplitter, resizeSplitter]
501− splitterFrac <- holdDyn ((1::Double) / 2) $ ffor (attach (current dh) (fst <$> dragSplitter)) $ \(h, x) ->
502− fromIntegral x / max 1 (fromIntegral h)
503− let dragSplitter = fforMaybe (attach (current splitterCheckpoint) dragE) $
504− \(splitterY, Drag (_, fromY) (_, toY) _ _ end) ->
505− if splitterY == fromY then Just (toY, end) else Nothing
506− regA = Region 0 0 <$> dw <*> splitterPos
507− regS = Region 0 <$> splitterPos <*> dw <*> 1
508− regB = Region 0 <$> (splitterPos + 1) <*> dw <*> (dh - splitterPos - 1)
509− resizeSplitter = ffor (attach (current splitterFrac) (updated dh)) $
510− \(frac, h) -> round (frac * fromIntegral h)
511− focA <- holdDyn True $ leftmost
512− [ True <$ mA
513− , False <$ mB
514− ]
515− (mA, rA) <- pane regA focA $ withMouseDown wA
516− pane regS (pure False) wS
517− (mB, rB) <- pane regB (not <$> focA) $ withMouseDown wB
518− return (rA, rB)
519− where
520− withMouseDown x = do
521− m <- mouseDown V.BLeft
522− x' <- x
523− return (m, x')
524−
525−-- | Fill the background with a particular character.
526−fill :: (HasDisplaySize t m, ImageWriter t m) => Char -> m ()
527−fill c = do
528− dw <- displayWidth
529− dh <- displayHeight
530− let fillImg = current $ liftA2 (\w h -> [V.charFill V.defAttr c w h]) dw dh
531− tellImages fillImg
532−
533−-- | Fill the background with the bottom
534−hRule :: (HasDisplaySize t m, ImageWriter t m) => BoxStyle -> m ()
535−hRule boxStyle = fill (_boxStyle_s boxStyle)
536−
537−-- | Defines a set of symbols to use to draw the outlines of boxes
538−-- C.f. https://en.wikipedia.org/wiki/Box-drawing_character
539−data BoxStyle = BoxStyle
540− { _boxStyle_nw :: Char
541− , _boxStyle_n :: Char
542− , _boxStyle_ne :: Char
543− , _boxStyle_e :: Char
544− , _boxStyle_se :: Char
545− , _boxStyle_s :: Char
546− , _boxStyle_sw :: Char
547− , _boxStyle_w :: Char
548− }
549−
550−instance Default BoxStyle where
551− def = singleBoxStyle
552−
553−-- | A box style that uses hyphens and pipe characters. Doesn't handle
554−-- corners very well.
555−hyphenBoxStyle :: BoxStyle
556−hyphenBoxStyle = BoxStyle '-' '-' '-' '|' '-' '-' '-' '|'
557−
558−-- | A single line box style
559−singleBoxStyle :: BoxStyle
560−singleBoxStyle = BoxStyle '┌' '─' '┐' '│' '┘' '─' '└' '│'
561−
562−-- | A thick single line box style
563−thickBoxStyle :: BoxStyle
564−thickBoxStyle = BoxStyle '┏' '━' '┓' '┃' '┛' '━' '┗' '┃'
565−
566−-- | A double line box style
567−doubleBoxStyle :: BoxStyle
568−doubleBoxStyle = BoxStyle '╔' '═' '╗' '║' '╝' '═' '╚' '║'
569−
570−-- | A single line box style with rounded corners
571−roundedBoxStyle :: BoxStyle
572−roundedBoxStyle = BoxStyle '╭' '─' '╮' '│' '╯' '─' '╰' '│'
573−
574−-- | Draws a titled box in the provided style and a child widget inside of that box
575−boxTitle :: (Monad m, Reflex t, MonadNodeId m, HasDisplaySize t m, ImageWriter t m, HasVtyWidgetCtx t m, HasVtyInput t m)
576− => Behavior t BoxStyle
577− -> Text
578− -> m a
579− -> m a
580−boxTitle boxStyle title child = do
581− dh <- displayHeight
582− dw <- displayWidth
583− let boxReg = Region 0 0 <$> dw <*> dh
584− innerReg = Region 1 1 <$> (subtract 2 <$> dw) <*> (subtract 2 <$> dh)
585− tellImages (boxImages <$> boxStyle <*> current boxReg)
586− tellImages (fmap (\r -> [regionBlankImage r]) (current innerReg))
587− pane innerReg (pure True) child
588− where
589− boxImages :: BoxStyle -> Region -> [Image]
590− boxImages style (Region left top width height) =
591− let right = left + width - 1
592− bottom = top + height - 1
593− sides =
594− [ withinImage (Region (left + 1) top (width - 2) 1) $
595− V.text' V.defAttr $
596− hPadText title (_boxStyle_n style) (width - 2)
597− , withinImage (Region right (top + 1) 1 (height - 2)) $
598− V.charFill V.defAttr (_boxStyle_e style) 1 (height - 2)
599− , withinImage (Region (left + 1) bottom (width - 2) 1) $
600− V.charFill V.defAttr (_boxStyle_s style) (width - 2) 1
601− , withinImage (Region left (top + 1) 1 (height - 2)) $
602− V.charFill V.defAttr (_boxStyle_w style) 1 (height - 2)
603− ]
604− corners =
605− [ withinImage (Region left top 1 1) $
606− V.char V.defAttr (_boxStyle_nw style)
607− , withinImage (Region right top 1 1) $
608− V.char V.defAttr (_boxStyle_ne style)
609− , withinImage (Region right bottom 1 1) $
610− V.char V.defAttr (_boxStyle_se style)
611− , withinImage (Region left bottom 1 1) $
612− V.char V.defAttr (_boxStyle_sw style)
613− ]
614− in sides ++ if width > 1 && height > 1 then corners else []
615− hPadText :: T.Text -> Char -> Int -> T.Text
616− hPadText t c l = if lt >= l
617− then t
618− else left <> t <> right
619− where
620− lt = T.length t
621− delta = l - lt
622− mkHalf n = T.replicate (n `div` 2) (T.singleton c)
623− left = mkHalf $ delta + 1
624− right = mkHalf delta
625−
626−-- | A box without a title
627−box :: (Monad m, Reflex t, MonadNodeId m, HasDisplaySize t m, ImageWriter t m, HasVtyWidgetCtx t m, HasVtyInput t m)
628− => Behavior t BoxStyle
629− -> m a
630− -> m a
631−box boxStyle = boxTitle boxStyle mempty
632−
633−-- | A box whose style is static
634−boxStatic
635− :: (Monad m, Reflex t, MonadNodeId m, HasDisplaySize t m, ImageWriter t m, HasVtyWidgetCtx t m, HasVtyInput t m)
636− => BoxStyle
637− -> m a
638− -> m a
639−boxStatic = box . pure
640−
641−-- | Configuration options for displaying "rich" text
642−data RichTextConfig t = RichTextConfig
643− { _richTextConfig_attributes :: Behavior t V.Attr
644− }
645−
646−instance Reflex t => Default (RichTextConfig t) where
647− def = RichTextConfig $ pure V.defAttr
648−
649−-- | A widget that displays text with custom time-varying attributes
650−richText
651− :: (Reflex t, Monad m, HasDisplaySize t m, ImageWriter t m)
652− => RichTextConfig t
653− -> Behavior t Text
654− -> m ()
655−richText cfg t = do
656− dw <- displayWidth
657− let img = (\w a s -> [wrapText w a s])
658− <$> current dw
659− <*> _richTextConfig_attributes cfg
660− <*> t
661− tellImages img
662− where
663− wrapText maxWidth attrs = V.vertCat
664− . concatMap (fmap (V.string attrs . T.unpack) . TZ.wrapWithOffset maxWidth 0)
665− . T.split (=='\n')
666−
667−-- | Renders text, wrapped to the container width
668−text
669− :: (Reflex t, Monad m, HasDisplaySize t m, ImageWriter t m)
670− => Behavior t Text
671− -> m ()
672−text = richText def
673−
674−-- | Scrollable text widget. The output pair exposes the current scroll position and total number of lines (including those
675−-- that are hidden)
676−scrollableText
677− :: forall t m. (Reflex t, MonadHold t m, MonadFix m, HasDisplaySize t m, HasVtyInput t m, ImageWriter t m)
678− => Event t Int
679− -- ^ Number of lines to scroll by
680− -> Behavior t Text
681− -> m (Behavior t (Int, Int))
682− -- ^ (Current scroll position, total number of lines)
683−scrollableText scrollBy t = do
684− dw <- displayWidth
685− let imgs = wrap <$> current dw <*> t
686− kup <- key V.KUp
687− kdown <- key V.KDown
688− m <- mouseScroll
689− let requestedScroll :: Event t Int
690− requestedScroll = leftmost
691− [ 1 <$ kdown
692− , (-1) <$ kup
693− , ffor m $ \case
694− ScrollDirection_Up -> (-1)
695− ScrollDirection_Down -> 1
696− , scrollBy
697− ]
698− updateLine maxN delta ix = min (max 0 (ix + delta)) maxN
699− lineIndex :: Dynamic t Int <- foldDyn (\(maxN, delta) ix -> updateLine (maxN - 1) delta ix) 0 $
700− attach (length <$> imgs) requestedScroll
701− tellImages $ fmap ((:[]) . V.vertCat) $ drop <$> current lineIndex <*> imgs
702− return $ (,) <$> ((+) <$> current lineIndex <*> pure 1) <*> (length <$> imgs)
703− where
704− wrap maxWidth = concatMap (fmap (V.string V.defAttr . T.unpack) . TZ.wrapWithOffset maxWidth 0) . T.split (=='\n')
705−
706−-- | Renders any behavior whose value can be converted to
707−-- 'String' as text
708−display
709− :: (Reflex t, Monad m, Show a, HasDisplaySize t m, ImageWriter t m)
710− => Behavior t a
711− -> m ()
712−display a = text $ T.pack . show <$> a
557+-- * Misc
713558
714559-- | A widget that draws nothing
715560blank :: Monad m => m ()