@@ -1,113 +1,42 @@
1โ{-# LANGUAGE FlexibleContexts #-}
1+{-|
2โ{-# LANGUAGE FlexibleInstances #-}
2+Module: Reflex.Vty.Widget
3โ{-# LANGUAGE FunctionalDependencies #-}
3+Description: Basic set of widgets and building blocks for reflex-vty applications
4โ{-# LANGUAGE GeneralizedNewtypeDeriving #-}
4+-}
5โ{-# LANGUAGE LambdaCase #-}
5+{-# Language UndecidableInstances #-}
6โ{-# LANGUAGE MultiParamTypeClasses #-}
6+
7โ{-# LANGUAGE OverloadedStrings #-}
8โ{-# LANGUAGE RankNTypes #-}
9โ{-# LANGUAGE RecursiveDo #-}
10โ{-# LANGUAGE TypeFamilies #-}
11โmodule Reflex.Vty.Widget
7+module Reflex.Vty.Widget where
17โ , mainWidgetWithHandle
18โ , HasDisplaySize(..)
47import Control.Applicative (liftA2)
9import Control.Applicative (liftA2)
48import Control.Monad.Fix (MonadFix)
10import Control.Monad.Fix (MonadFix)
49โimport Control.Monad.Trans (lift)
11+import Control.Monad.IO.Class (MonadIO)
50โimport Control.Monad.Trans.Reader (ReaderT, runReaderT, asks, ask)
12+import Control.Monad.Morph
13+import Control.Monad.NodeId
14+import Control.Monad.Reader (ReaderT, ask, local, runReaderT)
51โimport Control.Monad.Trans.Writer (WriterT, runWriterT, censor, tell)
15+import Control.Monad.Ref
16+import Control.Monad.Trans (MonadTrans, lift)
52โimport Data.Default
17+import Data.Set (Set)
53โimport Data.Text (Text)
54โimport qualified Data.Text as T
18+import qualified Data.Set as Set
55โimport qualified Data.Text.Zipper as TZ
56import Graphics.Vty (Image)
19import Graphics.Vty (Image)
57import qualified Graphics.Vty as V
20import qualified Graphics.Vty as V
58import Reflex
21import Reflex
59โ
22+import Reflex.Class ()
23+import Reflex.Host.Class (MonadReflexCreateTrigger)
60import Reflex.Vty.Host
24import Reflex.Vty.Host
62โ-- | The context within which a 'VtyWidget' runs
26+-- * Running a vty application
63โdata VtyWidgetCtx t = VtyWidgetCtx
64โ { _vtyWidgetCtx_size :: Dynamic t (Int,Int)
65โ -- ^ The width and height of the region allocated to the widget.
66โ , _vtyWidgetCtx_focus :: Dynamic t Bool
67โ -- ^ Whether the widget should behave as if it has focus for keyboard input.
68โ , _vtyWidgetCtx_input :: Event t VtyEvent
69โ -- ^ User input events that the widget's parent chooses to share. These will generally
70โ -- be filtered for relevance:
71โ -- * Keyboard inputs are restricted to focused widgets
72โ -- * Mouse inputs are restricted to the region in which the widget resides and are
73โ -- translated into its internal coordinates.
76โ-- | The output of a 'VtyWidget'
77โdata VtyWidgetOut t = VtyWidgetOut
78โ { _vtyWidgetOut_images :: Behavior t [Image]
79โ -- ^ The visual output of the 'VtyWidget'
80โ , _vtyWidgetOut_shutdown :: Event t ()
83โinstance Reflex t => Semigroup (VtyWidgetOut t) where
84โ wo <> wo' = VtyWidgetOut
85โ { _vtyWidgetOut_images = _vtyWidgetOut_images wo <> _vtyWidgetOut_images wo'
86โ , _vtyWidgetOut_shutdown = _vtyWidgetOut_shutdown wo <> _vtyWidgetOut_shutdown wo'
89โinstance (Reflex t) => Monoid (VtyWidgetOut t) where
90โ mempty = VtyWidgetOut mempty mempty
91โ mappend wo wo' = wo <> wo'
93โ-- | A widget that can read its context and produce image output
94โnewtype VtyWidget t m a = VtyWidget
95โ { unVtyWidget :: WriterT (VtyWidgetOut t) (ReaderT (VtyWidgetCtx t) m) a
97โ deriving (Functor, Applicative, Monad, MonadSample t, MonadHold t, MonadFix)
99โ-- | Runs a 'VtyWidget' with a given context
103โ -> VtyWidget t m a
104โ -> m (a, VtyWidgetOut t)
105โrunVtyWidget ctx w = runReaderT (runWriterT (unVtyWidget w)) ctx
107โ-- | 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
108mainWidgetWithHandle
29mainWidgetWithHandle
110โ -> (forall t m. MonadVtyApp t m => VtyWidget t m ())
32+ ( MonadVtyApp t m
35+ , HasDisplayRegion t m
112mainWidgetWithHandle vty child =
41mainWidgetWithHandle vty child =
113 runVtyAppWithHandle vty $ \dr0 inp -> do
42 runVtyAppWithHandle vty $ \dr0 inp -> do
@@ -117,67 +46,178 @@ mainWidgetWithHandle vty child =
117 let inp' = fforMaybe inp $ \case
46 let inp' = fforMaybe inp $ \case
118 V.EvResize {} -> Nothing
47 V.EvResize {} -> Nothing
119 x -> Just x
48 x -> Just x
120โ let ctx = VtyWidgetCtx
49+ (shutdown, images) <- runThemeReader (constant V.defAttr) $
121โ { _vtyWidgetCtx_size = size
50+ runFocusReader (pure True) $
122โ , _vtyWidgetCtx_input = inp'
51+ runDisplayRegion (fmap (\(w, h) -> Region 0 0 w h) size) $
123โ , _vtyWidgetCtx_focus = constDyn True
52+ runImageWriter $
125โ ((), wo) <- runVtyWidget ctx child
54+ runInput inp' $ do
55+ tellImages . ffor (current size) $ \(w, h) -> [V.charFill V.defAttr ' ' w h]
126 return $ VtyResult
57 return $ VtyResult
127โ { _vtyResult_picture = fmap (V.picForLayers . reverse) (_vtyWidgetOut_images wo)
58+ { _vtyResult_picture = fmap (V.picForLayers . reverse) images
128โ , _vtyResult_shutdown = _vtyWidgetOut_shutdown wo
59+ , _vtyResult_shutdown = shutdown
62+-- | The output of a vty widget
63+data VtyWidgetOut t = VtyWidgetOut
64+ { _vtyWidgetOut_shutdown :: Event t ()
131-- | Like 'mainWidgetWithHandle', but uses a default vty configuration
67-- | Like 'mainWidgetWithHandle', but uses a default vty configuration
132mainWidget
68mainWidget
133โ :: (forall t m. MonadVtyApp t m => VtyWidget t m ())
70+ ( MonadVtyApp t m
73+ , HasDisplayRegion t m
135mainWidget child = do
79mainWidget child = do
136 vty <- getDefaultVty
80 vty <- getDefaultVty
137 mainWidgetWithHandle vty child
81 mainWidgetWithHandle vty child
139โ-- | A class for things that know their own display size dimensions
83+-- * Input Events
140โclass (Reflex t, Monad m) => HasDisplaySize t m | m -> t where
141โ displaySize :: m (Dynamic t (Int, Int))
143โinstance (Reflex t, Monad m) => HasDisplaySize t (VtyWidget t m) where
144โ displaySize = VtyWidget . lift $ asks _vtyWidgetCtx_size
146โ-- | Retrieve the display width (columns)
147โdisplayWidth :: HasDisplaySize t m => m (Dynamic t Int)
148โdisplayWidth = fmap fst <$> displaySize
150โ-- | Retrieve the display height (rows)
151โdisplayHeight :: HasDisplaySize t m => m (Dynamic t Int)
152โdisplayHeight = fmap snd <$> displaySize
154-- | A class for things that can receive vty events as input
85-- | A class for things that can receive vty events as input
155โclass HasVtyInput t m | m -> t where
86+class HasInput t m | m -> t where
156 input :: m (Event t VtyEvent)
87 input :: m (Event t VtyEvent)
88+ default input :: (f m' ~ m, Monad m', MonadTrans f, HasInput t m') => m (Event t VtyEvent)
90+ -- | User input events that the widget's parent chooses to share. These will generally
91+ -- be filtered for relevance.
92+ localInput :: (Event t VtyEvent -> Event t VtyEvent) -> m a -> m a
93+ default localInput :: (f m' ~ m, Monad m', MFunctor f, HasInput t m') => (Event t VtyEvent -> Event t VtyEvent) -> m a -> m a
94+ localInput f = hoist (localInput f)
96+instance (Reflex t, Monad m) => HasInput t (Input t m) where
98+ localInput f (Input m) = Input $ local f m
100+-- | A widget that can receive input events. See 'Graphics.Vty.Event'
101+newtype Input t m a = Input
102+ { unInput :: ReaderT (Event t VtyEvent) m a
114+instance (Adjustable t m, MonadHold t m, Reflex t) => Adjustable t (Input t m) where
115+ runWithReplace a0 a' = Input $ runWithReplace (unInput a0) $ fmap unInput a'
116+ traverseIntMapWithKeyWithAdjust f dm0 dm' = Input $
117+ traverseIntMapWithKeyWithAdjust (\k v -> unInput (f k v)) dm0 dm'
118+ traverseDMapWithKeyWithAdjust f dm0 dm' = Input $ do
119+ traverseDMapWithKeyWithAdjust (\k v -> unInput (f k v)) dm0 dm'
120+ traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = Input $ do
121+ traverseDMapWithKeyWithAdjustWithMove (\k v -> unInput (f k v)) dm0 dm'
123+deriving instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (Input t m)
124+deriving instance NotReady t m => NotReady t (Input t m)
125+deriving instance PerformEvent t m => PerformEvent t (Input t m)
126+deriving instance PostBuild t m => PostBuild t (Input t m)
127+deriving instance TriggerEvent t m => TriggerEvent t (Input t m)
128+instance HasImageWriter t m => HasImageWriter t (Input t m)
129+instance HasDisplayRegion t m => HasDisplayRegion t (Input t m)
130+instance HasFocusReader t m => HasFocusReader t (Input t m)
132+instance MonadTrans (Input t) where
133+ lift f = Input $ lift f
135+instance MFunctor (Input t) where
136+ hoist f = Input . hoist f . unInput
138+instance MonadNodeId m => MonadNodeId (Input t m)
140+-- | Runs an 'Input' with a given context
146+runInput e w = runReaderT (unInput w) e
148+-- ** Filtering input
150+-- | Type synonym for a key and modifier combination
151+type KeyCombo = (V.Key, [V.Modifier])
153+-- | Emits an event that fires on a particular key press (without modifiers)
154+key :: (Monad m, Reflex t, HasInput t m) => V.Key -> m (Event t KeyCombo)
155+key = keyCombos . Set.singleton . (,[])
157+-- | Emits an event that fires on particular key presses (without modifiers)
158+keys :: (Monad m, Reflex t, HasInput t m) => [V.Key] -> m (Event t KeyCombo)
159+keys = keyCombos . Set.fromList . fmap (,[])
161+-- | Emit an event that fires whenever the provided key combination occurs
163+ :: (Reflex t, Monad m, HasInput t m)
165+ -> m (Event t KeyCombo)
166+keyCombo = keyCombos . Set.singleton
168+-- | Emit an event that fires whenever any of the provided key combinations occur
170+ :: (Reflex t, Monad m, HasInput t m)
172+ -> m (Event t KeyCombo)
175+ return $ fforMaybe i $ \case
176+ V.EvKey k m -> if Set.member (k, m) ks
158โinstance (Reflex t, Monad m) => HasVtyInput t (VtyWidget t m) where
181+-- | Filter the keyboard input that a child widget may receive
159โ input = VtyWidget . lift $ asks _vtyWidgetCtx_input
182+filterKeys :: (Reflex t, HasInput t m) => (KeyCombo -> Bool) -> m a -> m a
160โ
183+filterKeys f x = localInput (ffilter (\case
161โ-- | A class for things that can dynamically gain and lose focus
184+ V.EvKey k mods -> f (k, mods)
162โclass HasFocus t m | m -> t where
185+ _ -> True)) x
163โ focus :: m (Dynamic t Bool)
186+
164โ
187+-- | Filter mouse input events based on whether they target a particular region
165โinstance (Reflex t, Monad m) => HasFocus t (VtyWidget t m) where
188+-- and translate them to the internal coordinate system of that region.
166โ focus = VtyWidget . lift $ asks _vtyWidgetCtx_focus
189+--
167โ
190+-- NB: Non-mouse events are passed through unfiltered and unchanged
168โ-- | A class for widgets that can produce images to draw to the display
191+mouseInRegion :: Region -> VtyEvent -> Maybe VtyEvent
169โclass (Reflex t, Monad m) => ImageWriter t m | m -> t where
192+mouseInRegion (Region l t w h) e = case e of
170โ tellImages :: Behavior t [Image] -> m ()
193+ V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
171โ
194+ V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
172โinstance (Reflex t, Monad m) => ImageWriter t (VtyWidget t m) where
195+ _ -> Just e
173โ tellImages imgs = VtyWidget $ tell (mempty { _vtyWidgetOut_images = imgs })
196+ where
175โ-- | A class for things that can shut down the vty application
198+ | or [ x < l
176โclass (Reflex t, Monad m) => Shutdown t m where
199+ , y < t
177โ tellShutdown :: Event t () -> m ()
200+ , x >= l + w
201+ , y >= t + h ] = Nothing
203+ Just (con (x - l) (y - t))
205+-- | Filter mouse input outside the current display region and
206+-- all input if the region is not focused
208+ :: (HasDisplayRegion t m, HasFocusReader t m, HasInput t m)
209+ => m (Event t VtyEvent)
210+inputInFocusedRegion = do
212+ reg <- current <$> askRegion
213+ foc <- current <$> focus
214+ pure $ fmapMaybe id $ attachWith filterInput ((,) <$> reg <*> foc) inp
216+ filterInput (r, f) = \case
217+ V.EvKey {} | not f -> Nothing
218+ x -> mouseInRegion r x
179โinstance (Reflex t, Monad m) => Shutdown t (VtyWidget t m) where
220+-- * Getting and setting the display region
180โ tellShutdown sd = VtyWidget $ tell (mempty { _vtyWidgetOut_shutdown = sd })
182-- | A chunk of the display area
222-- | A chunk of the display area
183data Region = Region
223data Region = Region
@@ -188,283 +228,296 @@ data Region = Region
189 deriving (Show, Read, Eq, Ord)
229 deriving (Show, Read, Eq, Ord)
231+-- | A region that occupies no space.
233+nilRegion = Region 0 0 0 0
191-- | The width and height of a 'Region'
235-- | The width and height of a 'Region'
192regionSize :: Region -> (Int, Int)
236regionSize :: Region -> (Int, Int)
193regionSize (Region _ _ w h) = (w, h)
237regionSize (Region _ _ w h) = (w, h)
195โ-- | Low-level widget combinator that runs a child 'VtyWidget' within
239+-- | Produces an 'Image' that fills a region with space characters
196โ-- a given region and context. This widget filters and modifies the input
240+regionBlankImage :: V.Attr -> Region -> Image
197โ-- that the child widget receives such that:
241+regionBlankImage attr r@(Region _ _ width height) =
198โ-- * unfocused widgets receive no key events
242+ withinImage r $ V.charFill attr ' ' width height
199โ-- * mouse inputs outside the region are ignored
243+
200โ-- * mouse inputs inside the region have their coordinates translated such
244+-- | A class for things that know their own display size dimensions
201โ-- that (0,0) is the top-left corner of the region
245+class (Reflex t, Monad m) => HasDisplayRegion t m | m -> t where
202โpane
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)
255+-- | Retrieve the display width
256+displayWidth :: HasDisplayRegion t m => m (Dynamic t Int)
257+displayWidth = fmap _region_width <$> askRegion
259+-- | Retrieve the display height
260+displayHeight :: HasDisplayRegion t m => m (Dynamic t Int)
261+displayHeight = fmap _region_height <$> askRegion
263+instance HasDisplayRegion t m => HasDisplayRegion t (ReaderT x m)
264+instance HasDisplayRegion t m => HasDisplayRegion t (BehaviorWriterT t x m)
265+instance HasDisplayRegion t m => HasDisplayRegion t (DynamicWriterT t x m)
266+instance HasDisplayRegion t m => HasDisplayRegion t (EventWriterT t x m)
267+instance HasDisplayRegion t m => HasDisplayRegion t (NodeIdT m)
269+-- | A widget that has access to a particular region of the vty display
270+newtype DisplayRegion t m a = DisplayRegion
271+ { unDisplayRegion :: ReaderT (Dynamic t Region) m a }
283+instance (Monad m, Reflex t) => HasDisplayRegion t (DisplayRegion t m) where
284+ askRegion = DisplayRegion ask
285+ localRegion f = DisplayRegion . local f . unDisplayRegion
287+deriving instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (DisplayRegion t m)
288+deriving instance NotReady t m => NotReady t (DisplayRegion t m)
289+deriving instance PerformEvent t m => PerformEvent t (DisplayRegion t m)
290+deriving instance PostBuild t m => PostBuild t (DisplayRegion t m)
291+deriving instance TriggerEvent t m => TriggerEvent t (DisplayRegion t m)
292+instance HasImageWriter t m => HasImageWriter t (DisplayRegion t m)
293+instance HasFocusReader t m => HasFocusReader t (DisplayRegion t m)
295+instance (Adjustable t m, MonadFix m, MonadHold t m) => Adjustable t (DisplayRegion t m) where
296+ runWithReplace (DisplayRegion a) e = DisplayRegion $ runWithReplace a $ fmap unDisplayRegion e
297+ traverseIntMapWithKeyWithAdjust f m e = DisplayRegion $ traverseIntMapWithKeyWithAdjust (\k v -> unDisplayRegion $ f k v) m e
298+ traverseDMapWithKeyWithAdjust f m e = DisplayRegion $ traverseDMapWithKeyWithAdjust (\k v -> unDisplayRegion $ f k v) m e
299+ traverseDMapWithKeyWithAdjustWithMove f m e = DisplayRegion $ traverseDMapWithKeyWithAdjustWithMove (\k v -> unDisplayRegion $ f k v) m e
301+instance MonadTrans (DisplayRegion t) where
302+ lift = DisplayRegion . lift
304+instance MFunctor (DisplayRegion t) where
305+ hoist f = DisplayRegion . hoist f . unDisplayRegion
307+instance MonadNodeId m => MonadNodeId (DisplayRegion t m)
309+-- | Run a 'DisplayRegion' action with a given 'Region'
203 :: (Reflex t, Monad m)
311 :: (Reflex t, Monad m)
204โ => Dynamic t Region -- ^ Region into which we should draw the widget (in coordinates relative to our own)
312+ => Dynamic t Region
205โ -> Dynamic t Bool -- ^ Whether the widget should be focused when the parent is.
313+ -> DisplayRegion t m a
206โ -> VtyWidget t m a
314+ -> m a
207โ -> VtyWidget t m a
315+runDisplayRegion r = flip runReaderT r . unDisplayRegion
208โpane reg foc child = VtyWidget $ do
316+
209โ ctx <- lift ask
317+-- * Getting focus state
210โ let ctx' = VtyWidgetCtx
318+
211โ { _vtyWidgetCtx_input = leftmost -- TODO: think about this leftmost more.
319+-- | A class for things that can dynamically gain and lose focus
212โ [ fmapMaybe id $
320+class (Reflex t, Monad m) => HasFocusReader t m | m -> t where
213โ attachWith (\(r,f) e -> filterInput r f e)
321+ focus :: m (Dynamic t Bool)
214โ (liftA2 (,) (current reg) (current foc))
322+ default focus :: (f m' ~ m, Monad m', MonadTrans f, HasFocusReader t m') => m (Dynamic t Bool)
215โ (_vtyWidgetCtx_input ctx)
323+ focus = lift focus
216โ ]
324+ localFocus :: (Dynamic t Bool -> Dynamic t Bool) -> m a -> m a
217โ , _vtyWidgetCtx_focus = liftA2 (&&) (_vtyWidgetCtx_focus ctx) foc
325+ default localFocus :: (f m' ~ m, Monad m', MFunctor f, HasFocusReader t m') => (Dynamic t Bool -> Dynamic t Bool) -> m a -> m a
218โ , _vtyWidgetCtx_size = fmap regionSize reg }
326+ localFocus f = hoist (localFocus f)
219โ (result, wo) <- lift . lift $ runVtyWidget ctx' child
327+
220โ let images = _vtyWidgetOut_images wo
328+instance HasFocusReader t m => HasFocusReader t (ReaderT x m)
221โ images' = liftA2 (\r is -> map (withinImage r) is) (current reg) images
329+instance HasFocusReader t m => HasFocusReader t (BehaviorWriterT t x m)
222โ wo' = wo { _vtyWidgetOut_images = images' }
330+instance HasFocusReader t m => HasFocusReader t (DynamicWriterT t x m)
223โ tell wo'
331+instance HasFocusReader t m => HasFocusReader t (EventWriterT t x m)
224โ return result
332+instance HasFocusReader t m => HasFocusReader t (NodeIdT m)
226โ filterInput :: Region -> Bool -> VtyEvent -> Maybe VtyEvent
334+-- | A widget that has access to information about whether it is focused
227โ filterInput (Region l t w h) focused e = case e of
335+newtype FocusReader t m a = FocusReader
228โ V.EvKey _ _ | not focused -> Nothing
336+ { unFocusReader :: ReaderT (Dynamic t Bool) m a }
229โ V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
337+ deriving
230โ V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
338+ ( Functor
231โ _ -> Just e
339+ , Applicative
233โ mouse con x y
341+ , MonadFix
234โ | or [ x < l
342+ , MonadHold t
235โ , y < t
343+ , MonadIO
236โ , x >= l + w
344+ , MonadRef
237โ , y >= t + h ] = Nothing
345+ , MonadSample t
238โ | otherwise =
346+ )
239โ Just (con (x - l) (y - t))
347+
240โ
348+instance (Monad m, Reflex t) => HasFocusReader t (FocusReader t m) where
241โ-- | Information about a drag operation
349+ focus = FocusReader ask
242โdata Drag = Drag
350+ localFocus f = FocusReader . local f . unFocusReader
243โ { _drag_from :: (Int, Int) -- ^ Where the drag began
351+
244โ , _drag_to :: (Int, Int) -- ^ Where the mouse currently is
352+deriving instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (FocusReader t m)
245โ , _drag_button :: V.Button -- ^ Which mouse button is dragging
353+deriving instance NotReady t m => NotReady t (FocusReader t m)
246โ , _drag_modifiers :: [V.Modifier] -- ^ What modifiers are held
354+deriving instance PerformEvent t m => PerformEvent t (FocusReader t m)
247โ , _drag_end :: Bool -- ^ Whether the drag ended (the mouse button was released)
355+deriving instance PostBuild t m => PostBuild t (FocusReader t m)
248โ }
356+deriving instance TriggerEvent t m => TriggerEvent t (FocusReader t m)
249โ deriving (Eq, Ord, Show)
357+instance HasImageWriter t m => HasImageWriter t (FocusReader t m)
251โ-- | Converts raw vty mouse drag events into an event stream of 'Drag's
359+instance (Adjustable t m, MonadFix m, MonadHold t m) => Adjustable t (FocusReader t m) where
252โdrag
360+ runWithReplace (FocusReader a) e = FocusReader $ runWithReplace a $ fmap unFocusReader e
253โ :: (Reflex t, MonadFix m, MonadHold t m)
361+ traverseIntMapWithKeyWithAdjust f m e = FocusReader $ traverseIntMapWithKeyWithAdjust (\k v -> unFocusReader $ f k v) m e
254โ => V.Button
362+ traverseDMapWithKeyWithAdjust f m e = FocusReader $ traverseDMapWithKeyWithAdjust (\k v -> unFocusReader $ f k v) m e
255โ -> VtyWidget t m (Event t Drag)
363+ traverseDMapWithKeyWithAdjustWithMove f m e = FocusReader $ traverseDMapWithKeyWithAdjustWithMove (\k v -> unFocusReader $ f k v) m e
257โ inp <- input
365+instance MonadTrans (FocusReader t) where
258โ let f :: Maybe Drag -> V.Event -> Maybe Drag
366+ lift = FocusReader . lift
259โ f Nothing = const Nothing
367+
260โ f (Just (Drag from _ _ mods end)) = \case
368+instance MFunctor (FocusReader t) where
261โ V.EvMouseDown x y btn' mods'
369+ hoist f = FocusReader . hoist f . unFocusReader
262โ | end -> Just $ Drag (x,y) (x,y) btn' mods' False
370+
263โ | btn == btn' -> Just $ Drag from (x,y) btn mods' False
371+instance MonadNodeId m => MonadNodeId (FocusReader t m)
264โ | otherwise -> Nothing -- Ignore other buttons.
372+
265โ V.EvMouseUp x y (Just btn')
373+-- | Run a 'FocusReader' action with the given focus value
266โ | end -> Nothing
374+runFocusReader
267โ | btn == btn' -> Just $ Drag from (x,y) btn mods True
268โ | otherwise -> Nothing
269โ V.EvMouseUp x y Nothing -- Terminal doesn't specify mouse up button,
270โ -- assume it's the right one.
272โ | otherwise -> Just $ Drag from (x,y) btn mods True
274โ rec let newDrag = attachWithMaybe f (current dragD) inp
275โ dragD <- holdDyn Nothing $ Just <$> newDrag
276โ return (fmapMaybe id $ updated dragD)
278โ-- | Mouse down events for a particular mouse button
280 :: (Reflex t, Monad m)
375 :: (Reflex t, Monad m)
281โ => V.Button
376+ => Dynamic t Bool
282โ -> VtyWidget t m (Event t VtyEvent)
377+ -> FocusReader t m a
283โmouseDown btn = do
378+ -> m a
284โ i <- input
379+runFocusReader b = flip runReaderT b . unFocusReader
285โ return $ fforMaybe i $ \x -> case x of
286โ V.EvMouseDown _ _ btn' _ -> if btn == btn' then Just x else Nothing
289โ-- | A plain split of the available space into vertically stacked panes.
381+-- * "Image" output
290โ-- No visual separator is built in here.
291โsplitV :: (Reflex t, Monad m)
292โ => Dynamic t (Int -> Int)
293โ -- ^ Function used to determine size of first pane based on available size
294โ -> Dynamic t (Bool, Bool)
295โ -- ^ How to focus the two sub-panes, given that we are focused.
296โ -> VtyWidget t m a
297โ -- ^ Widget for first pane
298โ -> VtyWidget t m b
299โ -- ^ Widget for second pane
300โ -> VtyWidget t m (a,b)
301โsplitV sizeFunD focD wA wB = do
303โ let regA = (\f (w,h) -> Region 0 0 w (f h)) <$> sizeFunD <*> sz
304โ regB = (\(w,h) (Region _ _ _ hA) -> Region 0 hA w (h - hA)) <$> sz <*> regA
305โ ra <- pane regA (fst <$> focD) wA
306โ rb <- pane regB (snd <$> focD) wB
309โ-- | A split of the available space into two parts with a draggable separator.
310โ-- Starts with half the space allocated to each, and the first pane has focus.
311โ-- Clicking in a pane switches focus.
312โsplitVDrag :: (Reflex t, MonadFix m, MonadHold t m)
313โ => VtyWidget t m ()
314โ -> VtyWidget t m a
315โ -> VtyWidget t m b
316โ -> VtyWidget t m (a,b)
317โsplitVDrag wS wA wB = do
319โ (_, h0) <- sample $ current sz
320โ dragE <- drag V.BLeft
321โ let splitter0 = h0 `div` 2
322โ rec splitterCheckpoint <- holdDyn splitter0 $ leftmost [fst <$> ffilter snd dragSplitter, resizeSplitter]
323โ splitterPos <- holdDyn splitter0 $ leftmost [fst <$> dragSplitter, resizeSplitter]
324โ splitterFrac <- holdDyn ((1::Double) / 2) $ ffor (attach (current sz) (fst <$> dragSplitter)) $ \((_,h),x) ->
325โ fromIntegral x / fromIntegral h
326โ let dragSplitter = fforMaybe (attach (current splitterCheckpoint) dragE) $
327โ \(splitterY, Drag (_, fromY) (_, toY) _ _ end) ->
328โ if splitterY == fromY then Just (toY, end) else Nothing
329โ regA = (\(w,_) sp -> Region 0 0 w sp) <$> sz <*> splitterPos
330โ regS = (\(w,_) sp -> Region 0 sp w 1) <$> sz <*> splitterPos
331โ regB = (\(w,h) sp -> Region 0 (sp + 1) w (h - sp - 1)) <$> sz <*> splitterPos
332โ resizeSplitter = ffor (attach (current splitterFrac) (updated sz)) $
333โ \(frac, (_,h)) -> round (frac * fromIntegral h)
334โ focA <- holdDyn True $ leftmost
338โ (mA, rA) <- pane regA focA $ withMouseDown wA
339โ pane regS (pure False) wS
340โ (mB, rB) <- pane regB (not <$> focA) $ withMouseDown wB
343โ withMouseDown x = do
344โ m <- mouseDown V.BLeft
348โ-- | Fill the background with a particular character.
349โfill :: (Reflex t, Monad m) => Char -> VtyWidget t m ()
352โ let fillImg = ffor (current sz) $ \(w,h) -> [V.charFill V.defAttr c w h]
353โ tellImages fillImg
355โ-- | Fill the background with the bottom
356โhRule :: (Reflex t, Monad m) => BoxStyle -> VtyWidget t m ()
357โhRule boxStyle = fill (_boxStyle_s boxStyle)
359โ-- | Transform the images produces by a widget
361โ :: (Reflex t, MonadHold t m, MonadFix m)
362โ => Behavior t ([Image] -> [Image])
363โ -> VtyWidget t m a
364โ -> VtyWidget t m a
365โmodifyImages f (VtyWidget w) = VtyWidget $ flip censor w $ \wo ->
366โ wo { _vtyWidgetOut_images = f <*> (_vtyWidgetOut_images wo) }
368โ-- | Defines a set of symbols to use to draw the outlines of boxes
369โ-- C.f. https://en.wikipedia.org/wiki/Box-drawing_character
370โdata BoxStyle = BoxStyle
371โ { _boxStyle_nw :: Char
372โ , _boxStyle_n :: Char
373โ , _boxStyle_ne :: Char
374โ , _boxStyle_e :: Char
375โ , _boxStyle_se :: Char
376โ , _boxStyle_s :: Char
377โ , _boxStyle_sw :: Char
378โ , _boxStyle_w :: Char
381โinstance Default BoxStyle where
383+-- | A class for widgets that can produce images to draw to the display
382โ def = singleBoxStyle
384+class (Reflex t, Monad m) => HasImageWriter t m | m -> t where
383โ
385+ -- | Send images upstream for rendering
384โ-- | A box style that uses hyphens and pipe characters. Doesn't handle
386+ tellImages :: Behavior t [Image] -> m ()
385โ-- corners very well.
387+ default tellImages :: (f m' ~ m, Monad m', MonadTrans f, HasImageWriter t m') => Behavior t [Image] -> m ()
386โhyphenBoxStyle :: BoxStyle
388+ tellImages = lift . tellImages
387โhyphenBoxStyle = BoxStyle '-' '-' '-' '|' '-' '-' '-' '|'
389+ -- | Apply a transformation to the images produced by the child actions
388โ
390+ mapImages :: (Behavior t [Image] -> Behavior t [Image]) -> m a -> m a
389โ-- | A single line box style
391+ default mapImages :: (f m' ~ m, Monad m', MFunctor f, HasImageWriter t m') => (Behavior t [Image] -> Behavior t [Image]) -> m a -> m a
390โsingleBoxStyle :: BoxStyle
392+ mapImages f = hoist (mapImages f)
391โsingleBoxStyle = BoxStyle 'โ' 'โ' 'โ' 'โ' 'โ' 'โ' 'โ' 'โ'
393+
392โ
394+-- | A widget that can produce images to draw onto the display
393โ-- | A thick single line box style
395+newtype ImageWriter t m a = ImageWriter
394โthickBoxStyle :: BoxStyle
396+ { unImageWriter :: BehaviorWriterT t [Image] m a }
395โthickBoxStyle = BoxStyle 'โ' 'โ' 'โ' 'โ' 'โ' 'โ' 'โ' 'โ'
397+ deriving
397โ-- | A double line box style
399+ , Applicative
398โdoubleBoxStyle :: BoxStyle
400+ , Monad
399โdoubleBoxStyle = BoxStyle 'โ' 'โ' 'โ' 'โ' 'โ' 'โ' 'โ' 'โ'
401+ , MonadFix
401โ-- | A single line box style with rounded corners
403+ , MonadIO
402โroundedBoxStyle :: BoxStyle
404+ , MonadRef
403โroundedBoxStyle = BoxStyle 'โญ' 'โ' 'โฎ' 'โ' 'โฏ' 'โ' 'โฐ' 'โ'
405+ , MonadReflexCreateTrigger t
404โ
406+ , MonadSample t
405โ-- | Draws a box in the provided style and a child widget inside of that box
407+ , NotReady t
406โbox :: (Monad m, Reflex t)
408+ , PerformEvent t
407โ => BoxStyle
409+ , PostBuild t
408โ -> VtyWidget t m a
410+ , TriggerEvent t
409โ -> VtyWidget t m a
411+ )
410โbox style child = do
412+
411โ sz <- displaySize
413+instance MonadTrans (ImageWriter t) where
412โ let boxReg = ffor (current sz) $ \(w,h) -> Region 0 0 w h
414+ lift = ImageWriter . lift
413โ innerReg = ffor sz $ \(w,h) -> Region 1 1 (w - 2) (h - 2)
415+
414โ tellImages (fmap boxImages boxReg)
416+instance MFunctor (ImageWriter t) where
415โ tellImages (fmap (\r -> [regionBlankImage r]) (current innerReg))
417+ hoist f = ImageWriter . (hoist f) . unImageWriter
416โ pane innerReg (pure True) child
418+
417โ where
419+instance (Adjustable t m, MonadFix m, MonadHold t m) => Adjustable t (ImageWriter t m) where
418โ boxImages :: Region -> [Image]
420+ runWithReplace (ImageWriter a) e = ImageWriter $ runWithReplace a $ fmap unImageWriter e
419โ boxImages (Region left top width height) =
421+ traverseIntMapWithKeyWithAdjust f m e = ImageWriter $ traverseIntMapWithKeyWithAdjust (\k v -> unImageWriter $ f k v) m e
420โ let right = left + width - 1
422+ traverseDMapWithKeyWithAdjust f m e = ImageWriter $ traverseDMapWithKeyWithAdjust (\k v -> unImageWriter $ f k v) m e
421โ bottom = top + height - 1
423+ traverseDMapWithKeyWithAdjustWithMove f m e = ImageWriter $ traverseDMapWithKeyWithAdjustWithMove (\k v -> unImageWriter $ f k v) m e
423โ [ withinImage (Region (left + 1) top (width - 2) 1) $
425+instance HasImageWriter t m => HasImageWriter t (ReaderT x m)
424โ V.charFill V.defAttr (_boxStyle_n style) (width - 2) 1
426+instance HasImageWriter t m => HasImageWriter t (BehaviorWriterT t x m)
425โ , withinImage (Region right (top + 1) 1 (height - 2)) $
427+instance HasImageWriter t m => HasImageWriter t (DynamicWriterT t x m)
426โ V.charFill V.defAttr (_boxStyle_e style) 1 (height - 2)
428+instance HasImageWriter t m => HasImageWriter t (EventWriterT t x m)
427โ , withinImage (Region (left + 1) bottom (width - 2) 1) $
429+instance HasImageWriter t m => HasImageWriter t (NodeIdT m)
428โ V.charFill V.defAttr (_boxStyle_s style) (width - 2) 1
430+
429โ , withinImage (Region left (top + 1) 1 (height - 2)) $
431+instance (Monad m, Reflex t) => HasImageWriter t (ImageWriter t m) where
430โ V.charFill V.defAttr (_boxStyle_w style) 1 (height - 2)
432+ tellImages = ImageWriter . tellBehavior
431โ ]
433+ mapImages f (ImageWriter x) = ImageWriter $ do
432โ corners =
434+ (a, images) <- lift $ runBehaviorWriterT x
433โ [ withinImage (Region left top 1 1) $
435+ tellBehavior $ f images
434โ V.char V.defAttr (_boxStyle_nw style)
436+ pure a
435โ , withinImage (Region right top 1 1) $
437+
436โ V.char V.defAttr (_boxStyle_ne style)
438+instance HasDisplayRegion t m => HasDisplayRegion t (ImageWriter t m)
437โ , withinImage (Region right bottom 1 1) $
439+instance HasFocusReader t m => HasFocusReader t (ImageWriter t m)
438โ V.char V.defAttr (_boxStyle_se style)
440+
439โ , withinImage (Region left bottom 1 1) $
441+-- | Run a widget that can produce images
440โ V.char V.defAttr (_boxStyle_sw style)
442+runImageWriter
442โ in sides ++ if width > 1 && height > 1 then corners else []
444โ-- | Renders text, wrapped to the container width
446 :: (Reflex t, Monad m)
443 :: (Reflex t, Monad m)
447โ => Behavior t Text
444+ => ImageWriter t m a
448โ -> VtyWidget t m ()
445+ -> m (a, Behavior t [Image])
449โtext msg = do
446+runImageWriter = runBehaviorWriterT . unImageWriter
450โ dw <- displayWidth
447+
451โ let img = (\w s -> [wrapText w V.defAttr s]) <$> current dw <*> msg
448+-- * Theming
452โ tellImages img
449+
453โ where
450+-- | A class for things that can be visually styled
454โ wrapText maxWidth attrs = V.vertCat
451+class (Reflex t, Monad m) => HasTheme t m | m -> t where
455โ . concatMap (fmap (V.string attrs . T.unpack) . TZ.wrapWithOffset maxWidth 0)
452+ theme :: m (Behavior t V.Attr)
456โ . T.split (=='\n')
453+ default theme :: (f m' ~ m, Monad m', MonadTrans f, HasTheme t m') => m (Behavior t V.Attr)
455+ localTheme :: (Behavior t V.Attr -> Behavior t V.Attr) -> m a -> m a
456+ default localTheme :: (f m' ~ m, Monad m', MFunctor f, HasTheme t m') => (Behavior t V.Attr -> Behavior t V.Attr) -> m a -> m a
457+ localTheme f = hoist (localTheme f)
459+instance HasTheme t m => HasTheme t (ReaderT x m)
460+instance HasTheme t m => HasTheme t (BehaviorWriterT t x m)
461+instance HasTheme t m => HasTheme t (DynamicWriterT t x m)
462+instance HasTheme t m => HasTheme t (EventWriterT t x m)
463+instance HasTheme t m => HasTheme t (NodeIdT m)
464+instance HasTheme t m => HasTheme t (Input t m)
465+instance HasTheme t m => HasTheme t (ImageWriter t m)
466+instance HasTheme t m => HasTheme t (DisplayRegion t m)
467+instance HasTheme t m => HasTheme t (FocusReader t m)
469+-- | A widget that has access to theme information
470+newtype ThemeReader t m a = ThemeReader
471+ { unThemeReader :: ReaderT (Behavior t V.Attr) m a }
483+instance (Monad m, Reflex t) => HasTheme t (ThemeReader t m) where
484+ theme = ThemeReader ask
485+ localTheme f = ThemeReader . local f . unThemeReader
487+deriving instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (ThemeReader t m)
488+deriving instance NotReady t m => NotReady t (ThemeReader t m)
489+deriving instance PerformEvent t m => PerformEvent t (ThemeReader t m)
490+deriving instance PostBuild t m => PostBuild t (ThemeReader t m)
491+deriving instance TriggerEvent t m => TriggerEvent t (ThemeReader t m)
492+instance HasImageWriter t m => HasImageWriter t (ThemeReader t m)
494+instance (Adjustable t m, MonadFix m, MonadHold t m) => Adjustable t (ThemeReader t m) where
495+ runWithReplace (ThemeReader a) e = ThemeReader $ runWithReplace a $ fmap unThemeReader e
496+ traverseIntMapWithKeyWithAdjust f m e = ThemeReader $ traverseIntMapWithKeyWithAdjust (\k v -> unThemeReader $ f k v) m e
497+ traverseDMapWithKeyWithAdjust f m e = ThemeReader $ traverseDMapWithKeyWithAdjust (\k v -> unThemeReader $ f k v) m e
498+ traverseDMapWithKeyWithAdjustWithMove f m e = ThemeReader $ traverseDMapWithKeyWithAdjustWithMove (\k v -> unThemeReader $ f k v) m e
500+instance MonadTrans (ThemeReader t) where
501+ lift = ThemeReader . lift
503+instance MFunctor (ThemeReader t) where
504+ hoist f = ThemeReader . hoist f . unThemeReader
506+instance MonadNodeId m => MonadNodeId (ThemeReader t m)
508+-- | Run a 'ThemeReader' action with the given focus value
510+ :: (Reflex t, Monad m)
511+ => Behavior t V.Attr
512+ -> ThemeReader t m a
514+runThemeReader b = flip runReaderT b . unThemeReader
459โ :: (Reflex t, Monad m, Show a)
461โ -> VtyWidget t m ()
462โdisplay a = text $ T.pack . show <$> a
464โregionBlankImage :: Region -> Image
517+-- ** Manipulating images
465โregionBlankImage r@(Region _ _ width height) =
466โ withinImage r $ V.charFill V.defAttr ' ' width height
519+-- | Translates and crops an 'Image' so that it is contained by
520+-- the given 'Region'.
468withinImage
521withinImage
469 :: Region
522 :: Region
@@ -472,3 +525,37 @@ withinImage
472withinImage (Region left top width height)
525withinImage (Region left top width height)
473 | width < 0 || height < 0 = withinImage (Region left top 0 0)
526 | width < 0 || height < 0 = withinImage (Region left top 0 0)
474 | otherwise = V.translate left top . V.crop width height
527 | otherwise = V.translate left top . V.crop width height
529+-- | Crop a behavior of images to a behavior of regions. See 'withinImage'.
532+ => Behavior t Region
533+ -> Behavior t [Image]
534+ -> Behavior t [Image]
535+imagesInRegion reg = liftA2 (\r is -> map (withinImage r) is) reg
537+-- * Running sub-widgets
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
547+ :: (Reflex t, Monad m, HasInput t m, HasImageWriter t m, HasDisplayRegion t m, HasFocusReader t m)
549+ -> Dynamic t Bool -- ^ Whether the widget should be focused when the parent is.
552+pane dr foc child = localRegion (const dr) $
553+ mapImages (imagesInRegion $ current dr) $
554+ localFocus (const foc) $
555+ inputInFocusedRegion >>= \e -> localInput (const e) child
559+-- | A widget that draws nothing
560+blank :: Monad m => m ()