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