@@ -1,42 +1,113 @@
1−{-|
1+{-# LANGUAGE FlexibleContexts #-}
2−Module: Reflex.Vty.Widget
2+{-# LANGUAGE FlexibleInstances #-}
3−Description: Basic set of widgets and building blocks for reflex-vty applications
3+{-# LANGUAGE FunctionalDependencies #-}
4−-}
4+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5−{-# Language UndecidableInstances #-}
5+{-# LANGUAGE LambdaCase #-}
6−
6+{-# LANGUAGE MultiParamTypeClasses #-}
7+{-# LANGUAGE OverloadedStrings #-}
8+{-# LANGUAGE RankNTypes #-}
9+{-# LANGUAGE RecursiveDo #-}
10+{-# LANGUAGE TypeFamilies #-}
7−module Reflex.Vty.Widget where
11+module Reflex.Vty.Widget
17+ , mainWidgetWithHandle
9import Control.Applicative (liftA2)
47import Control.Applicative (liftA2)
10import Control.Monad.Fix (MonadFix)
48import Control.Monad.Fix (MonadFix)
11−import Control.Monad.IO.Class (MonadIO)
49+import Control.Monad.Trans (lift)
12−import Control.Monad.Morph
50+import Control.Monad.Trans.Reader (ReaderT, runReaderT, asks, ask)
13−import Control.Monad.NodeId
14−import Control.Monad.Reader (ReaderT, ask, local, runReaderT)
15−import Control.Monad.Ref
51+import Control.Monad.Trans.Writer (WriterT, runWriterT, censor, tell)
16−import Control.Monad.Trans (MonadTrans, lift)
52+import Data.Default
53+import Data.Text (Text)
17−import Data.Set (Set)
54+import qualified Data.Text as T
18−import qualified Data.Set as Set
55+import qualified Data.Text.Zipper as TZ
19import Graphics.Vty (Image)
56import Graphics.Vty (Image)
20import qualified Graphics.Vty as V
57import qualified Graphics.Vty as V
21import Reflex
58import Reflex
22−import Reflex.Class ()
59+
23−import Reflex.Host.Class (MonadReflexCreateTrigger)
24import Reflex.Vty.Host
60import Reflex.Vty.Host
26−-- * Running a vty application
62+-- | The context within which a 'VtyWidget' runs
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
104+ -> m (a, VtyWidgetOut t)
105+runVtyWidget ctx w = runReaderT (runWriterT (unVtyWidget w)) ctx
28−-- | Sets up the top-level context for a vty widget and runs it with that context
107+-- | Sets up the top-level context for a 'VtyWidget' and runs it with that context
29mainWidgetWithHandle
108mainWidgetWithHandle
32− ( MonadVtyApp t m
110+ -> (forall t m. MonadVtyApp t m => VtyWidget t m ())
35− , HasDisplayRegion t m
41mainWidgetWithHandle vty child =
112mainWidgetWithHandle vty child =
42 runVtyAppWithHandle vty $ \dr0 inp -> do
113 runVtyAppWithHandle vty $ \dr0 inp -> do
@@ -46,178 +117,67 @@ mainWidgetWithHandle vty child =
46 let inp' = fforMaybe inp $ \case
117 let inp' = fforMaybe inp $ \case
47 V.EvResize {} -> Nothing
118 V.EvResize {} -> Nothing
48 x -> Just x
119 x -> Just x
49− (shutdown, images) <- runThemeReader (constant V.defAttr) $
120+ let ctx = VtyWidgetCtx
50− runFocusReader (pure True) $
121+ { _vtyWidgetCtx_size = size
51− runDisplayRegion (fmap (\(w, h) -> Region 0 0 w h) size) $
122+ , _vtyWidgetCtx_input = inp'
52− runImageWriter $
123+ , _vtyWidgetCtx_focus = constDyn True
54− runInput inp' $ do
125+ ((), wo) <- runVtyWidget ctx child
55− tellImages . ffor (current size) $ \(w, h) -> [V.charFill V.defAttr ' ' w h]
57 return $ VtyResult
126 return $ VtyResult
58− { _vtyResult_picture = fmap (V.picForLayers . reverse) images
127+ { _vtyResult_picture = fmap (V.picForLayers . reverse) (_vtyWidgetOut_images wo)
59− , _vtyResult_shutdown = shutdown
128+ , _vtyResult_shutdown = _vtyWidgetOut_shutdown wo
62−-- | The output of a vty widget
63−data VtyWidgetOut t = VtyWidgetOut
64− { _vtyWidgetOut_shutdown :: Event t ()
67-- | Like 'mainWidgetWithHandle', but uses a default vty configuration
131-- | Like 'mainWidgetWithHandle', but uses a default vty configuration
68mainWidget
132mainWidget
70− ( MonadVtyApp t m
133+ :: (forall t m. MonadVtyApp t m => VtyWidget t m ())
73− , HasDisplayRegion t m
79mainWidget child = do
135mainWidget child = do
80 vty <- getDefaultVty
136 vty <- getDefaultVty
81 mainWidgetWithHandle vty child
137 mainWidgetWithHandle vty child
83−-- * Input Events
139+-- | A class for things that know their own display size dimensions
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
85-- | A class for things that can receive vty events as input
154-- | A class for things that can receive vty events as input
86−class HasInput t m | m -> t where
155+class HasVtyInput t m | m -> t where
87 input :: m (Event t VtyEvent)
156 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
181−-- | Filter the keyboard input that a child widget may receive
158+instance (Reflex t, Monad m) => HasVtyInput t (VtyWidget t m) where
182−filterKeys :: (Reflex t, HasInput t m) => (KeyCombo -> Bool) -> m a -> m a
159+ input = VtyWidget . lift $ asks _vtyWidgetCtx_input
183−filterKeys f x = localInput (ffilter (\case
160+
184− V.EvKey k mods -> f (k, mods)
161+-- | A class for things that can dynamically gain and lose focus
185− _ -> True)) x
162+class HasFocus t m | m -> t where
186−
163+ focus :: m (Dynamic t Bool)
187−-- | Filter mouse input events based on whether they target a particular region
188−-- and translate them to the internal coordinate system of that region.
190−-- NB: Non-mouse events are passed through unfiltered and unchanged
191−mouseInRegion :: Region -> VtyEvent -> Maybe VtyEvent
192−mouseInRegion (Region l t w h) e = case e of
193− V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
194− V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
201− , y >= t + h ] = Nothing
203− Just (con (x - l) (y - t))
205−-- | Filter mouse input outside the current display region and
206−-- all input if the region is not focused
208− :: (HasDisplayRegion t m, HasFocusReader t m, HasInput t m)
209− => m (Event t VtyEvent)
210−inputInFocusedRegion = do
212− reg <- current <$> askRegion
213− foc <- current <$> focus
214− pure $ fmapMaybe id $ attachWith filterInput ((,) <$> reg <*> foc) inp
216− filterInput (r, f) = \case
217− V.EvKey {} | not f -> Nothing
218− x -> mouseInRegion r x
220−-- * Getting and setting the display region
165+instance (Reflex t, Monad m) => HasFocus t (VtyWidget t m) where
166+ focus = VtyWidget . lift $ asks _vtyWidgetCtx_focus
168+-- | A class for widgets that can produce images to draw to the display
169+class (Reflex t, Monad m) => ImageWriter t m | m -> t where
170+ tellImages :: Behavior t [Image] -> m ()
172+instance (Reflex t, Monad m) => ImageWriter t (VtyWidget t m) where
173+ tellImages imgs = VtyWidget $ tell (mempty { _vtyWidgetOut_images = imgs })
175+-- | A class for things that can shut down the vty application
176+class (Reflex t, Monad m) => Shutdown t m where
177+ tellShutdown :: Event t () -> m ()
179+instance (Reflex t, Monad m) => Shutdown t (VtyWidget t m) where
180+ tellShutdown sd = VtyWidget $ tell (mempty { _vtyWidgetOut_shutdown = sd })
222-- | A chunk of the display area
182-- | A chunk of the display area
223data Region = Region
183data Region = Region
@@ -228,296 +188,283 @@ data Region = Region
229 deriving (Show, Read, Eq, Ord)
189 deriving (Show, Read, Eq, Ord)
231−-- | A region that occupies no space.
233−nilRegion = Region 0 0 0 0
235-- | The width and height of a 'Region'
191-- | The width and height of a 'Region'
236regionSize :: Region -> (Int, Int)
192regionSize :: Region -> (Int, Int)
237regionSize (Region _ _ w h) = (w, h)
193regionSize (Region _ _ w h) = (w, h)
239−-- | Produces an 'Image' that fills a region with space characters
195+-- | Low-level widget combinator that runs a child 'VtyWidget' within
240−regionBlankImage :: V.Attr -> Region -> Image
196+-- a given region and context. This widget filters and modifies the input
241−regionBlankImage attr r@(Region _ _ width height) =
197+-- that the child widget receives such that:
242− withinImage r $ V.charFill attr ' ' width height
198+-- * unfocused widgets receive no key events
243−
199+-- * mouse inputs outside the region are ignored
244−-- | A class for things that know their own display size dimensions
200+-- * mouse inputs inside the region have their coordinates translated such
245−class (Reflex t, Monad m) => HasDisplayRegion t m | m -> t where
201+-- that (0,0) is the top-left corner of the region
246− -- | Retrieve the display region
202+pane
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'
311 :: (Reflex t, Monad m)
203 :: (Reflex t, Monad m)
312− => Dynamic t Region
204+ => Dynamic t Region -- ^ Region into which we should draw the widget (in coordinates relative to our own)
313− -> DisplayRegion t m a
205+ -> Dynamic t Bool -- ^ Whether the widget should be focused when the parent is.
314− -> m a
206+ -> VtyWidget t m a
315−runDisplayRegion r = flip runReaderT r . unDisplayRegion
207+ -> VtyWidget t m a
316−
208+pane reg foc child = VtyWidget $ do
317−-- * Getting focus state
209+ ctx <- lift ask
318−
210+ let ctx' = VtyWidgetCtx
319−-- | A class for things that can dynamically gain and lose focus
211+ { _vtyWidgetCtx_input = leftmost -- TODO: think about this leftmost more.
320−class (Reflex t, Monad m) => HasFocusReader t m | m -> t where
212+ [ fmapMaybe id $
321− focus :: m (Dynamic t Bool)
213+ attachWith (\(r,f) e -> filterInput r f e)
322− default focus :: (f m' ~ m, Monad m', MonadTrans f, HasFocusReader t m') => m (Dynamic t Bool)
214+ (liftA2 (,) (current reg) (current foc))
323− focus = lift focus
215+ (_vtyWidgetCtx_input ctx)
324− localFocus :: (Dynamic t Bool -> Dynamic t Bool) -> m a -> m a
216+ ]
325− default localFocus :: (f m' ~ m, Monad m', MFunctor f, HasFocusReader t m') => (Dynamic t Bool -> Dynamic t Bool) -> m a -> m a
217+ , _vtyWidgetCtx_focus = liftA2 (&&) (_vtyWidgetCtx_focus ctx) foc
326− localFocus f = hoist (localFocus f)
218+ , _vtyWidgetCtx_size = fmap regionSize reg }
327−
219+ (result, wo) <- lift . lift $ runVtyWidget ctx' child
328−instance HasFocusReader t m => HasFocusReader t (ReaderT x m)
220+ let images = _vtyWidgetOut_images wo
329−instance HasFocusReader t m => HasFocusReader t (BehaviorWriterT t x m)
221+ images' = liftA2 (\r is -> map (withinImage r) is) (current reg) images
330−instance HasFocusReader t m => HasFocusReader t (DynamicWriterT t x m)
222+ wo' = wo { _vtyWidgetOut_images = images' }
331−instance HasFocusReader t m => HasFocusReader t (EventWriterT t x m)
223+ tell wo'
332−instance HasFocusReader t m => HasFocusReader t (NodeIdT m)
224+ return result
334−-- | A widget that has access to information about whether it is focused
226+ filterInput :: Region -> Bool -> VtyEvent -> Maybe VtyEvent
335−newtype FocusReader t m a = FocusReader
227+ filterInput (Region l t w h) focused e = case e of
336− { unFocusReader :: ReaderT (Dynamic t Bool) m a }
228+ V.EvKey _ _ | not focused -> Nothing
337− deriving
229+ V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
338− ( Functor
230+ V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
339− , Applicative
231+ _ -> Just e
341− , MonadFix
233+ mouse con x y
342− , MonadHold t
234+ | or [ x < l
343− , MonadIO
235+ , y < t
344− , MonadRef
236+ , x >= l + w
345− , MonadSample t
237+ , y >= t + h ] = Nothing
347−
239+ Just (con (x - l) (y - t))
348−instance (Monad m, Reflex t) => HasFocusReader t (FocusReader t m) where
240+
349− focus = FocusReader ask
241+-- | Information about a drag operation
350− localFocus f = FocusReader . local f . unFocusReader
242+data Drag = Drag
351−
243+ { _drag_from :: (Int, Int) -- ^ Where the drag began
352−deriving instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (FocusReader t m)
244+ , _drag_to :: (Int, Int) -- ^ Where the mouse currently is
353−deriving instance NotReady t m => NotReady t (FocusReader t m)
245+ , _drag_button :: V.Button -- ^ Which mouse button is dragging
354−deriving instance PerformEvent t m => PerformEvent t (FocusReader t m)
246+ , _drag_modifiers :: [V.Modifier] -- ^ What modifiers are held
355−deriving instance PostBuild t m => PostBuild t (FocusReader t m)
247+ , _drag_end :: Bool -- ^ Whether the drag ended (the mouse button was released)
356−deriving instance TriggerEvent t m => TriggerEvent t (FocusReader t m)
248+ }
357−instance HasImageWriter t m => HasImageWriter t (FocusReader t m)
249+ deriving (Eq, Ord, Show)
359−instance (Adjustable t m, MonadFix m, MonadHold t m) => Adjustable t (FocusReader t m) where
251+-- | Converts raw vty mouse drag events into an event stream of 'Drag's
360− runWithReplace (FocusReader a) e = FocusReader $ runWithReplace a $ fmap unFocusReader e
252+drag
361− traverseIntMapWithKeyWithAdjust f m e = FocusReader $ traverseIntMapWithKeyWithAdjust (\k v -> unFocusReader $ f k v) m e
253+ :: (Reflex t, MonadFix m, MonadHold t m)
362− traverseDMapWithKeyWithAdjust f m e = FocusReader $ traverseDMapWithKeyWithAdjust (\k v -> unFocusReader $ f k v) m e
254+ => V.Button
363− traverseDMapWithKeyWithAdjustWithMove f m e = FocusReader $ traverseDMapWithKeyWithAdjustWithMove (\k v -> unFocusReader $ f k v) m e
255+ -> VtyWidget t m (Event t Drag)
365−instance MonadTrans (FocusReader t) where
257+ inp <- input
366− lift = FocusReader . lift
258+ let f :: Maybe Drag -> V.Event -> Maybe Drag
367−
259+ f Nothing = const Nothing
368−instance MFunctor (FocusReader t) where
260+ f (Just (Drag from _ _ mods end)) = \case
369− hoist f = FocusReader . hoist f . unFocusReader
261+ V.EvMouseDown x y btn' mods'
370−
262+ | end -> Just $ Drag (x,y) (x,y) btn' mods' False
371−instance MonadNodeId m => MonadNodeId (FocusReader t m)
263+ | btn == btn' -> Just $ Drag from (x,y) btn mods' False
372−
264+ | otherwise -> Nothing -- Ignore other buttons.
373−-- | Run a 'FocusReader' action with the given focus value
265+ V.EvMouseUp x y (Just btn')
374−runFocusReader
266+ | end -> Nothing
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
375 :: (Reflex t, Monad m)
280 :: (Reflex t, Monad m)
376− => Dynamic t Bool
281+ => V.Button
377− -> FocusReader t m a
282+ -> VtyWidget t m (Event t VtyEvent)
378− -> m a
283+mouseDown btn = do
379−runFocusReader b = flip runReaderT b . unFocusReader
284+ i <- input
285+ return $ fforMaybe i $ \x -> case x of
286+ V.EvMouseDown _ _ btn' _ -> if btn == btn' then Just x else Nothing
381−-- * "Image" output
289+-- | A plain split of the available space into vertically stacked panes.
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.
297+ -- ^ Widget for first pane
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)
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]
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])
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
383−-- | A class for widgets that can produce images to draw to the display
381+instance Default BoxStyle where
384−class (Reflex t, Monad m) => HasImageWriter t m | m -> t where
382+ def = singleBoxStyle
385− -- | Send images upstream for rendering
383+
386− tellImages :: Behavior t [Image] -> m ()
384+-- | A box style that uses hyphens and pipe characters. Doesn't handle
387− default tellImages :: (f m' ~ m, Monad m', MonadTrans f, HasImageWriter t m') => Behavior t [Image] -> m ()
385+-- corners very well.
388− tellImages = lift . tellImages
386+hyphenBoxStyle :: BoxStyle
389− -- | Apply a transformation to the images produced by the child actions
387+hyphenBoxStyle = BoxStyle '-' '-' '-' '|' '-' '-' '-' '|'
390− mapImages :: (Behavior t [Image] -> Behavior t [Image]) -> m a -> m a
388+
391− default mapImages :: (f m' ~ m, Monad m', MFunctor f, HasImageWriter t m') => (Behavior t [Image] -> Behavior t [Image]) -> m a -> m a
389+-- | A single line box style
392− mapImages f = hoist (mapImages f)
390+singleBoxStyle :: BoxStyle
393−
391+singleBoxStyle = BoxStyle '┌' '─' '┐' '│' '┘' '─' '└' '│'
394−-- | A widget that can produce images to draw onto the display
392+
395−newtype ImageWriter t m a = ImageWriter
393+-- | A thick single line box style
396− { unImageWriter :: BehaviorWriterT t [Image] m a }
394+thickBoxStyle :: BoxStyle
397− deriving
395+thickBoxStyle = BoxStyle '┏' '━' '┓' '┃' '┛' '━' '┗' '┃'
399− , Applicative
397+-- | A double line box style
400− , Monad
398+doubleBoxStyle :: BoxStyle
401− , MonadFix
399+doubleBoxStyle = BoxStyle '╔' '═' '╗' '║' '╝' '═' '╚' '║'
403− , MonadIO
401+-- | A single line box style with rounded corners
404− , MonadRef
402+roundedBoxStyle :: BoxStyle
405− , MonadReflexCreateTrigger t
403+roundedBoxStyle = BoxStyle '╭' '─' '╮' '│' '╯' '─' '╰' '│'
407− , NotReady t
405+-- | Draws a box in the provided style and a child widget inside of that box
408− , PerformEvent t
406+box :: (Monad m, Reflex t)
409− , PostBuild t
407+ => BoxStyle
410− , TriggerEvent t
408+ -> VtyWidget t m a
411− )
409+ -> VtyWidget t m a
412−
410+box style child = do
413−instance MonadTrans (ImageWriter t) where
411+ sz <- displaySize
414− lift = ImageWriter . lift
412+ let boxReg = ffor (current sz) $ \(w,h) -> Region 0 0 w h
415−
413+ innerReg = ffor sz $ \(w,h) -> Region 1 1 (w - 2) (h - 2)
416−instance MFunctor (ImageWriter t) where
414+ tellImages (fmap boxImages boxReg)
417− hoist f = ImageWriter . (hoist f) . unImageWriter
415+ tellImages (fmap (\r -> [regionBlankImage r]) (current innerReg))
418−
416+ pane innerReg (pure True) child
419−instance (Adjustable t m, MonadFix m, MonadHold t m) => Adjustable t (ImageWriter t m) where
417+ where
420− runWithReplace (ImageWriter a) e = ImageWriter $ runWithReplace a $ fmap unImageWriter e
418+ boxImages :: Region -> [Image]
421− traverseIntMapWithKeyWithAdjust f m e = ImageWriter $ traverseIntMapWithKeyWithAdjust (\k v -> unImageWriter $ f k v) m e
419+ boxImages (Region left top width height) =
422− traverseDMapWithKeyWithAdjust f m e = ImageWriter $ traverseDMapWithKeyWithAdjust (\k v -> unImageWriter $ f k v) m e
420+ let right = left + width - 1
423− traverseDMapWithKeyWithAdjustWithMove f m e = ImageWriter $ traverseDMapWithKeyWithAdjustWithMove (\k v -> unImageWriter $ f k v) m e
421+ bottom = top + height - 1
425−instance HasImageWriter t m => HasImageWriter t (ReaderT x m)
423+ [ withinImage (Region (left + 1) top (width - 2) 1) $
426−instance HasImageWriter t m => HasImageWriter t (BehaviorWriterT t x m)
424+ V.charFill V.defAttr (_boxStyle_n style) (width - 2) 1
427−instance HasImageWriter t m => HasImageWriter t (DynamicWriterT t x m)
425+ , withinImage (Region right (top + 1) 1 (height - 2)) $
428−instance HasImageWriter t m => HasImageWriter t (EventWriterT t x m)
426+ V.charFill V.defAttr (_boxStyle_e style) 1 (height - 2)
429−instance HasImageWriter t m => HasImageWriter t (NodeIdT m)
427+ , withinImage (Region (left + 1) bottom (width - 2) 1) $
430−
428+ V.charFill V.defAttr (_boxStyle_s style) (width - 2) 1
431−instance (Monad m, Reflex t) => HasImageWriter t (ImageWriter t m) where
429+ , withinImage (Region left (top + 1) 1 (height - 2)) $
432− tellImages = ImageWriter . tellBehavior
430+ V.charFill V.defAttr (_boxStyle_w style) 1 (height - 2)
433− mapImages f (ImageWriter x) = ImageWriter $ do
431+ ]
434− (a, images) <- lift $ runBehaviorWriterT x
432+ corners =
435− tellBehavior $ f images
433+ [ withinImage (Region left top 1 1) $
436− pure a
434+ V.char V.defAttr (_boxStyle_nw style)
437−
435+ , withinImage (Region right top 1 1) $
438−instance HasDisplayRegion t m => HasDisplayRegion t (ImageWriter t m)
436+ V.char V.defAttr (_boxStyle_ne style)
439−instance HasFocusReader t m => HasFocusReader t (ImageWriter t m)
437+ , withinImage (Region right bottom 1 1) $
440−
438+ V.char V.defAttr (_boxStyle_se style)
441−-- | Run a widget that can produce images
439+ , withinImage (Region left bottom 1 1) $
442−runImageWriter
440+ V.char V.defAttr (_boxStyle_sw style)
443− :: (Reflex t, Monad m)
441+ ]
444− => ImageWriter t m a
442+ in sides ++ if width > 1 && height > 1 then corners else []
445− -> m (a, Behavior t [Image])
443+
446−runImageWriter = runBehaviorWriterT . unImageWriter
444+-- | Renders text, wrapped to the container width
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)
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)
446 :: (Reflex t, Monad m)
511− => Behavior t V.Attr
447+ => Behavior t Text
512− -> ThemeReader t m a
448+ -> VtyWidget t m ()
513− -> m a
449+text msg = do
514−runThemeReader b = flip runReaderT b . unThemeReader
450+ dw <- displayWidth
451+ let img = (\w s -> [wrapText w V.defAttr s]) <$> current dw <*> msg
454+ wrapText maxWidth attrs = V.vertCat
455+ . concatMap (fmap (V.string attrs . T.unpack) . TZ.wrapWithOffset maxWidth 0)
459+ :: (Reflex t, Monad m, Show a)
462+display a = text $ T.pack . show <$> a
517−-- ** Manipulating images
464+regionBlankImage :: Region -> Image
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'.
521withinImage
468withinImage
522 :: Region
469 :: Region
@@ -525,37 +472,3 @@ withinImage
525withinImage (Region left top width height)
472withinImage (Region left top width height)
526 | width < 0 || height < 0 = withinImage (Region left top 0 0)
473 | width < 0 || height < 0 = withinImage (Region left top 0 0)
527 | otherwise = V.translate left top . V.crop width height
474 | 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 ()