@@ -2,41 +2,167 @@
2Module: Reflex.Vty.Widget
2Module: Reflex.Vty.Widget
3Description: Basic set of widgets and building blocks for reflex-vty applications
3Description: Basic set of widgets and building blocks for reflex-vty applications
5+{-# LANGUAGE DefaultSignatures #-}
6+{-# LANGUAGE DeriveFunctor #-}
7+{-# LANGUAGE FlexibleContexts #-}
8+{-# LANGUAGE FlexibleInstances #-}
9+{-# LANGUAGE FunctionalDependencies #-}
10+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
11+{-# LANGUAGE LambdaCase #-}
12+{-# LANGUAGE RankNTypes #-}
13+{-# LANGUAGE RecursiveDo #-}
14+{-# LANGUAGE ScopedTypeVariables #-}
15+{-# LANGUAGE StandaloneDeriving #-}
16+{-# LANGUAGE TupleSections #-}
17+{-# LANGUAGE TypeFamilies #-}
5−{-# Language UndecidableInstances #-}
18+{-# LANGUAGE UndecidableInstances #-}
7−module Reflex.Vty.Widget where
20+module Reflex.Vty.Widget
27+ , mainWidgetWithHandle
32+ -- TODO get rid of DynRegion?
46+ , ScrollDirection(..)
9import Control.Applicative (liftA2)
76import Control.Applicative (liftA2)
77+import Control.Monad (join)
10import Control.Monad.Fix (MonadFix)
78import Control.Monad.Fix (MonadFix)
11import Control.Monad.IO.Class (MonadIO)
79import Control.Monad.IO.Class (MonadIO)
12−import Control.Monad.Morph
13−import Control.Monad.NodeId
14−import Control.Monad.Reader (ReaderT, ask, local, runReaderT)
80+import Control.Monad.Reader (ReaderT, ask, asks, runReaderT)
15−import Control.Monad.Ref
16import Control.Monad.Trans (MonadTrans, lift)
81import Control.Monad.Trans (MonadTrans, lift)
82+import Data.Default (Default(..))
17import Data.Set (Set)
83import Data.Set (Set)
18import qualified Data.Set as Set
84import qualified Data.Set as Set
85+import Data.Text (Text)
86+import qualified Data.Text as T
87+import qualified Data.Text.Zipper as TZ
19import Graphics.Vty (Image)
88import Graphics.Vty (Image)
20import qualified Graphics.Vty as V
89import qualified Graphics.Vty as V
21import Reflex
90import Reflex
22import Reflex.Class ()
91import Reflex.Class ()
23import Reflex.Host.Class (MonadReflexCreateTrigger)
92import Reflex.Host.Class (MonadReflexCreateTrigger)
24import Reflex.Vty.Host
94import Reflex.Vty.Host
26−-- * Running a vty application
96+import Control.Monad.NodeId
98+-- | The context within which a 'VtyWidget' runs
99+data VtyWidgetCtx t = VtyWidgetCtx
100+ { _vtyWidgetCtx_width :: Dynamic t Int
101+ -- ^ The width of the region allocated to the widget.
102+ , _vtyWidgetCtx_height :: Dynamic t Int
103+ -- ^ The height of the region allocated to the widget.
104+ , _vtyWidgetCtx_focus :: Dynamic t Bool
105+ -- ^ Whether the widget should behave as if it has focus for keyboard input.
106+ , _vtyWidgetCtx_input :: Event t VtyEvent
107+ -- ^ User input events that the widget's parent chooses to share. These will generally
108+ -- be filtered for relevance:
109+ -- * Keyboard inputs are restricted to focused widgets
110+ -- * Mouse inputs are restricted to the region in which the widget resides and are
111+ -- translated into its internal coordinates.
114+-- | The output of a 'VtyWidget'
115+data VtyWidgetOut t = VtyWidgetOut
116+ { _vtyWidgetOut_shutdown :: Event t ()
119+instance (Adjustable t m, MonadHold t m, Reflex t) => Adjustable t (VtyWidget t m) where
120+ runWithReplace a0 a' = VtyWidget $ runWithReplace (unVtyWidget a0) $ fmap unVtyWidget a'
121+ traverseIntMapWithKeyWithAdjust f dm0 dm' = VtyWidget $
122+ traverseIntMapWithKeyWithAdjust (\k v -> unVtyWidget (f k v)) dm0 dm'
123+ traverseDMapWithKeyWithAdjust f dm0 dm' = VtyWidget $ do
124+ traverseDMapWithKeyWithAdjust (\k v -> unVtyWidget (f k v)) dm0 dm'
125+ traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = VtyWidget $ do
126+ traverseDMapWithKeyWithAdjustWithMove (\k v -> unVtyWidget (f k v)) dm0 dm'
128+-- | A widget that can read its context and produce image output
129+newtype VtyWidget t m a = VtyWidget
130+ { unVtyWidget :: BehaviorWriterT t [Image] (ReaderT (VtyWidgetCtx t) m) a
142+ , MonadReflexCreateTrigger t
146+deriving instance PerformEvent t m => PerformEvent t (VtyWidget t m)
147+instance MonadTrans (VtyWidget t) where
148+ lift f = VtyWidget $ lift $ lift f
150+instance MonadNodeId m => MonadNodeId (VtyWidget t m) where
151+ getNextNodeId = VtyWidget $ do
152+ lift $ lift getNextNodeId
154+-- | Runs a 'VtyWidget' with a given context
156+ :: (Reflex t, MonadNodeId m)
159+ -> m (a, Behavior t [Image])
160+runVtyWidget ctx w = runReaderT (runBehaviorWriterT (unVtyWidget w)) ctx
28−-- | Sets up the top-level context for a vty widget and runs it with that context
162+-- | Sets up the top-level context for a 'VtyWidget' and runs it with that context
29mainWidgetWithHandle
163mainWidgetWithHandle
32− ( MonadVtyApp t m
165+ -> (forall t m. (MonadVtyApp t m, MonadNodeId m) => VtyWidget t m (Event t ()))
35− , HasDisplayRegion t m
41mainWidgetWithHandle vty child =
167mainWidgetWithHandle vty child =
42 runVtyAppWithHandle vty $ \dr0 inp -> do
168 runVtyAppWithHandle vty $ \dr0 inp -> do
@@ -46,178 +172,71 @@ mainWidgetWithHandle vty child =
46 let inp' = fforMaybe inp $ \case
172 let inp' = fforMaybe inp $ \case
47 V.EvResize {} -> Nothing
173 V.EvResize {} -> Nothing
48 x -> Just x
174 x -> Just x
49− (shutdown, images) <- runThemeReader (constant V.defAttr) $
175+ let ctx = VtyWidgetCtx
50− runFocusReader (pure True) $
176+ { _vtyWidgetCtx_width = fmap fst size
51− runDisplayRegion (fmap (\(w, h) -> Region 0 0 w h) size) $
177+ , _vtyWidgetCtx_height = fmap snd size
52− runImageWriter $
178+ , _vtyWidgetCtx_input = inp'
53− runNodeIdT $
179+ , _vtyWidgetCtx_focus = constDyn True
54− runInput inp' $ do
180+ }
181+ (shutdown, images) <- runNodeIdT $ runVtyWidget ctx $ do
55− tellImages . ffor (current size) $ \(w, h) -> [V.charFill V.defAttr ' ' w h]
182+ tellImages . ffor (current size) $ \(w, h) -> [V.charFill V.defAttr ' ' w h]
57 return $ VtyResult
184 return $ VtyResult
58 { _vtyResult_picture = fmap (V.picForLayers . reverse) images
185 { _vtyResult_picture = fmap (V.picForLayers . reverse) images
59 , _vtyResult_shutdown = shutdown
186 , _vtyResult_shutdown = shutdown
62−-- | The output of a vty widget
63−data VtyWidgetOut t = VtyWidgetOut
64− { _vtyWidgetOut_shutdown :: Event t ()
67-- | Like 'mainWidgetWithHandle', but uses a default vty configuration
189-- | Like 'mainWidgetWithHandle', but uses a default vty configuration
68mainWidget
190mainWidget
70− ( MonadVtyApp t m
191+ :: (forall t m. (MonadVtyApp t m, MonadNodeId m) => VtyWidget t m (Event t ()))
73− , HasDisplayRegion t m
79mainWidget child = do
193mainWidget child = do
80 vty <- getDefaultVty
194 vty <- getDefaultVty
81 mainWidgetWithHandle vty child
195 mainWidgetWithHandle vty child
83−-- * Input Events
197+-- | A class for things that know their own display size dimensions
198+class (Reflex t, Monad m) => HasDisplaySize t m | m -> t where
199+ -- | Retrieve the display width (columns)
200+ displayWidth :: m (Dynamic t Int)
201+ default displayWidth :: (f m' ~ m, MonadTrans f, HasDisplaySize t m') => m (Dynamic t Int)
202+ displayWidth = lift displayWidth
203+ -- | Retrieve the display height (rows)
204+ displayHeight :: m (Dynamic t Int)
205+ default displayHeight :: (f m' ~ m, MonadTrans f, HasDisplaySize t m') => m (Dynamic t Int)
206+ displayHeight = lift displayHeight
208+instance (Reflex t, Monad m) => HasDisplaySize t (VtyWidget t m) where
209+ displayWidth = VtyWidget . lift $ asks _vtyWidgetCtx_width
210+ displayHeight = VtyWidget . lift $ asks _vtyWidgetCtx_height
212+instance HasDisplaySize t m => HasDisplaySize t (ReaderT x m)
213+instance HasDisplaySize t m => HasDisplaySize t (BehaviorWriterT t x m)
214+instance HasDisplaySize t m => HasDisplaySize t (DynamicWriterT t x m)
215+instance HasDisplaySize t m => HasDisplaySize t (EventWriterT t x m)
217+instance HasDisplaySize t m => HasDisplaySize t (NodeIdT m)
85-- | A class for things that can receive vty events as input
219-- | A class for things that can receive vty events as input
86−class HasInput t m | m -> t where
220+class HasVtyInput t m | m -> t where
87 input :: m (Event t VtyEvent)
221 input :: m (Event t VtyEvent)
88− default input :: (f m' ~ m, Monad m', MonadTrans f, HasInput t m') => m (Event t VtyEvent)
90− -- | User input events that the widget's parent chooses to share. These will generally
91− -- be filtered for relevance.
92− localInput :: (Event t VtyEvent -> Event t VtyEvent) -> m a -> m a
93− default localInput :: (f m' ~ m, Monad m', MFunctor f, HasInput t m') => (Event t VtyEvent -> Event t VtyEvent) -> m a -> m a
94− localInput f = hoist (localInput f)
96−instance (Reflex t, Monad m) => HasInput t (Input t m) where
98− localInput f (Input m) = Input $ local f m
100−-- | A widget that can receive input events. See 'Graphics.Vty.Event'
101−newtype Input t m a = Input
102− { unInput :: ReaderT (Event t VtyEvent) m a
114−instance (Adjustable t m, MonadHold t m, Reflex t) => Adjustable t (Input t m) where
115− runWithReplace a0 a' = Input $ runWithReplace (unInput a0) $ fmap unInput a'
116− traverseIntMapWithKeyWithAdjust f dm0 dm' = Input $
117− traverseIntMapWithKeyWithAdjust (\k v -> unInput (f k v)) dm0 dm'
118− traverseDMapWithKeyWithAdjust f dm0 dm' = Input $ do
119− traverseDMapWithKeyWithAdjust (\k v -> unInput (f k v)) dm0 dm'
120− traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = Input $ do
121− traverseDMapWithKeyWithAdjustWithMove (\k v -> unInput (f k v)) dm0 dm'
123−deriving instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (Input t m)
124−deriving instance NotReady t m => NotReady t (Input t m)
125−deriving instance PerformEvent t m => PerformEvent t (Input t m)
126−deriving instance PostBuild t m => PostBuild t (Input t m)
127−deriving instance TriggerEvent t m => TriggerEvent t (Input t m)
128−instance HasImageWriter t m => HasImageWriter t (Input t m)
129−instance HasDisplayRegion t m => HasDisplayRegion t (Input t m)
130−instance HasFocusReader t m => HasFocusReader t (Input t m)
132−instance MonadTrans (Input t) where
133− lift f = Input $ lift f
135−instance MFunctor (Input t) where
136− hoist f = Input . hoist f . unInput
138−instance MonadNodeId m => MonadNodeId (Input t m)
140−-- | Runs an 'Input' with a given context
146−runInput e w = runReaderT (unInput w) e
148−-- ** Filtering input
150−-- | Type synonym for a key and modifier combination
223+instance (Reflex t, Monad m) => HasVtyInput t (VtyWidget t m) where
151−type KeyCombo = (V.Key, [V.Modifier])
224+ input = VtyWidget . lift $ asks _vtyWidgetCtx_input
153−-- | Emits an event that fires on a particular key press (without modifiers)
154−key :: (Monad m, Reflex t, HasInput t m) => V.Key -> m (Event t KeyCombo)
155−key = keyCombos . Set.singleton . (,[])
157−-- | Emits an event that fires on particular key presses (without modifiers)
226+-- | A class for things that can dynamically gain and lose focus
158−keys :: (Monad m, Reflex t, HasInput t m) => [V.Key] -> m (Event t KeyCombo)
227+class HasFocus t m | m -> t where
159−keys = keyCombos . Set.fromList . fmap (,[])
228+ focus :: m (Dynamic t Bool)
161−-- | Emit an event that fires whenever the provided key combination occurs
163− :: (Reflex t, Monad m, HasInput t m)
165− -> m (Event t KeyCombo)
166−keyCombo = keyCombos . Set.singleton
168−-- | Emit an event that fires whenever any of the provided key combinations occur
230+instance (Reflex t, Monad m) => HasFocus t (VtyWidget t m) where
169−keyCombos
231+ focus = VtyWidget . lift $ asks _vtyWidgetCtx_focus
170− :: (Reflex t, Monad m, HasInput t m)
172− -> m (Event t KeyCombo)
175− return $ fforMaybe i $ \case
176− V.EvKey k m -> if Set.member (k, m) ks
181−-- | Filter the keyboard input that a child widget may receive
233+-- | A class for widgets that can produce images to draw to the display
182−filterKeys :: (Reflex t, HasInput t m) => (KeyCombo -> Bool) -> m a -> m a
234+class (Reflex t, Monad m) => ImageWriter t m | m -> t where
183−filterKeys f x = localInput (ffilter (\case
235+ -- | Send images upstream for rendering
184− V.EvKey k mods -> f (k, mods)
236+ tellImages :: Behavior t [Image] -> m ()
187−-- | Filter mouse input events based on whether they target a particular region
188−-- and translate them to the internal coordinate system of that region.
190−-- NB: Non-mouse events are passed through unfiltered and unchanged
191−mouseInRegion :: Region -> VtyEvent -> Maybe VtyEvent
192−mouseInRegion (Region l t w h) e = case e of
193− V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
194− V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
201− , y >= t + h ] = Nothing
203− Just (con (x - l) (y - t))
205−-- | Filter mouse input outside the current display region and
206−-- all input if the region is not focused
208− :: (HasDisplayRegion t m, HasFocusReader t m, HasInput t m)
209− => m (Event t VtyEvent)
210−inputInFocusedRegion = do
212− reg <- current <$> askRegion
213− foc <- current <$> focus
214− pure $ fmapMaybe id $ attachWith filterInput ((,) <$> reg <*> foc) inp
216− filterInput (r, f) = \case
217− V.EvKey {} | not f -> Nothing
218− x -> mouseInRegion r x
220−-- * Getting and setting the display region
238+instance (Monad m, Reflex t) => ImageWriter t (BehaviorWriterT t [Image] m) where
239+ tellImages = tellBehavior
222-- | A chunk of the display area
241-- | A chunk of the display area
223data Region = Region
242data Region = Region
@@ -228,334 +247,521 @@ data Region = Region
229 deriving (Show, Read, Eq, Ord)
248 deriving (Show, Read, Eq, Ord)
231−-- | A region that occupies no space.
250+-- | A dynamic chunk of the display area
232−nilRegion :: Region
251+data DynRegion t = DynRegion
233−nilRegion = Region 0 0 0 0
252+ { _dynRegion_left :: Dynamic t Int
253+ , _dynRegion_top :: Dynamic t Int
254+ , _dynRegion_width :: Dynamic t Int
255+ , _dynRegion_height :: Dynamic t Int
235-- | The width and height of a 'Region'
258-- | The width and height of a 'Region'
236regionSize :: Region -> (Int, Int)
259regionSize :: Region -> (Int, Int)
237regionSize (Region _ _ w h) = (w, h)
260regionSize (Region _ _ w h) = (w, h)
239-- | Produces an 'Image' that fills a region with space characters
262-- | Produces an 'Image' that fills a region with space characters
240−regionBlankImage :: V.Attr -> Region -> Image
263+regionBlankImage :: Region -> Image
241−regionBlankImage attr r@(Region _ _ width height) =
264+regionBlankImage r@(Region _ _ width height) =
242− withinImage r $ V.charFill attr ' ' width height
265+ withinImage r $ V.charFill V.defAttr ' ' width height
244−-- | A class for things that know their own display size dimensions
267+-- | A behavior of the current display area represented by a 'DynRegion'
245−class (Reflex t, Monad m) => HasDisplayRegion t m | m -> t where
268+currentRegion :: Reflex t => DynRegion t -> Behavior t Region
246− -- | Retrieve the display region
269+currentRegion (DynRegion l t w h) = Region <$> current l <*> current t <*> current w <*> current h
247− askRegion :: m (Dynamic t Region)
270+
248− default askRegion :: (f m' ~ m, MonadTrans f, HasDisplayRegion t m') => m (Dynamic t Region)
271+joinDynRegion :: Reflex t => Dynamic t (DynRegion t) -> DynRegion t
249− askRegion = lift askRegion
272+joinDynRegion d = DynRegion
250− -- | Run an action in a local region, by applying a transformation to the region
273+ (_dynRegion_left =<< d)
251− localRegion :: (Dynamic t Region -> Dynamic t Region) -> m a -> m a
274+ (_dynRegion_top =<< d)
252− default localRegion :: (f m' ~ m, Monad m', MFunctor f, HasDisplayRegion t m') => (Dynamic t Region -> Dynamic t Region) -> m a -> m a
275+ (_dynRegion_width =<< d)
253− localRegion f = hoist (localRegion f)
276+ (_dynRegion_height =<< d)
255−-- | Retrieve the display width
278+dynRegion :: Reflex t => Dynamic t Region -> DynRegion t
256−displayWidth :: HasDisplayRegion t m => m (Dynamic t Int)
279+dynRegion r = DynRegion
257−displayWidth = fmap _region_width <$> askRegion
280+ { _dynRegion_left = _region_left <$> r
258−
281+ , _dynRegion_top = _region_top <$> r
259−-- | Retrieve the display height
282+ , _dynRegion_width = _region_width <$> r
260−displayHeight :: HasDisplayRegion t m => m (Dynamic t Int)
283+ , _dynRegion_height = _region_height <$> r
261−displayHeight = fmap _region_height <$> askRegion
284+ }
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
286+dynamicRegion :: Reflex t => DynRegion t -> Dynamic t Region
305− hoist f = DisplayRegion . hoist f . unDisplayRegion
287+dynamicRegion d = Region
288+ <$> _dynRegion_left d
289+ <*> _dynRegion_top d
290+ <*> _dynRegion_width d
291+ <*> _dynRegion_height d
307−instance MonadNodeId m => MonadNodeId (DisplayRegion t m)
293+-- | Translates and crops an 'Image' so that it is contained by
294+-- the given 'Region'.
299+withinImage (Region left top width height)
300+ | width < 0 || height < 0 = withinImage (Region left top 0 0)
301+ | otherwise = V.translate left top . V.crop width height
309−-- | Run a 'DisplayRegion' action with a given 'Region'
303+-- | Low-level widget combinator that runs a child 'VtyWidget' within
310−runDisplayRegion
304+-- a given region and context. This widget filters and modifies the input
305+-- that the child widget receives such that:
306+-- * unfocused widgets receive no key events
307+-- * mouse inputs outside the region are ignored
308+-- * mouse inputs inside the region have their coordinates translated such
309+-- that (0,0) is the top-left corner of the region
311+ :: (Reflex t, Monad m, MonadNodeId m)
313+ -> Dynamic t Bool -- ^ Whether the widget should be focused when the parent is.
316+pane dr foc child = VtyWidget $ do
318+ let reg = currentRegion dr
319+ let ctx' = VtyWidgetCtx
320+ { _vtyWidgetCtx_input = leftmost -- TODO: think about this leftmost more.
322+ attachWith (\(r,f) e -> filterInput r f e)
323+ (liftA2 (,) reg (current foc))
324+ (_vtyWidgetCtx_input ctx)
326+ , _vtyWidgetCtx_focus = liftA2 (&&) (_vtyWidgetCtx_focus ctx) foc
327+ , _vtyWidgetCtx_width = _dynRegion_width dr
328+ , _vtyWidgetCtx_height = _dynRegion_height dr
330+ (result, images) <- lift . lift $ runVtyWidget ctx' child
331+ let images' = liftA2 (\r is -> map (withinImage r) is) reg images
335+ filterInput :: Region -> Bool -> VtyEvent -> Maybe VtyEvent
336+ filterInput (Region l t w h) focused e = case e of
337+ V.EvKey _ _ | not focused -> Nothing
338+ V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
339+ V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
346+ , y >= t + h ] = Nothing
348+ Just (con (x - l) (y - t))
350+-- | Information about a drag operation
352+ { _drag_from :: (Int, Int) -- ^ Where the drag began
353+ , _drag_to :: (Int, Int) -- ^ Where the mouse currently is
354+ , _drag_button :: V.Button -- ^ Which mouse button is dragging
355+ , _drag_modifiers :: [V.Modifier] -- ^ What modifiers are held
356+ , _drag_end :: Bool -- ^ Whether the drag ended (the mouse button was released)
358+ deriving (Eq, Ord, Show)
360+-- | Converts raw vty mouse drag events into an event stream of 'Drag's
362+ :: (Reflex t, MonadFix m, MonadHold t m)
364+ -> VtyWidget t m (Event t Drag)
367+ let f :: Maybe Drag -> V.Event -> Maybe Drag
369+ V.EvMouseDown x y btn' mods
370+ | btn == btn' -> Just $ Drag (x,y) (x,y) btn' mods False
371+ | otherwise -> Nothing
373+ f (Just (Drag from _ _ mods end)) = \case
374+ V.EvMouseDown x y btn' mods'
375+ | end && btn == btn' -> Just $ Drag (x,y) (x,y) btn' mods' False
376+ | btn == btn' -> Just $ Drag from (x,y) btn mods' False
377+ | otherwise -> Nothing -- Ignore other buttons.
378+ V.EvMouseUp x y (Just btn')
380+ | btn == btn' -> Just $ Drag from (x,y) btn mods True
381+ | otherwise -> Nothing
382+ V.EvMouseUp x y Nothing -- Terminal doesn't specify mouse up button,
383+ -- assume it's the right one.
385+ | otherwise -> Just $ Drag from (x,y) btn mods True
387+ rec let newDrag = attachWithMaybe f (current dragD) inp
388+ dragD <- holdDyn Nothing $ Just <$> newDrag
389+ return (fmapMaybe id $ updated dragD)
391+-- | Mouse down events for a particular mouse button
311 :: (Reflex t, Monad m)
393 :: (Reflex t, Monad m)
312− => Dynamic t Region
394+ => V.Button
313− -> DisplayRegion t m a
395+ -> VtyWidget t m (Event t MouseDown)
314− -> m a
396+mouseDown btn = do
315−runDisplayRegion r = flip runReaderT r . unDisplayRegion
397+ i <- input
316−
398+ return $ fforMaybe i $ \case
317−-- * Getting focus state
399+ V.EvMouseDown x y btn' mods -> if btn == btn'
318−
400+ then Just $ MouseDown btn' (x, y) mods
319−-- | A class for things that can dynamically gain and lose focus
401+ else Nothing
320−class (Reflex t, Monad m) => HasFocusReader t m | m -> t where
402+ _ -> Nothing
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
404+-- | Mouse up events for a particular mouse button
374−runFocusReader
405+mouseUp
375 :: (Reflex t, Monad m)
406 :: (Reflex t, Monad m)
376− => Dynamic t Bool
407+ => VtyWidget t m (Event t MouseUp)
377− -> FocusReader t m a
408+mouseUp = do
378− -> m a
409+ i <- input
379−runFocusReader b = flip runReaderT b . unFocusReader
410+ return $ fforMaybe i $ \case
380−
411+ V.EvMouseUp x y btn' -> Just $ MouseUp btn' (x, y)
381−-- * "Image" output
412+ _ -> Nothing
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)
414+-- | Information about a mouse down event
426−instance HasImageWriter t m => HasImageWriter t (BehaviorWriterT t x m)
415+data MouseDown = MouseDown
427−instance HasImageWriter t m => HasImageWriter t (DynamicWriterT t x m)
416+ { _mouseDown_button :: V.Button
428−instance HasImageWriter t m => HasImageWriter t (EventWriterT t x m)
417+ , _mouseDown_coordinates :: (Int, Int)
429−instance HasImageWriter t m => HasImageWriter t (NodeIdT m)
418+ , _mouseDown_modifiers :: [V.Modifier]
420+ deriving (Eq, Ord, Show)
431−instance (Monad m, Reflex t) => HasImageWriter t (ImageWriter t m) where
422+-- | Information about a mouse up event
432− tellImages = ImageWriter . tellBehavior
423+data MouseUp = MouseUp
433− mapImages f (ImageWriter x) = ImageWriter $ do
424+ { _mouseUp_button :: Maybe V.Button
434− (a, images) <- lift $ runBehaviorWriterT x
425+ , _mouseUp_coordinates :: (Int, Int)
435− tellBehavior $ f images
426+ }
436− pure a
427+ deriving (Eq, Ord, Show)
438−instance HasDisplayRegion t m => HasDisplayRegion t (ImageWriter t m)
429+-- | Mouse scroll direction
439−instance HasFocusReader t m => HasFocusReader t (ImageWriter t m)
430+data ScrollDirection = ScrollDirection_Up | ScrollDirection_Down
431+ deriving (Eq, Ord, Show)
441−-- | Run a widget that can produce images
433+-- | Produce an event that fires when the mouse wheel is scrolled
442−runImageWriter
434+mouseScroll
443 :: (Reflex t, Monad m)
435 :: (Reflex t, Monad m)
444− => ImageWriter t m a
436+ => VtyWidget t m (Event t ScrollDirection)
445− -> m (a, Behavior t [Image])
437+mouseScroll = do
446−runImageWriter = runBehaviorWriterT . unImageWriter
438+ up <- mouseDown V.BScrollUp
447−
439+ down <- mouseDown V.BScrollDown
448−-- * Theming
440+ return $ leftmost
449−
441+ [ ScrollDirection_Up <$ up
450−-- | A class for things that can be visually styled
442+ , ScrollDirection_Down <$ down
451−class (Reflex t, Monad m) => HasTheme t m | m -> t where
443+ ]
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
445+-- | Type synonym for a key and modifier combination
501− lift = ThemeReader . lift
446+type KeyCombo = (V.Key, [V.Modifier])
503−instance MFunctor (ThemeReader t) where
448+-- | Emits an event that fires on a particular key press (without modifiers)
504− hoist f = ThemeReader . hoist f . unThemeReader
449+key :: (Monad m, Reflex t) => V.Key -> VtyWidget t m (Event t KeyCombo)
450+key = keyCombos . Set.singleton . (,[])
506−instance MonadNodeId m => MonadNodeId (ThemeReader t m)
452+-- | Emits an event that fires on particular key presses (without modifiers)
453+keys :: (Monad m, Reflex t) => [V.Key] -> VtyWidget t m (Event t KeyCombo)
454+keys = keyCombos . Set.fromList . fmap (,[])
508−-- | Run a 'ThemeReader' action with the given focus value
456+-- | Emit an event that fires whenever the provided key combination occurs
509−runThemeReader
457+keyCombo
510 :: (Reflex t, Monad m)
458 :: (Reflex t, Monad m)
511− => Behavior t V.Attr
459+ => KeyCombo
512− -> ThemeReader t m a
460+ -> VtyWidget t m (Event t KeyCombo)
513− -> m a
461+keyCombo = keyCombos . Set.singleton
514−runThemeReader b = flip runReaderT b . unThemeReader
463+-- | Emit an event that fires whenever any of the provided key combinations occur
465+ :: (Reflex t, Monad m)
467+ -> VtyWidget t m (Event t KeyCombo)
470+ return $ fforMaybe i $ \case
471+ V.EvKey k m -> if Set.member (k, m) ks
517−-- ** Manipulating images
476+-- | A plain split of the available space into vertically stacked panes.
477+-- No visual separator is built in here.
478+splitV :: (Reflex t, Monad m, MonadNodeId m)
479+ => Dynamic t (Int -> Int)
480+ -- ^ Function used to determine size of first pane based on available size
481+ -> Dynamic t (Bool, Bool)
482+ -- ^ How to focus the two sub-panes, given that we are focused.
484+ -- ^ Widget for first pane
486+ -- ^ Widget for second pane
487+ -> VtyWidget t m (a,b)
488+splitV sizeFunD focD wA wB = do
491+ let regA = DynRegion
492+ { _dynRegion_left = pure 0
493+ , _dynRegion_top = pure 0
494+ , _dynRegion_width = dw
495+ , _dynRegion_height = sizeFunD <*> dh
498+ { _dynRegion_left = pure 0
499+ , _dynRegion_top = _dynRegion_height regA
500+ , _dynRegion_width = dw
501+ , _dynRegion_height = liftA2 (-) dh (_dynRegion_height regA)
503+ ra <- pane regA (fst <$> focD) wA
504+ rb <- pane regB (snd <$> focD) wB
507+-- | A plain split of the available space into horizontally stacked panes.
508+-- No visual separator is built in here.
509+splitH :: (Reflex t, Monad m, MonadNodeId m)
510+ => Dynamic t (Int -> Int)
511+ -- ^ Function used to determine size of first pane based on available size
512+ -> Dynamic t (Bool, Bool)
513+ -- ^ How to focus the two sub-panes, given that we are focused.
515+ -- ^ Widget for first pane
517+ -- ^ Widget for second pane
518+ -> VtyWidget t m (a,b)
519+splitH sizeFunD focD wA wB = do
522+ let regA = DynRegion
523+ { _dynRegion_left = pure 0
524+ , _dynRegion_top = pure 0
525+ , _dynRegion_width = sizeFunD <*> dw
526+ , _dynRegion_height = dh
529+ { _dynRegion_left = _dynRegion_width regA
530+ , _dynRegion_top = pure 0
531+ , _dynRegion_width = liftA2 (-) dw (_dynRegion_width regA)
532+ , _dynRegion_height = dh
534+ liftA2 (,) (pane regA (fmap fst focD) wA) (pane regB (fmap snd focD) wB)
536+-- | A split of the available space into two parts with a draggable separator.
537+-- Starts with half the space allocated to each, and the first pane has focus.
538+-- Clicking in a pane switches focus.
539+splitVDrag :: (Reflex t, MonadFix m, MonadHold t m, MonadNodeId m)
543+ -> VtyWidget t m (a,b)
544+splitVDrag wS wA wB = do
547+ h0 <- sample $ current dh -- TODO
548+ dragE <- drag V.BLeft
549+ let splitter0 = h0 `div` 2
550+ rec splitterCheckpoint <- holdDyn splitter0 $ leftmost [fst <$> ffilter snd dragSplitter, resizeSplitter]
551+ splitterPos <- holdDyn splitter0 $ leftmost [fst <$> dragSplitter, resizeSplitter]
552+ splitterFrac <- holdDyn ((1::Double) / 2) $ ffor (attach (current dh) (fst <$> dragSplitter)) $ \(h, x) ->
553+ fromIntegral x / max 1 (fromIntegral h)
554+ let dragSplitter = fforMaybe (attach (current splitterCheckpoint) dragE) $
555+ \(splitterY, Drag (_, fromY) (_, toY) _ _ end) ->
556+ if splitterY == fromY then Just (toY, end) else Nothing
557+ regA = DynRegion 0 0 dw splitterPos
558+ regS = DynRegion 0 splitterPos dw 1
559+ regB = DynRegion 0 (splitterPos + 1) dw (dh - splitterPos - 1)
560+ resizeSplitter = ffor (attach (current splitterFrac) (updated dh)) $
561+ \(frac, h) -> round (frac * fromIntegral h)
562+ focA <- holdDyn True $ leftmost
566+ (mA, rA) <- pane regA focA $ withMouseDown wA
567+ pane regS (pure False) wS
568+ (mB, rB) <- pane regB (not <$> focA) $ withMouseDown wB
571+ withMouseDown x = do
572+ m <- mouseDown V.BLeft
576+-- | Fill the background with a particular character.
577+fill :: (Reflex t, Monad m) => Char -> VtyWidget t m ()
581+ let fillImg = current $ liftA2 (\w h -> [V.charFill V.defAttr c w h]) dw dh
584+-- | Fill the background with the bottom
585+hRule :: (Reflex t, Monad m) => BoxStyle -> VtyWidget t m ()
586+hRule boxStyle = fill (_boxStyle_s boxStyle)
588+-- | Defines a set of symbols to use to draw the outlines of boxes
589+-- C.f. https://en.wikipedia.org/wiki/Box-drawing_character
590+data BoxStyle = BoxStyle
591+ { _boxStyle_nw :: Char
592+ , _boxStyle_n :: Char
593+ , _boxStyle_ne :: Char
594+ , _boxStyle_e :: Char
595+ , _boxStyle_se :: Char
596+ , _boxStyle_s :: Char
597+ , _boxStyle_sw :: Char
598+ , _boxStyle_w :: Char
519−-- | Translates and crops an 'Image' so that it is contained by
601+instance Default BoxStyle where
520−-- the given 'Region'.
602+ def = singleBoxStyle
522− :: Region
604+-- | A box style that uses hyphens and pipe characters. Doesn't handle
523− -> Image
605+-- corners very well.
524− -> Image
606+hyphenBoxStyle :: BoxStyle
525−withinImage (Region left top width height)
607+hyphenBoxStyle = BoxStyle '-' '-' '-' '|' '-' '-' '-' '|'
526− | width < 0 || height < 0 = withinImage (Region left top 0 0)
608+
527− | otherwise = V.translate left top . V.crop width height
609+-- | A single line box style
610+singleBoxStyle :: BoxStyle
611+singleBoxStyle = BoxStyle '┌' '─' '┐' '│' '┘' '─' '└' '│'
613+-- | A thick single line box style
614+thickBoxStyle :: BoxStyle
615+thickBoxStyle = BoxStyle '┏' '━' '┓' '┃' '┛' '━' '┗' '┃'
617+-- | A double line box style
618+doubleBoxStyle :: BoxStyle
619+doubleBoxStyle = BoxStyle '╔' '═' '╗' '║' '╝' '═' '╚' '║'
621+-- | A single line box style with rounded corners
622+roundedBoxStyle :: BoxStyle
623+roundedBoxStyle = BoxStyle '╭' '─' '╮' '│' '╯' '─' '╰' '│'
625+-- | Draws a titled box in the provided style and a child widget inside of that box
626+boxTitle :: (Monad m, Reflex t, MonadNodeId m)
627+ => Behavior t BoxStyle
631+boxTitle boxStyle title child = do
634+ let boxReg = DynRegion (pure 0) (pure 0) dw dh
635+ innerReg = DynRegion (pure 1) (pure 1) (subtract 2 <$> dw) (subtract 2 <$> dh)
636+ tellImages (boxImages <$> boxStyle <*> currentRegion boxReg)
637+ tellImages (fmap (\r -> [regionBlankImage r]) (currentRegion innerReg))
638+ pane innerReg (pure True) child
640+ boxImages :: BoxStyle -> Region -> [Image]
641+ boxImages style (Region left top width height) =
642+ let right = left + width - 1
643+ bottom = top + height - 1
645+ [ withinImage (Region (left + 1) top (width - 2) 1) $
647+ hPadText title (_boxStyle_n style) (width - 2)
648+ , withinImage (Region right (top + 1) 1 (height - 2)) $
649+ V.charFill V.defAttr (_boxStyle_e style) 1 (height - 2)
650+ , withinImage (Region (left + 1) bottom (width - 2) 1) $
651+ V.charFill V.defAttr (_boxStyle_s style) (width - 2) 1
652+ , withinImage (Region left (top + 1) 1 (height - 2)) $
653+ V.charFill V.defAttr (_boxStyle_w style) 1 (height - 2)
656+ [ withinImage (Region left top 1 1) $
657+ V.char V.defAttr (_boxStyle_nw style)
658+ , withinImage (Region right top 1 1) $
659+ V.char V.defAttr (_boxStyle_ne style)
660+ , withinImage (Region right bottom 1 1) $
661+ V.char V.defAttr (_boxStyle_se style)
662+ , withinImage (Region left bottom 1 1) $
663+ V.char V.defAttr (_boxStyle_sw style)
665+ in sides ++ if width > 1 && height > 1 then corners else []
666+ hPadText :: T.Text -> Char -> Int -> T.Text
667+ hPadText t c l = if lt >= l
669+ else left <> t <> right
673+ mkHalf n = T.replicate (n `div` 2) (T.singleton c)
674+ left = mkHalf $ delta + 1
675+ right = mkHalf delta
677+-- | A box without a title
678+box :: (Monad m, Reflex t, MonadNodeId m)
679+ => Behavior t BoxStyle
682+box boxStyle = boxTitle boxStyle mempty
684+-- | A box whose style is static
686+ :: (Reflex t, Monad m, MonadNodeId m)
690+boxStatic = box . pure
692+-- | Configuration options for displaying "rich" text
693+data RichTextConfig t = RichTextConfig
694+ { _richTextConfig_attributes :: Behavior t V.Attr
529−-- | Crop a behavior of images to a behavior of regions. See 'withinImage'.
697+instance Reflex t => Default (RichTextConfig t) where
530−imagesInRegion
698+ def = RichTextConfig $ pure V.defAttr
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
700+-- | A widget that displays text with custom time-varying attributes
702+ :: (Reflex t, Monad m)
708+ let img = (\w a s -> [wrapText w a s])
710+ <*> _richTextConfig_attributes cfg
714+ wrapText maxWidth attrs = V.vertCat
715+ . concatMap (fmap (V.string attrs . T.unpack) . TZ.wrapWithOffset maxWidth 0)
539−-- | Low-level widget combinator that runs a child widget within
718+-- | Renders text, wrapped to the container width
540−-- a given region and context. This widget filters and modifies the input
719+text
541−-- that the child widget receives such that:
720+ :: (Reflex t, Monad m)
542−-- * unfocused widgets receive no key events
721+ => Behavior t Text
543−-- * mouse inputs outside the region are ignored
722+ -> VtyWidget t m ()
544−-- * mouse inputs inside the region have their coordinates translated such
723+text = richText def
545−-- that (0,0) is the top-left corner of the region
724+
546−pane
725+-- | Scrollable text widget. The output pair exposes the current scroll position and total number of lines (including those
547− :: (Reflex t, Monad m, HasInput t m, HasImageWriter t m, HasDisplayRegion t m, HasFocusReader t m)
726+-- that are hidden)
548− => Dynamic t Region
727+scrollableText
549− -> Dynamic t Bool -- ^ Whether the widget should be focused when the parent is.
728+ :: forall t m. (Reflex t, MonadHold t m, MonadFix m)
550− -> m a
729+ => Event t Int
551− -> m a
730+ -- ^ Number of lines to scroll by
552−pane dr foc child = localRegion (const dr) $
731+ -> Behavior t Text
553− mapImages (imagesInRegion $ current dr) $
732+ -> VtyWidget t m (Behavior t (Int, Int))
554− localFocus (const foc) $
733+ -- ^ (Current scroll position, total number of lines)
555− inputInFocusedRegion >>= \e -> localInput (const e) child
734+scrollableText scrollBy t = do
736+ let imgs = wrap <$> current dw <*> t
738+ kdown <- key V.KDown
740+ let requestedScroll :: Event t Int
741+ requestedScroll = leftmost
745+ ScrollDirection_Up -> (-1)
746+ ScrollDirection_Down -> 1
749+ updateLine maxN delta ix = min (max 0 (ix + delta)) maxN
750+ lineIndex :: Dynamic t Int <- foldDyn (\(maxN, delta) ix -> updateLine (maxN - 1) delta ix) 0 $
751+ attach (length <$> imgs) requestedScroll
752+ tellImages $ fmap ((:[]) . V.vertCat) $ drop <$> current lineIndex <*> imgs
753+ return $ (,) <$> ((+) <$> current lineIndex <*> pure 1) <*> (length <$> imgs)
755+ wrap maxWidth = concatMap (fmap (V.string V.defAttr . T.unpack) . TZ.wrapWithOffset maxWidth 0) . T.split (=='\n')
557−-- * Misc
757+-- | Renders any behavior whose value can be converted to
760+ :: (Reflex t, Monad m, Show a)
763+display a = text $ T.pack . show <$> a
559-- | A widget that draws nothing
765-- | A widget that draws nothing
560−blank :: Monad m => m ()
766+blank :: Monad m => VtyWidget t m ()
561blank = return ()
767blank = return ()