@@ -4,147 +4,39 @@ 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− , DynRegion(..)
19− , currentRegion
20− , Region(..)
21− , regionSize
22− , regionBlankImage
23− , Drag(..)
24− , drag
25− , MouseDown(..)
26− , MouseUp(..)
27− , mouseDown
28− , mouseUp
29− , ScrollDirection(..)
30− , mouseScroll
31− , pane
32− , splitV
33− , splitH
34− , splitVDrag
35− , boxTitle
36− , box
37− , boxStatic
38− , RichTextConfig(..)
39− , richText
40− , text
41− , scrollableText
42− , display
43− , BoxStyle(..)
44− , hyphenBoxStyle
45− , singleBoxStyle
46− , roundedBoxStyle
47− , thickBoxStyle
48− , doubleBoxStyle
49− , fill
50− , hRule
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)
62−import Control.Monad.Reader (ReaderT, ask, asks, runReaderT)
12+import Control.Monad.Morph
13+import Control.Monad.NodeId
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
7322import Reflex.Class ()
7423import Reflex.Host.Class (MonadReflexCreateTrigger)
75−
7624import Reflex.Vty.Host
7725
78−import Control.Monad.NodeId
79−
80−-- | The context within which a 'VtyWidget' runs
81−data VtyWidgetCtx t = VtyWidgetCtx
82− { _vtyWidgetCtx_width :: Dynamic t Int
83− -- ^ The width of the region allocated to the widget.
84− , _vtyWidgetCtx_height :: Dynamic t Int
85− -- ^ The height of the region allocated to the widget.
86− , _vtyWidgetCtx_focus :: Dynamic t Bool
87− -- ^ Whether the widget should behave as if it has focus for keyboard input.
88− , _vtyWidgetCtx_input :: Event t VtyEvent
89− -- ^ User input events that the widget's parent chooses to share. These will generally
90− -- be filtered for relevance:
91− -- * Keyboard inputs are restricted to focused widgets
92− -- * Mouse inputs are restricted to the region in which the widget resides and are
93− -- translated into its internal coordinates.
94− }
95−
96−-- | The output of a 'VtyWidget'
97−data VtyWidgetOut t = VtyWidgetOut
98− { _vtyWidgetOut_shutdown :: Event t ()
99− }
100−
101−instance (Adjustable t m, MonadHold t m, Reflex t) => Adjustable t (VtyWidget t m) where
102− runWithReplace a0 a' = VtyWidget $ runWithReplace (unVtyWidget a0) $ fmap unVtyWidget a'
103− traverseIntMapWithKeyWithAdjust f dm0 dm' = VtyWidget $
104− traverseIntMapWithKeyWithAdjust (\k v -> unVtyWidget (f k v)) dm0 dm'
105− traverseDMapWithKeyWithAdjust f dm0 dm' = VtyWidget $ do
106− traverseDMapWithKeyWithAdjust (\k v -> unVtyWidget (f k v)) dm0 dm'
107− traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = VtyWidget $ do
108− traverseDMapWithKeyWithAdjustWithMove (\k v -> unVtyWidget (f k v)) dm0 dm'
109−
110−-- | A widget that can read its context and produce image output
111−newtype VtyWidget t m a = VtyWidget
112− { unVtyWidget :: BehaviorWriterT t [Image] (ReaderT (VtyWidgetCtx t) m) a
113− } deriving
114− ( Functor
115− , Applicative
116− , Monad
117− , MonadSample t
118− , MonadHold t
119− , MonadFix
120− , NotReady t
121− , ImageWriter t
122− , PostBuild t
123− , TriggerEvent t
124− , MonadReflexCreateTrigger t
125− , MonadIO
126− )
127−
128−deriving instance PerformEvent t m => PerformEvent t (VtyWidget t m)
129−instance MonadTrans (VtyWidget t) where
130− lift f = VtyWidget $ lift $ lift f
131−
132−instance MonadNodeId m => MonadNodeId (VtyWidget t m) where
133− getNextNodeId = VtyWidget $ do
134− lift $ lift getNextNodeId
135−
136−-- | Runs a 'VtyWidget' with a given context
137−runVtyWidget
138− :: (Reflex t, MonadNodeId m)
139− => VtyWidgetCtx t
140− -> VtyWidget t m a
141− -> m (a, Behavior t [Image])
142−runVtyWidget ctx w = runReaderT (runBehaviorWriterT (unVtyWidget w)) ctx
26+-- * Running a vty application
14327
144−-- | 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
14529mainWidgetWithHandle
14630 :: V.Vty
147− -> (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 ()))
14840 -> IO ()
14941mainWidgetWithHandle vty child =
15042 runVtyAppWithHandle vty $ \dr0 inp -> do
@@ -154,71 +46,178 @@ mainWidgetWithHandle vty child =
15446 let inp' = fforMaybe inp $ \case
15547 V.EvResize {} -> Nothing
15648 x -> Just x
157− let ctx = VtyWidgetCtx
158− { _vtyWidgetCtx_width = fmap fst size
159− , _vtyWidgetCtx_height = fmap snd size
160− , _vtyWidgetCtx_input = inp'
161− , _vtyWidgetCtx_focus = constDyn True
162− }
163− (shutdown, images) <- runNodeIdT $ runVtyWidget ctx $ do
164− tellImages . ffor (current size) $ \(w, h) -> [V.charFill V.defAttr ' ' w h]
165− 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
16657 return $ VtyResult
16758 { _vtyResult_picture = fmap (V.picForLayers . reverse) images
16859 , _vtyResult_shutdown = shutdown
16960 }
17061
62+-- | The output of a vty widget
63+data VtyWidgetOut t = VtyWidgetOut
64+ { _vtyWidgetOut_shutdown :: Event t ()
65+ }
66+
17167-- | Like 'mainWidgetWithHandle', but uses a default vty configuration
17268mainWidget
173− :: (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 ()))
17478 -> IO ()
17579mainWidget child = do
17680 vty <- getDefaultVty
17781 mainWidgetWithHandle vty child
17882
179−-- | A class for things that know their own display size dimensions
180−class (Reflex t, Monad m) => HasDisplaySize t m | m -> t where
181− -- | Retrieve the display width (columns)
182− displayWidth :: m (Dynamic t Int)
183− default displayWidth :: (f m' ~ m, MonadTrans f, HasDisplaySize t m') => m (Dynamic t Int)
184− displayWidth = lift displayWidth
185− -- | Retrieve the display height (rows)
186− displayHeight :: m (Dynamic t Int)
187− default displayHeight :: (f m' ~ m, MonadTrans f, HasDisplaySize t m') => m (Dynamic t Int)
188− displayHeight = lift displayHeight
189−
190−instance (Reflex t, Monad m) => HasDisplaySize t (VtyWidget t m) where
191− displayWidth = VtyWidget . lift $ asks _vtyWidgetCtx_width
192− displayHeight = VtyWidget . lift $ asks _vtyWidgetCtx_height
193−
194−instance HasDisplaySize t m => HasDisplaySize t (ReaderT x m)
195−instance HasDisplaySize t m => HasDisplaySize t (BehaviorWriterT t x m)
196−instance HasDisplaySize t m => HasDisplaySize t (DynamicWriterT t x m)
197−instance HasDisplaySize t m => HasDisplaySize t (EventWriterT t x m)
198−
199−instance HasDisplaySize t m => HasDisplaySize t (NodeIdT m)
83+-- * Input Events
20084
20185-- | A class for things that can receive vty events as input
202−class HasVtyInput t m | m -> t where
86+class HasInput t m | m -> t where
20387 input :: m (Event t VtyEvent)
88+ default input :: (f m' ~ m, Monad m', MonadTrans f, HasInput t m') => m (Event t VtyEvent)
89+ input = lift input
90+ -- | User input events that the widget's parent chooses to share. These will generally
91+ -- be filtered for relevance.
92+ localInput :: (Event t VtyEvent -> Event t VtyEvent) -> m a -> m a
93+ default localInput :: (f m' ~ m, Monad m', MFunctor f, HasInput t m') => (Event t VtyEvent -> Event t VtyEvent) -> m a -> m a
94+ localInput f = hoist (localInput f)
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+ )
204113
205−instance (Reflex t, Monad m) => HasVtyInput t (VtyWidget t m) where
206− 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
147+
148+-- ** Filtering input
207149
208−-- | A class for things that can dynamically gain and lose focus
209−class HasFocus t m | m -> t where
210− focus :: m (Dynamic t Bool)
150+-- | Type synonym for a key and modifier combination
151+type KeyCombo = (V.Key, [V.Modifier])
211152
212−instance (Reflex t, Monad m) => HasFocus t (VtyWidget t m) where
213− focus = VtyWidget . lift $ asks _vtyWidgetCtx_focus
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 . (,[])
214156
215−-- | A class for widgets that can produce images to draw to the display
216−class (Reflex t, Monad m) => ImageWriter t m | m -> t where
217− -- | Send images upstream for rendering
218− tellImages :: Behavior t [Image] -> m ()
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
219167
220−instance (Monad m, Reflex t) => ImageWriter t (BehaviorWriterT t [Image] m) where
221− 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
222221
223222-- | A chunk of the display area
224223data Region = Region
@@ -229,499 +228,334 @@ data Region = Region
229228 }
230229 deriving (Show, Read, Eq, Ord)
231230
232−-- | A dynamic chunk of the display area
233−data DynRegion t = DynRegion
234− { _dynRegion_left :: Dynamic t Int
235− , _dynRegion_top :: Dynamic t Int
236− , _dynRegion_width :: Dynamic t Int
237− , _dynRegion_height :: Dynamic t Int
238− }
231+-- | A region that occupies no space.
232+nilRegion :: Region
233+nilRegion = Region 0 0 0 0
239234
240235-- | The width and height of a 'Region'
241236regionSize :: Region -> (Int, Int)
242237regionSize (Region _ _ w h) = (w, h)
243238
244239-- | Produces an 'Image' that fills a region with space characters
245−regionBlankImage :: Region -> Image
246−regionBlankImage r@(Region _ _ width height) =
247− 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
248243
249−-- | A behavior of the current display area represented by a 'DynRegion'
250−currentRegion :: Reflex t => DynRegion t -> Behavior t Region
251−currentRegion (DynRegion l t w h) = Region <$> current l <*> current t <*> current w <*> current h
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+ )
252282
253−-- | Translates and crops an 'Image' so that it is contained by
254−-- the given 'Region'.
255−withinImage
256− :: Region
257− -> Image
258− -> Image
259−withinImage (Region left top width height)
260− | width < 0 || height < 0 = withinImage (Region left top 0 0)
261− | otherwise = V.translate left top . V.crop width height
283+instance (Monad m, Reflex t) => HasDisplayRegion t (DisplayRegion t m) where
284+ askRegion = DisplayRegion ask
285+ localRegion f = DisplayRegion . local f . unDisplayRegion
262286
263−-- | Low-level widget combinator that runs a child 'VtyWidget' within
264−-- a given region and context. This widget filters and modifies the input
265−-- that the child widget receives such that:
266−-- * unfocused widgets receive no key events
267−-- * mouse inputs outside the region are ignored
268−-- * mouse inputs inside the region have their coordinates translated such
269−-- that (0,0) is the top-left corner of the region
270−pane
271− :: (Reflex t, Monad m, MonadNodeId m)
272− => DynRegion t
273− -> Dynamic t Bool -- ^ Whether the widget should be focused when the parent is.
274− -> VtyWidget t m a
275− -> VtyWidget t m a
276−pane dr foc child = VtyWidget $ do
277− ctx <- lift ask
278− let reg = currentRegion dr
279− let ctx' = VtyWidgetCtx
280− { _vtyWidgetCtx_input = leftmost -- TODO: think about this leftmost more.
281− [ fmapMaybe id $
282− attachWith (\(r,f) e -> filterInput r f e)
283− (liftA2 (,) reg (current foc))
284− (_vtyWidgetCtx_input ctx)
285− ]
286− , _vtyWidgetCtx_focus = liftA2 (&&) (_vtyWidgetCtx_focus ctx) foc
287− , _vtyWidgetCtx_width = _dynRegion_width dr
288− , _vtyWidgetCtx_height = _dynRegion_height dr
289− }
290− (result, images) <- lift . lift $ runVtyWidget ctx' child
291− let images' = liftA2 (\r is -> map (withinImage r) is) reg images
292− tellImages images'
293− return result
294− where
295− filterInput :: Region -> Bool -> VtyEvent -> Maybe VtyEvent
296− filterInput (Region l t w h) focused e = case e of
297− V.EvKey _ _ | not focused -> Nothing
298− V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
299− V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
300− _ -> Just e
301− where
302− mouse con x y
303− | or [ x < l
304− , y < t
305− , x >= l + w
306− , y >= t + h ] = Nothing
307− | otherwise =
308− Just (con (x - l) (y - t))
309−
310−-- | Information about a drag operation
311−data Drag = Drag
312− { _drag_from :: (Int, Int) -- ^ Where the drag began
313− , _drag_to :: (Int, Int) -- ^ Where the mouse currently is
314− , _drag_button :: V.Button -- ^ Which mouse button is dragging
315− , _drag_modifiers :: [V.Modifier] -- ^ What modifiers are held
316− , _drag_end :: Bool -- ^ Whether the drag ended (the mouse button was released)
317− }
318− deriving (Eq, Ord, Show)
319−
320−-- | Converts raw vty mouse drag events into an event stream of 'Drag's
321−drag
322− :: (Reflex t, MonadFix m, MonadHold t m)
323− => V.Button
324− -> VtyWidget t m (Event t Drag)
325−drag btn = do
326− inp <- input
327− let f :: Maybe Drag -> V.Event -> Maybe Drag
328− f Nothing = \case
329− V.EvMouseDown x y btn' mods
330− | btn == btn' -> Just $ Drag (x,y) (x,y) btn' mods False
331− | otherwise -> Nothing
332− _ -> Nothing
333− f (Just (Drag from _ _ mods end)) = \case
334− V.EvMouseDown x y btn' mods'
335− | end && btn == btn' -> Just $ Drag (x,y) (x,y) btn' mods' False
336− | btn == btn' -> Just $ Drag from (x,y) btn mods' False
337− | otherwise -> Nothing -- Ignore other buttons.
338− V.EvMouseUp x y (Just btn')
339− | end -> Nothing
340− | btn == btn' -> Just $ Drag from (x,y) btn mods True
341− | otherwise -> Nothing
342− V.EvMouseUp x y Nothing -- Terminal doesn't specify mouse up button,
343− -- assume it's the right one.
344− | end -> Nothing
345− | otherwise -> Just $ Drag from (x,y) btn mods True
346− _ -> Nothing
347− rec let newDrag = attachWithMaybe f (current dragD) inp
348− dragD <- holdDyn Nothing $ Just <$> newDrag
349− return (fmapMaybe id $ updated dragD)
350−
351−-- | Mouse down events for a particular mouse button
352−mouseDown
353− :: (Reflex t, Monad m)
354− => V.Button
355− -> VtyWidget t m (Event t MouseDown)
356−mouseDown btn = do
357− i <- input
358− return $ fforMaybe i $ \case
359− V.EvMouseDown x y btn' mods -> if btn == btn'
360− then Just $ MouseDown btn' (x, y) mods
361− else Nothing
362− _ -> Nothing
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)
363294
364−-- | Mouse up events for a particular mouse button
365−mouseUp
366− :: (Reflex t, Monad m)
367− => VtyWidget t m (Event t MouseUp)
368−mouseUp = do
369− i <- input
370− return $ fforMaybe i $ \case
371− V.EvMouseUp x y btn' -> Just $ MouseUp btn' (x, y)
372− _ -> Nothing
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
373300
374−-- | Information about a mouse down event
375−data MouseDown = MouseDown
376− { _mouseDown_button :: V.Button
377− , _mouseDown_coordinates :: (Int, Int)
378− , _mouseDown_modifiers :: [V.Modifier]
379− }
380− deriving (Eq, Ord, Show)
301+instance MonadTrans (DisplayRegion t) where
302+ lift = DisplayRegion . lift
381303
382−-- | Information about a mouse up event
383−data MouseUp = MouseUp
384− { _mouseUp_button :: Maybe V.Button
385− , _mouseUp_coordinates :: (Int, Int)
386− }
387− deriving (Eq, Ord, Show)
304+instance MFunctor (DisplayRegion t) where
305+ hoist f = DisplayRegion . hoist f . unDisplayRegion
388306
389−-- | Mouse scroll direction
390−data ScrollDirection = ScrollDirection_Up | ScrollDirection_Down
391− deriving (Eq, Ord, Show)
307+instance MonadNodeId m => MonadNodeId (DisplayRegion t m)
392308
393−-- | Produce an event that fires when the mouse wheel is scrolled
394−mouseScroll
309+-- | Run a 'DisplayRegion' action with a given 'Region'
310+runDisplayRegion
395311 :: (Reflex t, Monad m)
396− => VtyWidget t m (Event t ScrollDirection)
397−mouseScroll = do
398− up <- mouseDown V.BScrollUp
399− down <- mouseDown V.BScrollDown
400− return $ leftmost
401− [ ScrollDirection_Up <$ up
402− , ScrollDirection_Down <$ down
403− ]
312+ => Dynamic t Region
313+ -> DisplayRegion t m a
314+ -> m a
315+runDisplayRegion r = flip runReaderT r . unDisplayRegion
404316
405−-- | Type synonym for a key and modifier combination
406−type KeyCombo = (V.Key, [V.Modifier])
317+-- * Getting focus state
407318
408−-- | Emits an event that fires on a particular key press (without modifiers)
409−key :: (Monad m, Reflex t) => V.Key -> VtyWidget t m (Event t KeyCombo)
410−key = keyCombos . Set.singleton . (,[])
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+ )
411347
412−-- | Emits an event that fires on particular key presses (without modifiers)
413−keys :: (Monad m, Reflex t) => [V.Key] -> VtyWidget t m (Event t KeyCombo)
414−keys = keyCombos . Set.fromList . fmap (,[])
348+instance (Monad m, Reflex t) => HasFocusReader t (FocusReader t m) where
349+ focus = FocusReader ask
350+ localFocus f = FocusReader . local f . unFocusReader
415351
416−-- | Emit an event that fires whenever the provided key combination occurs
417−keyCombo
418− :: (Reflex t, Monad m)
419− => KeyCombo
420− -> VtyWidget t m (Event t KeyCombo)
421−keyCombo = keyCombos . Set.singleton
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)
422358
423−-- | Emit an event that fires whenever any of the provided key combinations occur
424−keyCombos
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
425375 :: (Reflex t, Monad m)
426− => Set KeyCombo
427− -> VtyWidget t m (Event t KeyCombo)
428−keyCombos ks = do
429− i <- input
430− return $ fforMaybe i $ \case
431− V.EvKey k m -> if Set.member (k, m) ks
432− then Just (k, m)
433− else Nothing
434− _ -> Nothing
376+ => Dynamic t Bool
377+ -> FocusReader t m a
378+ -> m a
379+runFocusReader b = flip runReaderT b . unFocusReader
435380
436−-- | A plain split of the available space into vertically stacked panes.
437−-- No visual separator is built in here.
438−splitV :: (Reflex t, Monad m, MonadNodeId m)
439− => Dynamic t (Int -> Int)
440− -- ^ Function used to determine size of first pane based on available size
441− -> Dynamic t (Bool, Bool)
442− -- ^ How to focus the two sub-panes, given that we are focused.
443− -> VtyWidget t m a
444− -- ^ Widget for first pane
445− -> VtyWidget t m b
446− -- ^ Widget for second pane
447− -> VtyWidget t m (a,b)
448−splitV sizeFunD focD wA wB = do
449− dw <- displayWidth
450− dh <- displayHeight
451− let regA = DynRegion
452− { _dynRegion_left = pure 0
453− , _dynRegion_top = pure 0
454− , _dynRegion_width = dw
455− , _dynRegion_height = sizeFunD <*> dh
456− }
457− regB = DynRegion
458− { _dynRegion_left = pure 0
459− , _dynRegion_top = _dynRegion_height regA
460− , _dynRegion_width = dw
461− , _dynRegion_height = liftA2 (-) dh (_dynRegion_height regA)
462− }
463− ra <- pane regA (fst <$> focD) wA
464− rb <- pane regB (snd <$> focD) wB
465− return (ra,rb)
466−
467−-- | A plain split of the available space into horizontally stacked panes.
468−-- No visual separator is built in here.
469−splitH :: (Reflex t, Monad m, MonadNodeId m)
470− => Dynamic t (Int -> Int)
471− -- ^ Function used to determine size of first pane based on available size
472− -> Dynamic t (Bool, Bool)
473− -- ^ How to focus the two sub-panes, given that we are focused.
474− -> VtyWidget t m a
475− -- ^ Widget for first pane
476− -> VtyWidget t m b
477− -- ^ Widget for second pane
478− -> VtyWidget t m (a,b)
479−splitH sizeFunD focD wA wB = do
480− dw <- displayWidth
481− dh <- displayHeight
482− let regA = DynRegion
483− { _dynRegion_left = pure 0
484− , _dynRegion_top = pure 0
485− , _dynRegion_width = sizeFunD <*> dw
486− , _dynRegion_height = dh
487− }
488− regB = DynRegion
489− { _dynRegion_left = _dynRegion_width regA
490− , _dynRegion_top = pure 0
491− , _dynRegion_width = liftA2 (-) dw (_dynRegion_width regA)
492− , _dynRegion_height = dh
493− }
494− liftA2 (,) (pane regA (fmap fst focD) wA) (pane regB (fmap snd focD) wB)
495−
496−-- | A split of the available space into two parts with a draggable separator.
497−-- Starts with half the space allocated to each, and the first pane has focus.
498−-- Clicking in a pane switches focus.
499−splitVDrag :: (Reflex t, MonadFix m, MonadHold t m, MonadNodeId m)
500− => VtyWidget t m ()
501− -> VtyWidget t m a
502− -> VtyWidget t m b
503− -> VtyWidget t m (a,b)
504−splitVDrag wS wA wB = do
505− dh <- displayHeight
506− dw <- displayWidth
507− h0 <- sample $ current dh -- TODO
508− dragE <- drag V.BLeft
509− let splitter0 = h0 `div` 2
510− rec splitterCheckpoint <- holdDyn splitter0 $ leftmost [fst <$> ffilter snd dragSplitter, resizeSplitter]
511− splitterPos <- holdDyn splitter0 $ leftmost [fst <$> dragSplitter, resizeSplitter]
512− splitterFrac <- holdDyn ((1::Double) / 2) $ ffor (attach (current dh) (fst <$> dragSplitter)) $ \(h, x) ->
513− fromIntegral x / max 1 (fromIntegral h)
514− let dragSplitter = fforMaybe (attach (current splitterCheckpoint) dragE) $
515− \(splitterY, Drag (_, fromY) (_, toY) _ _ end) ->
516− if splitterY == fromY then Just (toY, end) else Nothing
517− regA = DynRegion 0 0 dw splitterPos
518− regS = DynRegion 0 splitterPos dw 1
519− regB = DynRegion 0 (splitterPos + 1) dw (dh - splitterPos - 1)
520− resizeSplitter = ffor (attach (current splitterFrac) (updated dh)) $
521− \(frac, h) -> round (frac * fromIntegral h)
522− focA <- holdDyn True $ leftmost
523− [ True <$ mA
524− , False <$ mB
525− ]
526− (mA, rA) <- pane regA focA $ withMouseDown wA
527− pane regS (pure False) wS
528− (mB, rB) <- pane regB (not <$> focA) $ withMouseDown wB
529− return (rA, rB)
530− where
531− withMouseDown x = do
532− m <- mouseDown V.BLeft
533− x' <- x
534− return (m, x')
535−
536−-- | Fill the background with a particular character.
537−fill :: (Reflex t, Monad m) => Char -> VtyWidget t m ()
538−fill c = do
539− dw <- displayWidth
540− dh <- displayHeight
541− let fillImg = current $ liftA2 (\w h -> [V.charFill V.defAttr c w h]) dw dh
542− tellImages fillImg
543−
544−-- | Fill the background with the bottom
545−hRule :: (Reflex t, Monad m) => BoxStyle -> VtyWidget t m ()
546−hRule boxStyle = fill (_boxStyle_s boxStyle)
547−
548−-- | Defines a set of symbols to use to draw the outlines of boxes
549−-- C.f. https://en.wikipedia.org/wiki/Box-drawing_character
550−data BoxStyle = BoxStyle
551− { _boxStyle_nw :: Char
552− , _boxStyle_n :: Char
553− , _boxStyle_ne :: Char
554− , _boxStyle_e :: Char
555− , _boxStyle_se :: Char
556− , _boxStyle_s :: Char
557− , _boxStyle_sw :: Char
558− , _boxStyle_w :: Char
559− }
381+-- * "Image" output
560382
561−instance Default BoxStyle where
562− def = singleBoxStyle
563−
564−-- | A box style that uses hyphens and pipe characters. Doesn't handle
565−-- corners very well.
566−hyphenBoxStyle :: BoxStyle
567−hyphenBoxStyle = BoxStyle '-' '-' '-' '|' '-' '-' '-' '|'
568−
569−-- | A single line box style
570−singleBoxStyle :: BoxStyle
571−singleBoxStyle = BoxStyle '┌' '─' '┐' '│' '┘' '─' '└' '│'
572−
573−-- | A thick single line box style
574−thickBoxStyle :: BoxStyle
575−thickBoxStyle = BoxStyle '┏' '━' '┓' '┃' '┛' '━' '┗' '┃'
576−
577−-- | A double line box style
578−doubleBoxStyle :: BoxStyle
579−doubleBoxStyle = BoxStyle '╔' '═' '╗' '║' '╝' '═' '╚' '║'
580−
581−-- | A single line box style with rounded corners
582−roundedBoxStyle :: BoxStyle
583−roundedBoxStyle = BoxStyle '╭' '─' '╮' '│' '╯' '─' '╰' '│'
584−
585−-- | Draws a titled box in the provided style and a child widget inside of that box
586−boxTitle :: (Monad m, Reflex t, MonadNodeId m)
587− => Behavior t BoxStyle
588− -> Text
589− -> VtyWidget t m a
590− -> VtyWidget t m a
591−boxTitle boxStyle title child = do
592− dh <- displayHeight
593− dw <- displayWidth
594− let boxReg = DynRegion (pure 0) (pure 0) dw dh
595− innerReg = DynRegion (pure 1) (pure 1) (subtract 2 <$> dw) (subtract 2 <$> dh)
596− tellImages (boxImages <$> boxStyle <*> currentRegion boxReg)
597− tellImages (fmap (\r -> [regionBlankImage r]) (currentRegion innerReg))
598− pane innerReg (pure True) child
599− where
600− boxImages :: BoxStyle -> Region -> [Image]
601− boxImages style (Region left top width height) =
602− let right = left + width - 1
603− bottom = top + height - 1
604− sides =
605− [ withinImage (Region (left + 1) top (width - 2) 1) $
606− V.text' V.defAttr $
607− hPadText title (_boxStyle_n style) (width - 2)
608− , withinImage (Region right (top + 1) 1 (height - 2)) $
609− V.charFill V.defAttr (_boxStyle_e style) 1 (height - 2)
610− , withinImage (Region (left + 1) bottom (width - 2) 1) $
611− V.charFill V.defAttr (_boxStyle_s style) (width - 2) 1
612− , withinImage (Region left (top + 1) 1 (height - 2)) $
613− V.charFill V.defAttr (_boxStyle_w style) 1 (height - 2)
614− ]
615− corners =
616− [ withinImage (Region left top 1 1) $
617− V.char V.defAttr (_boxStyle_nw style)
618− , withinImage (Region right top 1 1) $
619− V.char V.defAttr (_boxStyle_ne style)
620− , withinImage (Region right bottom 1 1) $
621− V.char V.defAttr (_boxStyle_se style)
622− , withinImage (Region left bottom 1 1) $
623− V.char V.defAttr (_boxStyle_sw style)
624− ]
625− in sides ++ if width > 1 && height > 1 then corners else []
626− hPadText :: T.Text -> Char -> Int -> T.Text
627− hPadText t c l = if lt >= l
628− then t
629− else left <> t <> right
630− where
631− lt = T.length t
632− delta = l - lt
633− mkHalf n = T.replicate (n `div` 2) (T.singleton c)
634− left = mkHalf $ delta + 1
635− right = mkHalf delta
636−
637−-- | A box without a title
638−box :: (Monad m, Reflex t, MonadNodeId m)
639− => Behavior t BoxStyle
640− -> VtyWidget t m a
641− -> VtyWidget t m a
642−box boxStyle = boxTitle boxStyle mempty
643−
644−-- | A box whose style is static
645−boxStatic
646− :: (Reflex t, Monad m, MonadNodeId m)
647− => BoxStyle
648− -> VtyWidget t m a
649− -> VtyWidget t m a
650−boxStatic = box . pure
651−
652−-- | Configuration options for displaying "rich" text
653−data RichTextConfig t = RichTextConfig
654− { _richTextConfig_attributes :: Behavior t V.Attr
655− }
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
656424
657−instance Reflex t => Default (RichTextConfig t) where
658− def = RichTextConfig $ pure V.defAttr
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)
659430
660−-- | A widget that displays text with custom time-varying attributes
661−richText
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
662443 :: (Reflex t, Monad m)
663− => RichTextConfig t
664− -> Behavior t Text
665− -> VtyWidget t m ()
666−richText cfg t = do
667− dw <- displayWidth
668− let img = (\w a s -> [wrapText w a s])
669− <$> current dw
670− <*> _richTextConfig_attributes cfg
671− <*> t
672− tellImages img
673− where
674− wrapText maxWidth attrs = V.vertCat
675− . concatMap (fmap (V.string attrs . T.unpack) . TZ.wrapWithOffset maxWidth 0)
676− . T.split (=='\n')
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
677502
678−-- | Renders text, wrapped to the container width
679−text
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
680510 :: (Reflex t, Monad m)
681− => Behavior t Text
682− -> VtyWidget t m ()
683−text = richText def
684−
685−-- | Scrollable text widget. The output pair exposes the current scroll position and total number of lines (including those
686−-- that are hidden)
687−scrollableText
688− :: forall t m. (Reflex t, MonadHold t m, MonadFix m)
689− => Event t Int
690− -- ^ Number of lines to scroll by
691− -> Behavior t Text
692− -> VtyWidget t m (Behavior t (Int, Int))
693− -- ^ (Current scroll position, total number of lines)
694−scrollableText scrollBy t = do
695− dw <- displayWidth
696− let imgs = wrap <$> current dw <*> t
697− kup <- key V.KUp
698− kdown <- key V.KDown
699− m <- mouseScroll
700− let requestedScroll :: Event t Int
701− requestedScroll = leftmost
702− [ 1 <$ kdown
703− , (-1) <$ kup
704− , ffor m $ \case
705− ScrollDirection_Up -> (-1)
706− ScrollDirection_Down -> 1
707− , scrollBy
708− ]
709− updateLine maxN delta ix = min (max 0 (ix + delta)) maxN
710− lineIndex :: Dynamic t Int <- foldDyn (\(maxN, delta) ix -> updateLine (maxN - 1) delta ix) 0 $
711− attach (length <$> imgs) requestedScroll
712− tellImages $ fmap ((:[]) . V.vertCat) $ drop <$> current lineIndex <*> imgs
713− return $ (,) <$> ((+) <$> current lineIndex <*> pure 1) <*> (length <$> imgs)
714− where
715− wrap maxWidth = concatMap (fmap (V.string V.defAttr . T.unpack) . TZ.wrapWithOffset maxWidth 0) . T.split (=='\n')
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
518+
519+-- | Translates and crops an 'Image' so that it is contained by
520+-- the given 'Region'.
521+withinImage
522+ :: Region
523+ -> Image
524+ -> Image
525+withinImage (Region left top width height)
526+ | width < 0 || height < 0 = withinImage (Region left top 0 0)
527+ | otherwise = V.translate left top . V.crop width height
528+
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
540+-- a given region and context. This widget filters and modifies the input
541+-- that the child widget receives such that:
542+-- * unfocused widgets receive no key events
543+-- * mouse inputs outside the region are ignored
544+-- * mouse inputs inside the region have their coordinates translated such
545+-- that (0,0) is the top-left corner of the region
546+pane
547+ :: (Reflex t, Monad m, HasInput t m, HasImageWriter t m, HasDisplayRegion t m, HasFocusReader t m)
548+ => Dynamic t Region
549+ -> Dynamic t Bool -- ^ Whether the widget should be focused when the parent is.
550+ -> m a
551+ -> m a
552+pane dr foc child = localRegion (const dr) $
553+ mapImages (imagesInRegion $ current dr) $
554+ localFocus (const foc) $
555+ inputInFocusedRegion >>= \e -> localInput (const e) child
716556
717−-- | Renders any behavior whose value can be converted to
718−-- 'String' as text
719−display
720− :: (Reflex t, Monad m, Show a)
721− => Behavior t a
722− -> VtyWidget t m ()
723−display a = text $ T.pack . show <$> a
557+-- * Misc
724558
725559-- | A widget that draws nothing
726−blank :: Monad m => VtyWidget t m ()
560+blank :: Monad m => m ()
727561blank = return ()