@@ -2,41 +2,116 @@
22Module: Reflex.Vty.Widget
33Description: Basic set of widgets and building blocks for reflex-vty applications
44-}
5−{-# Language UndecidableInstances #-}
6−
7−module Reflex.Vty.Widget where
5+{-# LANGUAGE FlexibleContexts #-}
6+{-# LANGUAGE FlexibleInstances #-}
7+{-# LANGUAGE FunctionalDependencies #-}
8+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
9+{-# LANGUAGE LambdaCase #-}
10+{-# LANGUAGE MultiParamTypeClasses #-}
11+{-# LANGUAGE OverloadedStrings #-}
12+{-# LANGUAGE RankNTypes #-}
13+{-# LANGUAGE RecursiveDo #-}
14+{-# LANGUAGE TypeFamilies #-}
15+module Reflex.Vty.Widget
16+ ( VtyWidgetCtx(..)
17+ , VtyWidget(..)
18+ , VtyWidgetOut(..)
19+ , runVtyWidget
20+ , mainWidget
21+ , mainWidgetWithHandle
22+ , HasDisplaySize(..)
23+ , displayWidth
24+ , displayHeight
25+ , HasFocus(..)
26+ , HasVtyInput(..)
27+ , Region(..)
28+ , regionSize
29+ , regionBlankImage
30+ , Drag (..)
31+ , drag
32+ , mouseDown
33+ , pane
34+ , modifyImages
35+ , tellImages
36+ , tellShutdown
37+ , splitV
38+ , splitVDrag
39+ , box
40+ , text
41+ , display
42+ , hyphenBoxStyle
43+ , singleBoxStyle
44+ , roundedBoxStyle
45+ , thickBoxStyle
46+ , doubleBoxStyle
47+ , fill
48+ , hRule
49+ ) where
850
951import Control.Applicative (liftA2)
1052import Control.Monad.Fix (MonadFix)
11−import Control.Monad.IO.Class (MonadIO)
12−import Control.Monad.Morph
13−import Control.Monad.NodeId
14−import Control.Monad.Reader (ReaderT, ask, local, runReaderT)
15−import Control.Monad.Ref
16−import Control.Monad.Trans (MonadTrans, lift)
17−import Data.Set (Set)
18−import qualified Data.Set as Set
53+import Control.Monad.Trans (lift)
54+import Control.Monad.Trans.Reader (ReaderT, runReaderT, asks, ask)
55+import Control.Monad.Trans.Writer (WriterT, runWriterT, censor, tell)
56+import Data.Default (Default(..))
57+import Data.Text (Text)
58+import qualified Data.Text as T
59+import qualified Data.Text.Zipper as TZ
1960import Graphics.Vty (Image)
2061import qualified Graphics.Vty as V
2162import Reflex
22−import Reflex.Class ()
23−import Reflex.Host.Class (MonadReflexCreateTrigger)
63+
2464import Reflex.Vty.Host
2565
26−-- * Running a vty application
66+-- | The context within which a 'VtyWidget' runs
67+data VtyWidgetCtx t = VtyWidgetCtx
68+ { _vtyWidgetCtx_size :: Dynamic t (Int,Int)
69+ -- ^ The width and height of the region allocated to the widget.
70+ , _vtyWidgetCtx_focus :: Dynamic t Bool
71+ -- ^ Whether the widget should behave as if it has focus for keyboard input.
72+ , _vtyWidgetCtx_input :: Event t VtyEvent
73+ -- ^ User input events that the widget's parent chooses to share. These will generally
74+ -- be filtered for relevance:
75+ -- * Keyboard inputs are restricted to focused widgets
76+ -- * Mouse inputs are restricted to the region in which the widget resides and are
77+ -- translated into its internal coordinates.
78+ }
79+
80+-- | The output of a 'VtyWidget'
81+data VtyWidgetOut t = VtyWidgetOut
82+ { _vtyWidgetOut_images :: Behavior t [Image]
83+ -- ^ The visual output of the 'VtyWidget'
84+ , _vtyWidgetOut_shutdown :: Event t ()
85+ }
86+
87+instance Reflex t => Semigroup (VtyWidgetOut t) where
88+ wo <> wo' = VtyWidgetOut
89+ { _vtyWidgetOut_images = _vtyWidgetOut_images wo <> _vtyWidgetOut_images wo'
90+ , _vtyWidgetOut_shutdown = _vtyWidgetOut_shutdown wo <> _vtyWidgetOut_shutdown wo'
91+ }
92+
93+instance (Reflex t) => Monoid (VtyWidgetOut t) where
94+ mempty = VtyWidgetOut mempty mempty
95+ mappend wo wo' = wo <> wo'
96+
97+-- | A widget that can read its context and produce image output
98+newtype VtyWidget t m a = VtyWidget
99+ { unVtyWidget :: WriterT (VtyWidgetOut t) (ReaderT (VtyWidgetCtx t) m) a
100+ }
101+ deriving (Functor, Applicative, Monad, MonadSample t, MonadHold t, MonadFix)
27102
28−-- | Sets up the top-level context for a vty widget and runs it with that context
103+-- | Runs a 'VtyWidget' with a given context
104+runVtyWidget
105+ :: Reflex t
106+ => VtyWidgetCtx t
107+ -> VtyWidget t m a
108+ -> m (a, VtyWidgetOut t)
109+runVtyWidget ctx w = runReaderT (runWriterT (unVtyWidget w)) ctx
110+
111+-- | Sets up the top-level context for a 'VtyWidget' and runs it with that context
29112mainWidgetWithHandle
30113 :: V.Vty
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 ()))
114+ -> (forall t m. MonadVtyApp t m => VtyWidget t m ())
40115 -> IO ()
41116mainWidgetWithHandle vty child =
42117 runVtyAppWithHandle vty $ \dr0 inp -> do
@@ -46,178 +121,69 @@ mainWidgetWithHandle vty child =
46121 let inp' = fforMaybe inp $ \case
47122 V.EvResize {} -> Nothing
48123 x -> Just x
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
124+ let ctx = VtyWidgetCtx
125+ { _vtyWidgetCtx_size = size
126+ , _vtyWidgetCtx_input = inp'
127+ , _vtyWidgetCtx_focus = constDyn True
128+ }
129+ ((), wo) <- runVtyWidget ctx child
57130 return $ VtyResult
58− { _vtyResult_picture = fmap (V.picForLayers . reverse) images
59− , _vtyResult_shutdown = shutdown
131+ { _vtyResult_picture = fmap (V.picForLayers . reverse) (_vtyWidgetOut_images wo)
132+ , _vtyResult_shutdown = _vtyWidgetOut_shutdown wo
60133 }
61134
62−-- | The output of a vty widget
63−data VtyWidgetOut t = VtyWidgetOut
64− { _vtyWidgetOut_shutdown :: Event t ()
65− }
66−
67135-- | Like 'mainWidgetWithHandle', but uses a default vty configuration
68136mainWidget
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 ()))
137+ :: (forall t m. MonadVtyApp t m => VtyWidget t m ())
78138 -> IO ()
79139mainWidget child = do
80140 vty <- getDefaultVty
81141 mainWidgetWithHandle vty child
82142
83−-- * Input Events
143+-- | A class for things that know their own display size dimensions
144+class (Reflex t, Monad m) => HasDisplaySize t m | m -> t where
145+ displaySize :: m (Dynamic t (Int, Int))
146+
147+instance (Reflex t, Monad m) => HasDisplaySize t (VtyWidget t m) where
148+ displaySize = VtyWidget . lift $ asks _vtyWidgetCtx_size
149+
150+-- | Retrieve the display width (columns)
151+displayWidth :: HasDisplaySize t m => m (Dynamic t Int)
152+displayWidth = fmap fst <$> displaySize
153+
154+-- | Retrieve the display height (rows)
155+displayHeight :: HasDisplaySize t m => m (Dynamic t Int)
156+displayHeight = fmap snd <$> displaySize
84157
85158-- | A class for things that can receive vty events as input
86−class HasInput t m | m -> t where
159+class HasVtyInput t m | m -> t where
87160 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− )
113−
114−instance (Adjustable t m, MonadHold t m, Reflex t) => Adjustable t (Input t m) where
115− runWithReplace a0 a' = Input $ runWithReplace (unInput a0) $ fmap unInput a'
116− traverseIntMapWithKeyWithAdjust f dm0 dm' = Input $
117− traverseIntMapWithKeyWithAdjust (\k v -> unInput (f k v)) dm0 dm'
118− traverseDMapWithKeyWithAdjust f dm0 dm' = Input $ do
119− traverseDMapWithKeyWithAdjust (\k v -> unInput (f k v)) dm0 dm'
120− traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = Input $ do
121− traverseDMapWithKeyWithAdjustWithMove (\k v -> unInput (f k v)) dm0 dm'
122−
123−deriving instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (Input t m)
124−deriving instance NotReady t m => NotReady t (Input t m)
125−deriving instance PerformEvent t m => PerformEvent t (Input t m)
126−deriving instance PostBuild t m => PostBuild t (Input t m)
127−deriving instance TriggerEvent t m => TriggerEvent t (Input t m)
128−instance HasImageWriter t m => HasImageWriter t (Input t m)
129−instance HasDisplayRegion t m => HasDisplayRegion t (Input t m)
130−instance HasFocusReader t m => HasFocusReader t (Input t m)
131−
132−instance MonadTrans (Input t) where
133− lift f = Input $ lift f
134−
135−instance MFunctor (Input t) where
136− hoist f = Input . hoist f . unInput
137−
138−instance MonadNodeId m => MonadNodeId (Input t m)
139−
140−-- | Runs an 'Input' with a given context
141−runInput
142− :: Reflex t
143− => Event t VtyEvent
144− -> Input t m a
145− -> m a
146−runInput e w = runReaderT (unInput w) e
147−
148−-- ** Filtering input
149−
150−-- | Type synonym for a key and modifier combination
151−type KeyCombo = (V.Key, [V.Modifier])
152−
153−-- | Emits an event that fires on a particular key press (without modifiers)
154−key :: (Monad m, Reflex t, HasInput t m) => V.Key -> m (Event t KeyCombo)
155−key = keyCombos . Set.singleton . (,[])
156−
157−-- | Emits an event that fires on particular key presses (without modifiers)
158−keys :: (Monad m, Reflex t, HasInput t m) => [V.Key] -> m (Event t KeyCombo)
159−keys = keyCombos . Set.fromList . fmap (,[])
160−
161−-- | Emit an event that fires whenever the provided key combination occurs
162−keyCombo
163− :: (Reflex t, Monad m, HasInput t m)
164− => KeyCombo
165− -> m (Event t KeyCombo)
166−keyCombo = keyCombos . Set.singleton
167−
168−-- | Emit an event that fires whenever any of the provided key combinations occur
169−keyCombos
170− :: (Reflex t, Monad m, HasInput t m)
171− => Set KeyCombo
172− -> m (Event t KeyCombo)
173−keyCombos ks = do
174− i <- input
175− return $ fforMaybe i $ \case
176− V.EvKey k m -> if Set.member (k, m) ks
177− then Just (k, m)
178− else Nothing
179− _ -> Nothing
180161
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
162+instance (Reflex t, Monad m) => HasVtyInput t (VtyWidget t m) where
163+ input = VtyWidget . lift $ asks _vtyWidgetCtx_input
164+
165+-- | A class for things that can dynamically gain and lose focus
166+class HasFocus t m | m -> t where
167+ focus :: m (Dynamic t Bool)
219168
220−-- * Getting and setting the display region
169+instance (Reflex t, Monad m) => HasFocus t (VtyWidget t m) where
170+ focus = VtyWidget . lift $ asks _vtyWidgetCtx_focus
171+
172+-- | A class for widgets that can produce images to draw to the display
173+class (Reflex t, Monad m) => ImageWriter t m | m -> t where
174+ -- | Send images upstream for rendering
175+ tellImages :: Behavior t [Image] -> m ()
176+
177+instance (Reflex t, Monad m) => ImageWriter t (VtyWidget t m) where
178+ tellImages imgs = VtyWidget $ tell (mempty { _vtyWidgetOut_images = imgs })
179+
180+-- | A class for things that can shut down the vty application
181+class (Reflex t, Monad m) => Shutdown t m where
182+ -- | Signals that the vty application should shut down
183+ tellShutdown :: Event t () -> m ()
184+
185+instance (Reflex t, Monad m) => Shutdown t (VtyWidget t m) where
186+ tellShutdown sd = VtyWidget $ tell (mempty { _vtyWidgetOut_shutdown = sd })
221187
222188-- | A chunk of the display area
223189data Region = Region
@@ -228,293 +194,15 @@ data Region = Region
228194 }
229195 deriving (Show, Read, Eq, Ord)
230196
231−-- | A region that occupies no space.
232−nilRegion :: Region
233−nilRegion = Region 0 0 0 0
234−
235197-- | The width and height of a 'Region'
236198regionSize :: Region -> (Int, Int)
237199regionSize (Region _ _ w h) = (w, h)
238200
239−-- | Produces an 'Image' that fills a region with space characters
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
380201
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
202+-- | Produces an 'Image' that fills a region with space characters
203+regionBlankImage :: Region -> Image
204+regionBlankImage r@(Region _ _ width height) =
205+ withinImage r $ V.charFill V.defAttr ' ' width height
518206
519207-- | Translates and crops an 'Image' so that it is contained by
520208-- the given 'Region'.
@@ -526,17 +214,7 @@ withinImage (Region left top width height)
526214 | width < 0 || height < 0 = withinImage (Region left top 0 0)
527215 | otherwise = V.translate left top . V.crop width height
528216
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
217+-- | Low-level widget combinator that runs a child 'VtyWidget' within
540218-- a given region and context. This widget filters and modifies the input
541219-- that the child widget receives such that:
542220-- * unfocused widgets receive no key events
@@ -544,18 +222,267 @@ imagesInRegion reg = liftA2 (\r is -> map (withinImage r) is) reg
544222-- * mouse inputs inside the region have their coordinates translated such
545223-- that (0,0) is the top-left corner of the region
546224pane
547− :: (Reflex t, Monad m, HasInput t m, HasImageWriter t m, HasDisplayRegion t m, HasFocusReader t m)
548− => Dynamic t Region
225+ :: (Reflex t, Monad m)
226+ => Dynamic t Region -- ^ Region into which we should draw the widget (in coordinates relative to our own)
549227 -> 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
556−
557−-- * Misc
558−
559−-- | A widget that draws nothing
560−blank :: Monad m => m ()
561−blank = return ()
228+ -> VtyWidget t m a
229+ -> VtyWidget t m a
230+pane reg foc child = VtyWidget $ do
231+ ctx <- lift ask
232+ let ctx' = VtyWidgetCtx
233+ { _vtyWidgetCtx_input = leftmost -- TODO: think about this leftmost more.
234+ [ fmapMaybe id $
235+ attachWith (\(r,f) e -> filterInput r f e)
236+ (liftA2 (,) (current reg) (current foc))
237+ (_vtyWidgetCtx_input ctx)
238+ ]
239+ , _vtyWidgetCtx_focus = liftA2 (&&) (_vtyWidgetCtx_focus ctx) foc
240+ , _vtyWidgetCtx_size = fmap regionSize reg }
241+ (result, wo) <- lift . lift $ runVtyWidget ctx' child
242+ let images = _vtyWidgetOut_images wo
243+ images' = liftA2 (\r is -> map (withinImage r) is) (current reg) images
244+ wo' = wo { _vtyWidgetOut_images = images' }
245+ tell wo'
246+ return result
247+ where
248+ filterInput :: Region -> Bool -> VtyEvent -> Maybe VtyEvent
249+ filterInput (Region l t w h) focused e = case e of
250+ V.EvKey _ _ | not focused -> Nothing
251+ V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
252+ V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
253+ _ -> Just e
254+ where
255+ mouse con x y
256+ | or [ x < l
257+ , y < t
258+ , x >= l + w
259+ , y >= t + h ] = Nothing
260+ | otherwise =
261+ Just (con (x - l) (y - t))
262+
263+-- | Information about a drag operation
264+data Drag = Drag
265+ { _drag_from :: (Int, Int) -- ^ Where the drag began
266+ , _drag_to :: (Int, Int) -- ^ Where the mouse currently is
267+ , _drag_button :: V.Button -- ^ Which mouse button is dragging
268+ , _drag_modifiers :: [V.Modifier] -- ^ What modifiers are held
269+ , _drag_end :: Bool -- ^ Whether the drag ended (the mouse button was released)
270+ }
271+ deriving (Eq, Ord, Show)
272+
273+-- | Converts raw vty mouse drag events into an event stream of 'Drag's
274+drag
275+ :: (Reflex t, MonadFix m, MonadHold t m)
276+ => V.Button
277+ -> VtyWidget t m (Event t Drag)
278+drag btn = do
279+ inp <- input
280+ let f :: Maybe Drag -> V.Event -> Maybe Drag
281+ f Nothing = const Nothing
282+ f (Just (Drag from _ _ mods end)) = \case
283+ V.EvMouseDown x y btn' mods'
284+ | end -> Just $ Drag (x,y) (x,y) btn' mods' False
285+ | btn == btn' -> Just $ Drag from (x,y) btn mods' False
286+ | otherwise -> Nothing -- Ignore other buttons.
287+ V.EvMouseUp x y (Just btn')
288+ | end -> Nothing
289+ | btn == btn' -> Just $ Drag from (x,y) btn mods True
290+ | otherwise -> Nothing
291+ V.EvMouseUp x y Nothing -- Terminal doesn't specify mouse up button,
292+ -- assume it's the right one.
293+ | end -> Nothing
294+ | otherwise -> Just $ Drag from (x,y) btn mods True
295+ _ -> Nothing
296+ rec let newDrag = attachWithMaybe f (current dragD) inp
297+ dragD <- holdDyn Nothing $ Just <$> newDrag
298+ return (fmapMaybe id $ updated dragD)
299+
300+-- | Mouse down events for a particular mouse button
301+mouseDown
302+ :: (Reflex t, Monad m)
303+ => V.Button
304+ -> VtyWidget t m (Event t VtyEvent)
305+mouseDown btn = do
306+ i <- input
307+ return $ fforMaybe i $ \x -> case x of
308+ V.EvMouseDown _ _ btn' _ -> if btn == btn' then Just x else Nothing
309+ _ -> Nothing
310+
311+-- | A plain split of the available space into vertically stacked panes.
312+-- No visual separator is built in here.
313+splitV :: (Reflex t, Monad m)
314+ => Dynamic t (Int -> Int)
315+ -- ^ Function used to determine size of first pane based on available size
316+ -> Dynamic t (Bool, Bool)
317+ -- ^ How to focus the two sub-panes, given that we are focused.
318+ -> VtyWidget t m a
319+ -- ^ Widget for first pane
320+ -> VtyWidget t m b
321+ -- ^ Widget for second pane
322+ -> VtyWidget t m (a,b)
323+splitV sizeFunD focD wA wB = do
324+ sz <- displaySize
325+ let regA = (\f (w,h) -> Region 0 0 w (f h)) <$> sizeFunD <*> sz
326+ regB = (\(w,h) (Region _ _ _ hA) -> Region 0 hA w (h - hA)) <$> sz <*> regA
327+ ra <- pane regA (fst <$> focD) wA
328+ rb <- pane regB (snd <$> focD) wB
329+ return (ra,rb)
330+
331+-- | A split of the available space into two parts with a draggable separator.
332+-- Starts with half the space allocated to each, and the first pane has focus.
333+-- Clicking in a pane switches focus.
334+splitVDrag :: (Reflex t, MonadFix m, MonadHold t m)
335+ => VtyWidget t m ()
336+ -> VtyWidget t m a
337+ -> VtyWidget t m b
338+ -> VtyWidget t m (a,b)
339+splitVDrag wS wA wB = do
340+ sz <- displaySize
341+ (_, h0) <- sample $ current sz
342+ dragE <- drag V.BLeft
343+ let splitter0 = h0 `div` 2
344+ rec splitterCheckpoint <- holdDyn splitter0 $ leftmost [fst <$> ffilter snd dragSplitter, resizeSplitter]
345+ splitterPos <- holdDyn splitter0 $ leftmost [fst <$> dragSplitter, resizeSplitter]
346+ splitterFrac <- holdDyn ((1::Double) / 2) $ ffor (attach (current sz) (fst <$> dragSplitter)) $ \((_,h),x) ->
347+ fromIntegral x / fromIntegral h
348+ let dragSplitter = fforMaybe (attach (current splitterCheckpoint) dragE) $
349+ \(splitterY, Drag (_, fromY) (_, toY) _ _ end) ->
350+ if splitterY == fromY then Just (toY, end) else Nothing
351+ regA = (\(w,_) sp -> Region 0 0 w sp) <$> sz <*> splitterPos
352+ regS = (\(w,_) sp -> Region 0 sp w 1) <$> sz <*> splitterPos
353+ regB = (\(w,h) sp -> Region 0 (sp + 1) w (h - sp - 1)) <$> sz <*> splitterPos
354+ resizeSplitter = ffor (attach (current splitterFrac) (updated sz)) $
355+ \(frac, (_,h)) -> round (frac * fromIntegral h)
356+ focA <- holdDyn True $ leftmost
357+ [ True <$ mA
358+ , False <$ mB
359+ ]
360+ (mA, rA) <- pane regA focA $ withMouseDown wA
361+ pane regS (pure False) wS
362+ (mB, rB) <- pane regB (not <$> focA) $ withMouseDown wB
363+ return (rA, rB)
364+ where
365+ withMouseDown x = do
366+ m <- mouseDown V.BLeft
367+ x' <- x
368+ return (m, x')
369+
370+-- | Fill the background with a particular character.
371+fill :: (Reflex t, Monad m) => Char -> VtyWidget t m ()
372+fill c = do
373+ sz <- displaySize
374+ let fillImg = ffor (current sz) $ \(w,h) -> [V.charFill V.defAttr c w h]
375+ tellImages fillImg
376+
377+-- | Fill the background with the bottom
378+hRule :: (Reflex t, Monad m) => BoxStyle -> VtyWidget t m ()
379+hRule boxStyle = fill (_boxStyle_s boxStyle)
380+
381+-- | Transform the images produces by a widget
382+modifyImages
383+ :: (Reflex t, MonadHold t m, MonadFix m)
384+ => Behavior t ([Image] -> [Image])
385+ -> VtyWidget t m a
386+ -> VtyWidget t m a
387+modifyImages f (VtyWidget w) = VtyWidget $ flip censor w $ \wo ->
388+ wo { _vtyWidgetOut_images = f <*> (_vtyWidgetOut_images wo) }
389+
390+-- | Defines a set of symbols to use to draw the outlines of boxes
391+-- C.f. https://en.wikipedia.org/wiki/Box-drawing_character
392+data BoxStyle = BoxStyle
393+ { _boxStyle_nw :: Char
394+ , _boxStyle_n :: Char
395+ , _boxStyle_ne :: Char
396+ , _boxStyle_e :: Char
397+ , _boxStyle_se :: Char
398+ , _boxStyle_s :: Char
399+ , _boxStyle_sw :: Char
400+ , _boxStyle_w :: Char
401+ }
402+
403+instance Default BoxStyle where
404+ def = singleBoxStyle
405+
406+-- | A box style that uses hyphens and pipe characters. Doesn't handle
407+-- corners very well.
408+hyphenBoxStyle :: BoxStyle
409+hyphenBoxStyle = BoxStyle '-' '-' '-' '|' '-' '-' '-' '|'
410+
411+-- | A single line box style
412+singleBoxStyle :: BoxStyle
413+singleBoxStyle = BoxStyle '┌' '─' '┐' '│' '┘' '─' '└' '│'
414+
415+-- | A thick single line box style
416+thickBoxStyle :: BoxStyle
417+thickBoxStyle = BoxStyle '┏' '━' '┓' '┃' '┛' '━' '┗' '┃'
418+
419+-- | A double line box style
420+doubleBoxStyle :: BoxStyle
421+doubleBoxStyle = BoxStyle '╔' '═' '╗' '║' '╝' '═' '╚' '║'
422+
423+-- | A single line box style with rounded corners
424+roundedBoxStyle :: BoxStyle
425+roundedBoxStyle = BoxStyle '╭' '─' '╮' '│' '╯' '─' '╰' '│'
426+
427+-- | Draws a box in the provided style and a child widget inside of that box
428+box :: (Monad m, Reflex t)
429+ => BoxStyle
430+ -> VtyWidget t m a
431+ -> VtyWidget t m a
432+box style child = do
433+ sz <- displaySize
434+ let boxReg = ffor (current sz) $ \(w,h) -> Region 0 0 w h
435+ innerReg = ffor sz $ \(w,h) -> Region 1 1 (w - 2) (h - 2)
436+ tellImages (fmap boxImages boxReg)
437+ tellImages (fmap (\r -> [regionBlankImage r]) (current innerReg))
438+ pane innerReg (pure True) child
439+ where
440+ boxImages :: Region -> [Image]
441+ boxImages (Region left top width height) =
442+ let right = left + width - 1
443+ bottom = top + height - 1
444+ sides =
445+ [ withinImage (Region (left + 1) top (width - 2) 1) $
446+ V.charFill V.defAttr (_boxStyle_n style) (width - 2) 1
447+ , withinImage (Region right (top + 1) 1 (height - 2)) $
448+ V.charFill V.defAttr (_boxStyle_e style) 1 (height - 2)
449+ , withinImage (Region (left + 1) bottom (width - 2) 1) $
450+ V.charFill V.defAttr (_boxStyle_s style) (width - 2) 1
451+ , withinImage (Region left (top + 1) 1 (height - 2)) $
452+ V.charFill V.defAttr (_boxStyle_w style) 1 (height - 2)
453+ ]
454+ corners =
455+ [ withinImage (Region left top 1 1) $
456+ V.char V.defAttr (_boxStyle_nw style)
457+ , withinImage (Region right top 1 1) $
458+ V.char V.defAttr (_boxStyle_ne style)
459+ , withinImage (Region right bottom 1 1) $
460+ V.char V.defAttr (_boxStyle_se style)
461+ , withinImage (Region left bottom 1 1) $
462+ V.char V.defAttr (_boxStyle_sw style)
463+ ]
464+ in sides ++ if width > 1 && height > 1 then corners else []
465+
466+-- | Renders text, wrapped to the container width
467+text
468+ :: (Reflex t, Monad m)
469+ => Behavior t Text
470+ -> VtyWidget t m ()
471+text msg = do
472+ dw <- displayWidth
473+ let img = (\w s -> [wrapText w V.defAttr s]) <$> current dw <*> msg
474+ tellImages img
475+ where
476+ wrapText maxWidth attrs = V.vertCat
477+ . concatMap (fmap (V.string attrs . T.unpack) . TZ.wrapWithOffset maxWidth 0)
478+ . T.split (=='\n')
479+
480+-- | Renders any behavior whose value can be converted to
481+-- 'String' as text
482+display
483+ :: (Reflex t, Monad m, Show a)
484+ => Behavior t a
485+ -> VtyWidget t m ()
486+display a = text $ T.pack . show <$> a
487+
488+