@@ -4,69 +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− , KeyCombo
51− , key
52− , keys
53− , keyCombo
54− , keyCombos
55− , blank
56− ) where
7+module Reflex.Vty.Widget where
578
589import Control.Applicative (liftA2)
5910import Control.Monad.Fix (MonadFix)
6011import Control.Monad.IO.Class (MonadIO)
12+import Control.Monad.Morph
6113import Control.Monad.NodeId
62−import Control.Monad.Reader (ReaderT, ask, asks, local, runReaderT)
14+import Control.Monad.Reader (ReaderT, ask, local, runReaderT)
15+import Control.Monad.Ref
6316import Control.Monad.Trans (MonadTrans, lift)
64−import Data.Default (Default(..))
6517import Data.Set (Set)
6618import qualified Data.Set as Set
67−import Data.Text (Text)
68−import qualified Data.Text as T
69−import qualified Data.Text.Zipper as TZ
7019import Graphics.Vty (Image)
7120import qualified Graphics.Vty as V
7221import Reflex
@@ -74,87 +23,20 @@ import Reflex.Class ()
7423import Reflex.Host.Class (MonadReflexCreateTrigger)
7524import Reflex.Vty.Host
7625
77−-- | The context within which a 'VtyWidget' runs
78−data VtyWidgetCtx t = VtyWidgetCtx
79− { _vtyWidgetCtx_width :: Dynamic t Int
80− -- ^ The width of the region allocated to the widget.
81− , _vtyWidgetCtx_height :: Dynamic t Int
82− -- ^ The height of the region allocated to the widget.
83− , _vtyWidgetCtx_focus :: Dynamic t Bool
84− -- ^ Whether the widget should behave as if it has focus for keyboard input.
85− , _vtyWidgetCtx_input :: Event t VtyEvent
86− -- ^ User input events that the widget's parent chooses to share. These will generally
87− -- be filtered for relevance:
88− -- * Keyboard inputs are restricted to focused widgets
89− -- * Mouse inputs are restricted to the region in which the widget resides and are
90− -- translated into its internal coordinates.
91− }
26+-- * Running a vty application
9227
93−-- | The output of a 'VtyWidget'
94−data VtyWidgetOut t = VtyWidgetOut
95− { _vtyWidgetOut_shutdown :: Event t ()
96− }
97−
98−instance (Adjustable t m, MonadHold t m, Reflex t) => Adjustable t (VtyWidget t m) where
99− runWithReplace a0 a' = VtyWidget $ runWithReplace (unVtyWidget a0) $ fmap unVtyWidget a'
100− traverseIntMapWithKeyWithAdjust f dm0 dm' = VtyWidget $
101− traverseIntMapWithKeyWithAdjust (\k v -> unVtyWidget (f k v)) dm0 dm'
102− traverseDMapWithKeyWithAdjust f dm0 dm' = VtyWidget $ do
103− traverseDMapWithKeyWithAdjust (\k v -> unVtyWidget (f k v)) dm0 dm'
104− traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = VtyWidget $ do
105− traverseDMapWithKeyWithAdjustWithMove (\k v -> unVtyWidget (f k v)) dm0 dm'
106−
107−-- | A widget that can read its context and produce image output
108−newtype VtyWidget t m a = VtyWidget
109− { unVtyWidget :: BehaviorWriterT t [Image] (ReaderT (VtyWidgetCtx t) m) a
110− } deriving
111− ( Functor
112− , Applicative
113− , Monad
114− , MonadSample t
115− , MonadHold t
116− , MonadFix
117− , NotReady t
118− , ImageWriter t
119− , PostBuild t
120− , TriggerEvent t
121− , MonadReflexCreateTrigger t
122− , MonadIO
123− )
124−
125−deriving instance PerformEvent t m => PerformEvent t (VtyWidget t m)
126−instance MonadTrans (VtyWidget t) where
127− lift f = VtyWidget $ lift $ lift f
128−
129−instance MonadNodeId m => MonadNodeId (VtyWidget t m) where
130− getNextNodeId = VtyWidget $ do
131− lift $ lift getNextNodeId
132−
133−class HasVtyWidgetCtx t m | m -> t where
134− askCtx :: m (VtyWidgetCtx t)
135− default askCtx :: (f m' ~ m, Monad m', MonadTrans f, HasVtyWidgetCtx t m') => m (VtyWidgetCtx t)
136− askCtx = lift askCtx
137− localCtx :: (VtyWidgetCtx t -> VtyWidgetCtx t) -> (Behavior t [Image] -> Behavior t [Image]) -> m a -> m a
138−
139−instance (Monad m, Reflex t) => HasVtyWidgetCtx t (VtyWidget t m) where
140− askCtx = VtyWidget $ lift ask
141− localCtx f g (VtyWidget x) = VtyWidget $ do
142− (a, images) :: (a, Behavior t [Image]) <- lift $ local f $ runBehaviorWriterT x
143− tellImages $ g images
144− pure a
145−
146−-- | Runs a 'VtyWidget' with a given context
147−runVtyWidget
148− :: (Reflex t, MonadNodeId m)
149− => VtyWidgetCtx t
150− -> VtyWidget t m a
151− -> m (a, Behavior t [Image])
152−runVtyWidget ctx w = runReaderT (runBehaviorWriterT (unVtyWidget w)) ctx
153−
154−-- | 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
15529mainWidgetWithHandle
15630 :: V.Vty
157− -> (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 ()))
15840 -> IO ()
15941mainWidgetWithHandle vty child =
16042 runVtyAppWithHandle vty $ \dr0 inp -> do
@@ -164,77 +46,178 @@ mainWidgetWithHandle vty child =
16446 let inp' = fforMaybe inp $ \case
16547 V.EvResize {} -> Nothing
16648 x -> Just x
167− let ctx = VtyWidgetCtx
168− { _vtyWidgetCtx_width = fmap fst size
169− , _vtyWidgetCtx_height = fmap snd size
170− , _vtyWidgetCtx_input = inp'
171− , _vtyWidgetCtx_focus = constDyn True
172− }
173− (shutdown, images) <- runNodeIdT $ runVtyWidget ctx $ do
174− tellImages . ffor (current size) $ \(w, h) -> [V.charFill V.defAttr ' ' w h]
175− 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
17657 return $ VtyResult
17758 { _vtyResult_picture = fmap (V.picForLayers . reverse) images
17859 , _vtyResult_shutdown = shutdown
17960 }
18061
62+-- | The output of a vty widget
63+data VtyWidgetOut t = VtyWidgetOut
64+ { _vtyWidgetOut_shutdown :: Event t ()
65+ }
66+
18167-- | Like 'mainWidgetWithHandle', but uses a default vty configuration
18268mainWidget
183− :: (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 ()))
18478 -> IO ()
18579mainWidget child = do
18680 vty <- getDefaultVty
18781 mainWidgetWithHandle vty child
18882
189−-- | A class for things that know their own display size dimensions
190−class (Reflex t, Monad m) => HasDisplaySize t m | m -> t where
191− -- | Retrieve the display width (columns)
192− displayWidth :: m (Dynamic t Int)
193− default displayWidth :: (f m' ~ m, MonadTrans f, HasDisplaySize t m') => m (Dynamic t Int)
194− displayWidth = lift displayWidth
195− -- | Retrieve the display height (rows)
196− displayHeight :: m (Dynamic t Int)
197− default displayHeight :: (f m' ~ m, MonadTrans f, HasDisplaySize t m') => m (Dynamic t Int)
198− displayHeight = lift displayHeight
199−
200−instance (Reflex t, Monad m) => HasDisplaySize t (VtyWidget t m) where
201− displayWidth = VtyWidget . lift $ asks _vtyWidgetCtx_width
202− displayHeight = VtyWidget . lift $ asks _vtyWidgetCtx_height
203−
204−instance HasDisplaySize t m => HasDisplaySize t (ReaderT x m)
205−instance HasDisplaySize t m => HasDisplaySize t (BehaviorWriterT t x m)
206−instance HasDisplaySize t m => HasDisplaySize t (DynamicWriterT t x m)
207−instance HasDisplaySize t m => HasDisplaySize t (EventWriterT t x m)
208−
209−instance HasDisplaySize t m => HasDisplaySize t (NodeIdT m)
83+-- * Input Events
21084
21185-- | A class for things that can receive vty events as input
212−class HasVtyInput t m | m -> t where
86+class HasInput t m | m -> t where
21387 input :: m (Event t VtyEvent)
214− 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)
21589 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)
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+ )
216113
217−instance (Reflex t, Monad m) => HasVtyInput t (VtyWidget t m) where
218− input = VtyWidget . lift $ asks _vtyWidgetCtx_input
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
219147
220−-- | A class for things that can dynamically gain and lose focus
221−class HasFocus t m | m -> t where
222− focus :: m (Dynamic t Bool)
223− default focus :: (f m' ~ m, Monad m', MonadTrans f, HasFocus t m') => m (Dynamic t Bool)
224− focus = lift focus
148+-- ** Filtering input
225149
226−instance (Reflex t, Monad m) => HasFocus t (VtyWidget t m) where
227− focus = VtyWidget . lift $ asks _vtyWidgetCtx_focus
150+-- | Type synonym for a key and modifier combination
151+type KeyCombo = (V.Key, [V.Modifier])
228152
229−-- | A class for widgets that can produce images to draw to the display
230−class (Reflex t, Monad m) => ImageWriter t m | m -> t where
231− -- | Send images upstream for rendering
232− tellImages :: Behavior t [Image] -> m ()
233− default tellImages :: (f m' ~ m, Monad m', MonadTrans f, ImageWriter t m') => Behavior t [Image] -> m ()
234− tellImages = lift . tellImages
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
235167
236−instance (Monad m, Reflex t) => ImageWriter t (BehaviorWriterT t [Image] m) where
237− tellImages = tellBehavior
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
180+
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)
185+ _ -> True)) x
186+
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
219+
220+-- * Getting and setting the display region
238221
239222-- | A chunk of the display area
240223data Region = Region
@@ -245,14 +228,293 @@ data Region = Region
245228 }
246229 deriving (Show, Read, Eq, Ord)
247230
231+-- | A region that occupies no space.
232+nilRegion :: Region
233+nilRegion = Region 0 0 0 0
234+
248235-- | The width and height of a 'Region'
249236regionSize :: Region -> (Int, Int)
250237regionSize (Region _ _ w h) = (w, h)
251238
252239-- | Produces an 'Image' that fills a region with space characters
253−regionBlankImage :: Region -> Image
254−regionBlankImage r@(Region _ _ width height) =
255− 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
256518
257519-- | Translates and crops an 'Image' so that it is contained by
258520-- the given 'Region'.
@@ -264,7 +526,17 @@ withinImage (Region left top width height)
264526 | width < 0 || height < 0 = withinImage (Region left top 0 0)
265527 | otherwise = V.translate left top . V.crop width height
266528
267−-- | 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
268540-- a given region and context. This widget filters and modifies the input
269541-- that the child widget receives such that:
270542-- * unfocused widgets receive no key events
@@ -272,434 +544,17 @@ withinImage (Region left top width height)
272544-- * mouse inputs inside the region have their coordinates translated such
273545-- that (0,0) is the top-left corner of the region
274546pane
275− :: (Reflex t, Monad m, MonadNodeId m, HasVtyWidgetCtx t m)
547+ :: (Reflex t, Monad m, HasInput t m, HasImageWriter t m, HasDisplayRegion t m, HasFocusReader t m)
276548 => Dynamic t Region
277549 -> Dynamic t Bool -- ^ Whether the widget should be focused when the parent is.
278550 -> m a
279551 -> m a
280−pane dr foc child = do
281− let reg = current dr
282− let subContext ctx = VtyWidgetCtx
283− { _vtyWidgetCtx_input = fmapMaybe id $
284− attachWith (\(r,f) e -> filterInput r f e)
285− (liftA2 (,) reg (current foc))
286− (_vtyWidgetCtx_input ctx)
287− , _vtyWidgetCtx_focus = liftA2 (&&) (_vtyWidgetCtx_focus ctx) foc
288− , _vtyWidgetCtx_width = _region_width <$> dr
289− , _vtyWidgetCtx_height = _region_height <$> dr
290− }
291− let imagesWithinRegion images = liftA2 (\is r -> map (withinImage r) is) images reg
292− localCtx subContext imagesWithinRegion child
293− where
294− filterInput :: Region -> Bool -> VtyEvent -> Maybe VtyEvent
295− filterInput (Region l t w h) focused e = case e of
296− V.EvKey _ _ | not focused -> Nothing
297− V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
298− V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
299− _ -> Just e
300− where
301− mouse con x y
302− | or [ x < l
303− , y < t
304− , x >= l + w
305− , y >= t + h ] = Nothing
306− | otherwise =
307− Just (con (x - l) (y - t))
308−
309−-- | Information about a drag operation
310−data Drag = Drag
311− { _drag_from :: (Int, Int) -- ^ Where the drag began
312− , _drag_to :: (Int, Int) -- ^ Where the mouse currently is
313− , _drag_button :: V.Button -- ^ Which mouse button is dragging
314− , _drag_modifiers :: [V.Modifier] -- ^ What modifiers are held
315− , _drag_end :: Bool -- ^ Whether the drag ended (the mouse button was released)
316− }
317− deriving (Eq, Ord, Show)
318−
319−-- | Converts raw vty mouse drag events into an event stream of 'Drag's
320−drag
321− :: (Reflex t, MonadFix m, MonadHold t m, HasVtyInput t m)
322− => V.Button
323− -> m (Event t Drag)
324−drag btn = do
325− inp <- input
326− let f :: Maybe Drag -> V.Event -> Maybe Drag
327− f Nothing = \case
328− V.EvMouseDown x y btn' mods
329− | btn == btn' -> Just $ Drag (x,y) (x,y) btn' mods False
330− | otherwise -> Nothing
331− _ -> Nothing
332− f (Just (Drag from _ _ mods end)) = \case
333− V.EvMouseDown x y btn' mods'
334− | end && btn == btn' -> Just $ Drag (x,y) (x,y) btn' mods' False
335− | btn == btn' -> Just $ Drag from (x,y) btn mods' False
336− | otherwise -> Nothing -- Ignore other buttons.
337− V.EvMouseUp x y (Just btn')
338− | end -> Nothing
339− | btn == btn' -> Just $ Drag from (x,y) btn mods True
340− | otherwise -> Nothing
341− V.EvMouseUp x y Nothing -- Terminal doesn't specify mouse up button,
342− -- assume it's the right one.
343− | end -> Nothing
344− | otherwise -> Just $ Drag from (x,y) btn mods True
345− _ -> Nothing
346− rec let newDrag = attachWithMaybe f (current dragD) inp
347− dragD <- holdDyn Nothing $ Just <$> newDrag
348− return (fmapMaybe id $ updated dragD)
349−
350−-- | Mouse down events for a particular mouse button
351−mouseDown
352− :: (Reflex t, Monad m, HasVtyInput t m)
353− => V.Button
354− -> m (Event t MouseDown)
355−mouseDown btn = do
356− i <- input
357− return $ fforMaybe i $ \case
358− V.EvMouseDown x y btn' mods -> if btn == btn'
359− then Just $ MouseDown btn' (x, y) mods
360− else Nothing
361− _ -> Nothing
362−
363−-- | Mouse up events for a particular mouse button
364−mouseUp
365− :: (Reflex t, Monad m, HasVtyInput t m)
366− => m (Event t MouseUp)
367−mouseUp = do
368− i <- input
369− return $ fforMaybe i $ \case
370− V.EvMouseUp x y btn' -> Just $ MouseUp btn' (x, y)
371− _ -> Nothing
372−
373−-- | Information about a mouse down event
374−data MouseDown = MouseDown
375− { _mouseDown_button :: V.Button
376− , _mouseDown_coordinates :: (Int, Int)
377− , _mouseDown_modifiers :: [V.Modifier]
378− }
379− deriving (Eq, Ord, Show)
380−
381−-- | Information about a mouse up event
382−data MouseUp = MouseUp
383− { _mouseUp_button :: Maybe V.Button
384− , _mouseUp_coordinates :: (Int, Int)
385− }
386− deriving (Eq, Ord, Show)
387−
388−-- | Mouse scroll direction
389−data ScrollDirection = ScrollDirection_Up | ScrollDirection_Down
390− deriving (Eq, Ord, Show)
391−
392−-- | Produce an event that fires when the mouse wheel is scrolled
393−mouseScroll
394− :: (Reflex t, Monad m, HasVtyInput t m)
395− => m (Event t ScrollDirection)
396−mouseScroll = do
397− up <- mouseDown V.BScrollUp
398− down <- mouseDown V.BScrollDown
399− return $ leftmost
400− [ ScrollDirection_Up <$ up
401− , ScrollDirection_Down <$ down
402− ]
403−
404−-- | Type synonym for a key and modifier combination
405−type KeyCombo = (V.Key, [V.Modifier])
406−
407−-- | Emits an event that fires on a particular key press (without modifiers)
408−key :: (Monad m, Reflex t, HasVtyInput t m) => V.Key -> m (Event t KeyCombo)
409−key = keyCombos . Set.singleton . (,[])
410−
411−-- | Emits an event that fires on particular key presses (without modifiers)
412−keys :: (Monad m, Reflex t, HasVtyInput t m) => [V.Key] -> m (Event t KeyCombo)
413−keys = keyCombos . Set.fromList . fmap (,[])
414−
415−-- | Emit an event that fires whenever the provided key combination occurs
416−keyCombo
417− :: (Reflex t, Monad m, HasVtyInput t m)
418− => KeyCombo
419− -> m (Event t KeyCombo)
420−keyCombo = keyCombos . Set.singleton
421−
422−-- | Emit an event that fires whenever any of the provided key combinations occur
423−keyCombos
424− :: (Reflex t, Monad m, HasVtyInput t m)
425− => Set KeyCombo
426− -> m (Event t KeyCombo)
427−keyCombos ks = do
428− i <- input
429− return $ fforMaybe i $ \case
430− V.EvKey k m -> if Set.member (k, m) ks
431− then Just (k, m)
432− else Nothing
433− _ -> Nothing
434−
435−-- | A plain split of the available space into vertically stacked panes.
436−-- No visual separator is built in here.
437−splitV :: (Reflex t, Monad m, MonadNodeId m, HasVtyWidgetCtx t m, HasDisplaySize t m)
438− => Dynamic t (Int -> Int)
439− -- ^ Function used to determine size of first pane based on available size
440− -> Dynamic t (Bool, Bool)
441− -- ^ How to focus the two sub-panes, given that we are focused.
442− -> m a
443− -- ^ Widget for first pane
444− -> m b
445− -- ^ Widget for second pane
446− -> m (a,b)
447−splitV sizeFunD focD wA wB = do
448− dw <- displayWidth
449− dh <- displayHeight
450− let regA = Region 0 0 <$> dw <*> (sizeFunD <*> dh)
451− regB = Region 0 <$> (_region_height <$> regA) <*> dw <*> liftA2 (-) dh (_region_height <$> regA)
452− ra <- pane regA (fst <$> focD) wA
453− rb <- pane regB (snd <$> focD) wB
454− return (ra,rb)
455−
456−-- | A plain split of the available space into horizontally stacked panes.
457−-- No visual separator is built in here.
458−splitH :: (Reflex t, Monad m, MonadNodeId m, HasDisplaySize t m, HasVtyWidgetCtx t m)
459− => Dynamic t (Int -> Int)
460− -- ^ Function used to determine size of first pane based on available size
461− -> Dynamic t (Bool, Bool)
462− -- ^ How to focus the two sub-panes, given that we are focused.
463− -> m a
464− -- ^ Widget for first pane
465− -> m b
466− -- ^ Widget for second pane
467− -> m (a,b)
468−splitH sizeFunD focD wA wB = do
469− dw <- displayWidth
470− dh <- displayHeight
471− let regA = Region 0 0 <$> (sizeFunD <*> dw) <*> dh
472− regB = Region <$> (_region_width <$> regA) <*> 0 <*> liftA2 (-) dw (_region_width <$> regA) <*> dh
473− liftA2 (,) (pane regA (fmap fst focD) wA) (pane regB (fmap snd focD) wB)
474−
475−-- | A split of the available space into two parts with a draggable separator.
476−-- Starts with half the space allocated to each, and the first pane has focus.
477−-- Clicking in a pane switches focus.
478−splitVDrag :: (Reflex t, MonadFix m, MonadHold t m, MonadNodeId m, HasDisplaySize t m, HasVtyInput t m, HasVtyWidgetCtx t m)
479− => m ()
480− -> m a
481− -> m b
482− -> m (a,b)
483−splitVDrag wS wA wB = do
484− dh <- displayHeight
485− dw <- displayWidth
486− h0 <- sample $ current dh -- TODO
487− dragE <- drag V.BLeft
488− let splitter0 = h0 `div` 2
489− rec splitterCheckpoint <- holdDyn splitter0 $ leftmost [fst <$> ffilter snd dragSplitter, resizeSplitter]
490− splitterPos <- holdDyn splitter0 $ leftmost [fst <$> dragSplitter, resizeSplitter]
491− splitterFrac <- holdDyn ((1::Double) / 2) $ ffor (attach (current dh) (fst <$> dragSplitter)) $ \(h, x) ->
492− fromIntegral x / max 1 (fromIntegral h)
493− let dragSplitter = fforMaybe (attach (current splitterCheckpoint) dragE) $
494− \(splitterY, Drag (_, fromY) (_, toY) _ _ end) ->
495− if splitterY == fromY then Just (toY, end) else Nothing
496− regA = Region 0 0 <$> dw <*> splitterPos
497− regS = Region 0 <$> splitterPos <*> dw <*> 1
498− regB = Region 0 <$> (splitterPos + 1) <*> dw <*> (dh - splitterPos - 1)
499− resizeSplitter = ffor (attach (current splitterFrac) (updated dh)) $
500− \(frac, h) -> round (frac * fromIntegral h)
501− focA <- holdDyn True $ leftmost
502− [ True <$ mA
503− , False <$ mB
504− ]
505− (mA, rA) <- pane regA focA $ withMouseDown wA
506− pane regS (pure False) wS
507− (mB, rB) <- pane regB (not <$> focA) $ withMouseDown wB
508− return (rA, rB)
509− where
510− withMouseDown x = do
511− m <- mouseDown V.BLeft
512− x' <- x
513− return (m, x')
514−
515−-- | Fill the background with a particular character.
516−fill :: (HasDisplaySize t m, ImageWriter t m) => Char -> m ()
517−fill c = do
518− dw <- displayWidth
519− dh <- displayHeight
520− let fillImg = current $ liftA2 (\w h -> [V.charFill V.defAttr c w h]) dw dh
521− tellImages fillImg
522−
523−-- | Fill the background with the bottom
524−hRule :: (HasDisplaySize t m, ImageWriter t m) => BoxStyle -> m ()
525−hRule boxStyle = fill (_boxStyle_s boxStyle)
526−
527−-- | Defines a set of symbols to use to draw the outlines of boxes
528−-- C.f. https://en.wikipedia.org/wiki/Box-drawing_character
529−data BoxStyle = BoxStyle
530− { _boxStyle_nw :: Char
531− , _boxStyle_n :: Char
532− , _boxStyle_ne :: Char
533− , _boxStyle_e :: Char
534− , _boxStyle_se :: Char
535− , _boxStyle_s :: Char
536− , _boxStyle_sw :: Char
537− , _boxStyle_w :: Char
538− }
552+pane dr foc child = localRegion (const dr) $
553+ mapImages (imagesInRegion $ current dr) $
554+ localFocus (const foc) $
555+ inputInFocusedRegion >>= \e -> localInput (const e) child
539556
540−instance Default BoxStyle where
541− def = singleBoxStyle
542−
543−-- | A box style that uses hyphens and pipe characters. Doesn't handle
544−-- corners very well.
545−hyphenBoxStyle :: BoxStyle
546−hyphenBoxStyle = BoxStyle '-' '-' '-' '|' '-' '-' '-' '|'
547−
548−-- | A single line box style
549−singleBoxStyle :: BoxStyle
550−singleBoxStyle = BoxStyle '┌' '─' '┐' '│' '┘' '─' '└' '│'
551−
552−-- | A thick single line box style
553−thickBoxStyle :: BoxStyle
554−thickBoxStyle = BoxStyle '┏' '━' '┓' '┃' '┛' '━' '┗' '┃'
555−
556−-- | A double line box style
557−doubleBoxStyle :: BoxStyle
558−doubleBoxStyle = BoxStyle '╔' '═' '╗' '║' '╝' '═' '╚' '║'
559−
560−-- | A single line box style with rounded corners
561−roundedBoxStyle :: BoxStyle
562−roundedBoxStyle = BoxStyle '╭' '─' '╮' '│' '╯' '─' '╰' '│'
563−
564−-- | Draws a titled box in the provided style and a child widget inside of that box
565−boxTitle :: (Monad m, Reflex t, MonadNodeId m, HasDisplaySize t m, ImageWriter t m, HasVtyWidgetCtx t m)
566− => Behavior t BoxStyle
567− -> Text
568− -> m a
569− -> m a
570−boxTitle boxStyle title child = do
571− dh <- displayHeight
572− dw <- displayWidth
573− let boxReg = Region 0 0 <$> dw <*> dh
574− innerReg = Region 1 1 <$> (subtract 2 <$> dw) <*> (subtract 2 <$> dh)
575− tellImages (boxImages <$> boxStyle <*> current boxReg)
576− tellImages (fmap (\r -> [regionBlankImage r]) (current innerReg))
577− pane innerReg (pure True) child
578− where
579− boxImages :: BoxStyle -> Region -> [Image]
580− boxImages style (Region left top width height) =
581− let right = left + width - 1
582− bottom = top + height - 1
583− sides =
584− [ withinImage (Region (left + 1) top (width - 2) 1) $
585− V.text' V.defAttr $
586− hPadText title (_boxStyle_n style) (width - 2)
587− , withinImage (Region right (top + 1) 1 (height - 2)) $
588− V.charFill V.defAttr (_boxStyle_e style) 1 (height - 2)
589− , withinImage (Region (left + 1) bottom (width - 2) 1) $
590− V.charFill V.defAttr (_boxStyle_s style) (width - 2) 1
591− , withinImage (Region left (top + 1) 1 (height - 2)) $
592− V.charFill V.defAttr (_boxStyle_w style) 1 (height - 2)
593− ]
594− corners =
595− [ withinImage (Region left top 1 1) $
596− V.char V.defAttr (_boxStyle_nw style)
597− , withinImage (Region right top 1 1) $
598− V.char V.defAttr (_boxStyle_ne style)
599− , withinImage (Region right bottom 1 1) $
600− V.char V.defAttr (_boxStyle_se style)
601− , withinImage (Region left bottom 1 1) $
602− V.char V.defAttr (_boxStyle_sw style)
603− ]
604− in sides ++ if width > 1 && height > 1 then corners else []
605− hPadText :: T.Text -> Char -> Int -> T.Text
606− hPadText t c l = if lt >= l
607− then t
608− else left <> t <> right
609− where
610− lt = T.length t
611− delta = l - lt
612− mkHalf n = T.replicate (n `div` 2) (T.singleton c)
613− left = mkHalf $ delta + 1
614− right = mkHalf delta
615−
616−-- | A box without a title
617−box :: (Monad m, Reflex t, MonadNodeId m, HasDisplaySize t m, ImageWriter t m, HasVtyWidgetCtx t m)
618− => Behavior t BoxStyle
619− -> m a
620− -> m a
621−box boxStyle = boxTitle boxStyle mempty
622−
623−-- | A box whose style is static
624−boxStatic
625− :: (Monad m, Reflex t, MonadNodeId m, HasDisplaySize t m, ImageWriter t m, HasVtyWidgetCtx t m)
626− => BoxStyle
627− -> m a
628− -> m a
629−boxStatic = box . pure
630−
631−-- | Configuration options for displaying "rich" text
632−data RichTextConfig t = RichTextConfig
633− { _richTextConfig_attributes :: Behavior t V.Attr
634− }
635−
636−instance Reflex t => Default (RichTextConfig t) where
637− def = RichTextConfig $ pure V.defAttr
638−
639−-- | A widget that displays text with custom time-varying attributes
640−richText
641− :: (Reflex t, Monad m, HasDisplaySize t m, ImageWriter t m)
642− => RichTextConfig t
643− -> Behavior t Text
644− -> m ()
645−richText cfg t = do
646− dw <- displayWidth
647− let img = (\w a s -> [wrapText w a s])
648− <$> current dw
649− <*> _richTextConfig_attributes cfg
650− <*> t
651− tellImages img
652− where
653− wrapText maxWidth attrs = V.vertCat
654− . concatMap (fmap (V.string attrs . T.unpack) . TZ.wrapWithOffset maxWidth 0)
655− . T.split (=='\n')
656−
657−-- | Renders text, wrapped to the container width
658−text
659− :: (Reflex t, Monad m, HasDisplaySize t m, ImageWriter t m)
660− => Behavior t Text
661− -> m ()
662−text = richText def
663−
664−-- | Scrollable text widget. The output pair exposes the current scroll position and total number of lines (including those
665−-- that are hidden)
666−scrollableText
667− :: forall t m. (Reflex t, MonadHold t m, MonadFix m, HasDisplaySize t m, HasVtyInput t m, ImageWriter t m)
668− => Event t Int
669− -- ^ Number of lines to scroll by
670− -> Behavior t Text
671− -> m (Behavior t (Int, Int))
672− -- ^ (Current scroll position, total number of lines)
673−scrollableText scrollBy t = do
674− dw <- displayWidth
675− let imgs = wrap <$> current dw <*> t
676− kup <- key V.KUp
677− kdown <- key V.KDown
678− m <- mouseScroll
679− let requestedScroll :: Event t Int
680− requestedScroll = leftmost
681− [ 1 <$ kdown
682− , (-1) <$ kup
683− , ffor m $ \case
684− ScrollDirection_Up -> (-1)
685− ScrollDirection_Down -> 1
686− , scrollBy
687− ]
688− updateLine maxN delta ix = min (max 0 (ix + delta)) maxN
689− lineIndex :: Dynamic t Int <- foldDyn (\(maxN, delta) ix -> updateLine (maxN - 1) delta ix) 0 $
690− attach (length <$> imgs) requestedScroll
691− tellImages $ fmap ((:[]) . V.vertCat) $ drop <$> current lineIndex <*> imgs
692− return $ (,) <$> ((+) <$> current lineIndex <*> pure 1) <*> (length <$> imgs)
693− where
694− wrap maxWidth = concatMap (fmap (V.string V.defAttr . T.unpack) . TZ.wrapWithOffset maxWidth 0) . T.split (=='\n')
695−
696−-- | Renders any behavior whose value can be converted to
697−-- 'String' as text
698−display
699− :: (Reflex t, Monad m, Show a, HasDisplaySize t m, ImageWriter t m)
700− => Behavior t a
701− -> m ()
702−display a = text $ T.pack . show <$> a
557+-- * Misc
703558
704559-- | A widget that draws nothing
705560blank :: Monad m => m ()