@@ -1,43 +1,115 @@
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
47+ , TextInputConfig(..)
9import Control.Applicative (liftA2)
53import Control.Applicative (liftA2)
10import Control.Monad.Fix (MonadFix)
54import Control.Monad.Fix (MonadFix)
11−import Control.Monad.IO.Class (MonadIO)
55+import Control.Monad.Trans (lift)
12−import Control.Monad.Morph
56+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
57+import Control.Monad.Trans.Writer (WriterT, runWriterT, censor, tell)
16−import Control.Monad.Trans (MonadTrans, lift)
17−import Data.Set (Set)
58+import Data.Default
59+import Data.Text (Text)
18−import qualified Data.Set as Set
60+import qualified Data.Text as T
19−import Graphics.Vty (Image)
61+import Graphics.Vty (Image, Attr)
20import qualified Graphics.Vty as V
62import qualified Graphics.Vty as V
21import Reflex
63import Reflex
22−import Reflex.Class ()
64+
23−import Reflex.Host.Class (MonadReflexCreateTrigger)
24import Reflex.Vty.Host
65import Reflex.Vty.Host
66+import Reflex.Vty.Widget.Text (TextZipper(..), DisplayLines(..))
67+import qualified Reflex.Vty.Widget.Text as TZ
69+-- | The context within which a 'VtyWidget' runs
70+data VtyWidgetCtx t = VtyWidgetCtx
71+ { _vtyWidgetCtx_size :: Dynamic t (Int,Int)
72+ -- ^ The width and height of the region allocated to the widget.
73+ , _vtyWidgetCtx_focus :: Dynamic t Bool
74+ -- ^ Whether the widget should behave as if it has focus for keyboard input.
75+ , _vtyWidgetCtx_input :: Event t VtyEvent
76+ -- ^ User input events that the widget's parent chooses to share. These will generally
77+ -- be filtered for relevance:
78+ -- * Keyboard inputs are restricted to focused widgets
79+ -- * Mouse inputs are restricted to the region in which the widget resides and are
80+ -- translated into its internal coordinates.
83+-- | The output of a 'VtyWidget'
84+data VtyWidgetOut t = VtyWidgetOut
85+ { _vtyWidgetOut_images :: Behavior t [Image]
86+ -- ^ The visual output of the 'VtyWidget'
87+ , _vtyWidgetOut_shutdown :: Event t ()
90+instance Reflex t => Semigroup (VtyWidgetOut t) where
91+ wo <> wo' = VtyWidgetOut
92+ { _vtyWidgetOut_images = _vtyWidgetOut_images wo <> _vtyWidgetOut_images wo'
93+ , _vtyWidgetOut_shutdown = _vtyWidgetOut_shutdown wo <> _vtyWidgetOut_shutdown wo'
96+instance (Reflex t) => Monoid (VtyWidgetOut t) where
97+ mempty = VtyWidgetOut mempty mempty
98+ mappend wo wo' = wo <> wo'
26−-- * Running a vty application
100+newtype VtyWidget t m a = VtyWidget { unVtyWidget :: WriterT (VtyWidgetOut t) (ReaderT (VtyWidgetCtx t) m) a }
27−
101+ deriving (Functor, Applicative, Monad, MonadSample t, MonadHold t, MonadFix)
103+-- | Runs a 'VtyWidget' with a given context
108+ -> m (a, VtyWidgetOut t)
109+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
111+-- | Sets up the top-level context for a 'VtyWidget' and runs it with that context
29−mainWidgetWithHandle
112+mainWidgetWithHandle :: V.Vty -> (forall t m. MonadVtyApp t m => VtyWidget t m ()) -> IO ()
35− , HasDisplayRegion t m
41mainWidgetWithHandle vty child =
113mainWidgetWithHandle vty child =
42 runVtyAppWithHandle vty $ \dr0 inp -> do
114 runVtyAppWithHandle vty $ \dr0 inp -> do
43 size <- holdDyn dr0 $ fforMaybe inp $ \case
115 size <- holdDyn dr0 $ fforMaybe inp $ \case
@@ -46,180 +118,59 @@ mainWidgetWithHandle vty child =
46 let inp' = fforMaybe inp $ \case
118 let inp' = fforMaybe inp $ \case
47 V.EvResize {} -> Nothing
119 V.EvResize {} -> Nothing
48 x -> Just x
120 x -> Just x
49− (shutdown, images) <- runThemeReader (constant V.defAttr) $
121+ let ctx = VtyWidgetCtx
50− runFocusReader (pure True) $
122+ { _vtyWidgetCtx_size = size
51− runDisplayRegion (fmap (\(w, h) -> Region 0 0 w h) size) $
123+ , _vtyWidgetCtx_input = inp'
52− runImageWriter $
124+ , _vtyWidgetCtx_focus = constDyn True
54− runInput inp' $ do
126+ ((), wo) <- runVtyWidget ctx child
55− tellImages . ffor (current size) $ \(w, h) -> [V.charFill V.defAttr ' ' w h]
57 return $ VtyResult
127 return $ VtyResult
58− { _vtyResult_picture = fmap (V.picForLayers . reverse) images
128+ { _vtyResult_picture = fmap (V.picForLayers . reverse) (_vtyWidgetOut_images wo)
59− , _vtyResult_shutdown = shutdown
129+ , _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
132-- | Like 'mainWidgetWithHandle', but uses a default vty configuration
70− ( MonadVtyApp t m
133+mainWidget :: (forall t m. MonadVtyApp t m => VtyWidget t m ()) -> IO ()
73− , HasDisplayRegion t m
79mainWidget child = do
134mainWidget child = do
80 vty <- getDefaultVty
135 vty <- getDefaultVty
81 mainWidgetWithHandle vty child
136 mainWidgetWithHandle vty child
83−-- * Input Events
138+class (Reflex t, Monad m) => HasDisplaySize t m | m -> t where
139+ displaySize :: m (Dynamic t (Int, Int))
141+instance (Reflex t, Monad m) => HasDisplaySize t (VtyWidget t m) where
142+ displaySize = VtyWidget . lift $ asks _vtyWidgetCtx_size
85−-- | A class for things that can receive vty events as input
144+displayWidth :: HasDisplaySize t m => m (Dynamic t Int)
145+displayWidth = fmap fst <$> displaySize
147+displayHeight :: HasDisplaySize t m => m (Dynamic t Int)
148+displayHeight = fmap snd <$> displaySize
86−class HasInput t m | m -> t where
150+class HasVtyInput t m | m -> t where
87 input :: m (Event t VtyEvent)
151 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
153+instance (Reflex t, Monad m) => HasVtyInput t (VtyWidget t m) where
182−filterKeys :: (Reflex t, HasInput t m) => (KeyCombo -> Bool) -> m a -> m a
154+ input = VtyWidget . lift $ asks _vtyWidgetCtx_input
183−filterKeys f x = localInput (ffilter (\case
155+
184− V.EvKey k mods -> f (k, mods)
156+class HasFocus t m | m -> t where
185− _ -> True)) x
157+ focus :: m (Dynamic t Bool)
187−-- | Filter mouse input events based on whether they target a particular region
159+instance (Reflex t, Monad m) => HasFocus t (VtyWidget t m) where
188−-- and translate them to the internal coordinate system of that region.
160+ focus = VtyWidget . lift $ asks _vtyWidgetCtx_focus
190−-- NB: Non-mouse events are passed through unfiltered and unchanged
162+class (Reflex t, Monad m) => ImageWriter t m | m -> t where
191−mouseInRegion :: Region -> VtyEvent -> Maybe VtyEvent
163+ tellImages :: Behavior t [Image] -> m ()
192−mouseInRegion (Region l t w h) e = case e of
164+
193− V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
165+instance (Reflex t, Monad m) => ImageWriter t (VtyWidget t m) where
194− V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
166+ tellImages imgs = VtyWidget $ tell (mempty { _vtyWidgetOut_images = imgs })
196− where
168+class (Reflex t, Monad m) => Shutdown t m where
197− mouse con x y
169+ tellShutdown :: Event t () -> m ()
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
171+instance (Reflex t, Monad m) => Shutdown t (VtyWidget t m) where
172+ tellShutdown sd = VtyWidget $ tell (mempty { _vtyWidgetOut_shutdown = sd })
222−-- | A chunk of the display area
223data Region = Region
174data Region = Region
224 { _region_left :: Int
175 { _region_left :: Int
225 , _region_top :: Int
176 , _region_top :: Int
@@ -228,334 +179,318 @@ data Region = Region
229 deriving (Show, Read, Eq, Ord)
180 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'
236regionSize :: Region -> (Int, Int)
182regionSize :: Region -> (Int, Int)
237regionSize (Region _ _ w h) = (w, h)
183regionSize (Region _ _ w h) = (w, h)
239−-- | Produces an 'Image' that fills a region with space characters
185+pane
240−regionBlankImage :: V.Attr -> Region -> Image
241−regionBlankImage attr r@(Region _ _ width height) =
242− withinImage r $ V.charFill attr ' ' width height
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)
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)
186 :: (Reflex t, Monad m)
312− => Dynamic t Region
187+ => Dynamic t Region -- ^ Region into which we should draw the widget (in coordinates relative to our own)
313− -> DisplayRegion t m a
188+ -> Dynamic t Bool -- ^ Whether the widget should be focused when the parent is.
314− -> m a
189+ -> VtyWidget t m a
315−runDisplayRegion r = flip runReaderT r . unDisplayRegion
190+ -> VtyWidget t m a
316−
191+pane reg foc child = VtyWidget $ do
317−-- * Getting focus state
192+ ctx <- lift ask
193+ let ctx' = VtyWidgetCtx
194+ { _vtyWidgetCtx_input = leftmost -- TODO: think about this leftmost more.
196+ attachWith (\(r,f) e -> filterInput r f e)
197+ (liftA2 (,) (current reg) (current foc))
198+ (_vtyWidgetCtx_input ctx)
200+ , _vtyWidgetCtx_focus = liftA2 (&&) (_vtyWidgetCtx_focus ctx) foc
201+ , _vtyWidgetCtx_size = fmap regionSize reg }
202+ (result, wo) <- lift . lift $ runVtyWidget ctx' child
203+ let images = _vtyWidgetOut_images wo
204+ images' = liftA2 (\r is -> map (withinImage r) is) (current reg) images
205+ wo' = wo { _vtyWidgetOut_images = images' }
209+ -- Filters input such that:
210+ -- * unfocused widgets receive no key events
211+ -- * mouse inputs outside the region are ignored
212+ -- * mouse inputs inside the region have their coordinates translated
213+ -- such that (0,0) is the top-left corner of the region
214+ filterInput :: Region -> Bool -> VtyEvent -> Maybe VtyEvent
215+ filterInput (Region l t w h) focused e = case e of
216+ V.EvKey _ _ | not focused -> Nothing
217+ V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
218+ V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
225+ , y >= t + h ] = Nothing
227+ Just (con (x - l) (y - t))
230+ { _drag_from :: (Int, Int) -- ^ Where the drag began
231+ , _drag_to :: (Int, Int) -- ^ Where the mouse currently is
232+ , _drag_button :: V.Button -- ^ Which mouse button is dragging
233+ , _drag_modifiers :: [V.Modifier] -- ^ What modifiers are held
234+ , _drag_end :: Bool -- ^ Whether the drag ended (the mouse button was released)
236+ deriving (Eq, Ord, Show)
319−-- | A class for things that can dynamically gain and lose focus
238+drag
320−class (Reflex t, Monad m) => HasFocusReader t m | m -> t where
239+ :: (Reflex t, MonadFix m, MonadHold t m)
321− focus :: m (Dynamic t Bool)
240+ => V.Button
322− default focus :: (f m' ~ m, Monad m', MonadTrans f, HasFocusReader t m') => m (Dynamic t Bool)
241+ -> VtyWidget t m (Event t Drag)
323− focus = lift focus
242+drag btn = do
324− localFocus :: (Dynamic t Bool -> Dynamic t Bool) -> m a -> m a
243+ inp <- input
325− default localFocus :: (f m' ~ m, Monad m', MFunctor f, HasFocusReader t m') => (Dynamic t Bool -> Dynamic t Bool) -> m a -> m a
244+ let f :: Drag -> V.Event -> Maybe Drag
326− localFocus f = hoist (localFocus f)
245+ f (Drag from _ _ mods end) = \case
327−
246+ V.EvMouseDown x y btn' mods'
328−instance HasFocusReader t m => HasFocusReader t (ReaderT x m)
247+ | end -> Just $ Drag (x,y) (x,y) btn' mods' False
329−instance HasFocusReader t m => HasFocusReader t (BehaviorWriterT t x m)
248+ | btn == btn' -> Just $ Drag from (x,y) btn mods' False
330−instance HasFocusReader t m => HasFocusReader t (DynamicWriterT t x m)
249+ | otherwise -> Nothing -- Ignore other buttons.
331−instance HasFocusReader t m => HasFocusReader t (EventWriterT t x m)
250+ V.EvMouseUp x y (Just btn')
332−instance HasFocusReader t m => HasFocusReader t (NodeIdT m)
251+ | end -> Nothing
333−
252+ | btn == btn' -> Just $ Drag from (x,y) btn mods True
334−-- | A widget that has access to information about whether it is focused
253+ | otherwise -> Nothing
335−newtype FocusReader t m a = FocusReader
254+ V.EvMouseUp x y Nothing -- Terminal doesn't specify mouse up button,
336− { unFocusReader :: ReaderT (Dynamic t Bool) m a }
255+ -- assume it's the right one.
337− deriving
256+ | end -> Nothing
338− ( Functor
257+ | otherwise -> Just $ Drag from (x,y) btn mods True
339− , Applicative
258+ _ -> Nothing
340− , Monad
259+ rec let newDrag = attachWithMaybe f (current dragD) inp
341− , MonadFix
260+ dragD <- holdDyn (Drag (0,0) (0,0) btn [] True) -- gross, but ok because it'll never be produced.
342− , MonadHold t
261+ newDrag
343− , MonadIO
262+ return (updated dragD)
345− , MonadSample t
264+mouseDown
348−instance (Monad m, Reflex t) => HasFocusReader t (FocusReader t m) where
349− focus = FocusReader ask
350− localFocus f = FocusReader . local f . unFocusReader
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)
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
365−instance MonadTrans (FocusReader t) where
366− lift = FocusReader . lift
368−instance MFunctor (FocusReader t) where
369− hoist f = FocusReader . hoist f . unFocusReader
371−instance MonadNodeId m => MonadNodeId (FocusReader t m)
373−-- | Run a 'FocusReader' action with the given focus value
375 :: (Reflex t, Monad m)
265 :: (Reflex t, Monad m)
376− => Dynamic t Bool
266+ => V.Button
377− -> FocusReader t m a
267+ -> VtyWidget t m (Event t VtyEvent)
378− -> m a
268+mouseDown btn = do
379−runFocusReader b = flip runReaderT b . unFocusReader
269+ i <- input
270+ return $ fforMaybe i $ \x -> case x of
271+ V.EvMouseDown _ _ btn' _ -> if btn == btn' then Just x else Nothing
381−-- * "Image" output
274+-- | A plain split of the available space into vertically stacked panes.
275+-- No visual separator is built in here.
276+splitV :: (Reflex t, Monad m)
277+ => Dynamic t (Int -> Int)
278+ -- ^ Function used to determine size of first pane based on available size
279+ -> Dynamic t (Bool, Bool)
280+ -- ^ How to focus the two sub-panes, given that we are focused.
282+ -- ^ Widget for first pane
284+ -- ^ Widget for second pane
285+ -> VtyWidget t m (a,b)
286+splitV sizeFunD focD wA wB = do
288+ let regA = (\f (w,h) -> Region 0 0 w (f h)) <$> sizeFunD <*> sz
289+ regB = (\(w,h) (Region _ _ _ hA) -> Region 0 hA w (h - hA)) <$> sz <*> regA
290+ ra <- pane regA (fst <$> focD) wA
291+ rb <- pane regB (snd <$> focD) wB
294+-- | A split of the available space into two parts with a draggable separator.
295+-- Starts with half the space allocated to each, and the first pane has focus.
296+-- Clicking in a pane switches focus.
297+splitVDrag :: (Reflex t, MonadFix m, MonadHold t m)
301+ -> VtyWidget t m (a,b)
302+splitVDrag wS wA wB = do
304+ (_, h0) <- sample $ current sz
305+ dragE <- drag V.BLeft
306+ let splitter0 = h0 `div` 2
307+ rec splitterCheckpoint <- holdDyn splitter0 $ leftmost [fst <$> ffilter snd dragSplitter, resizeSplitter]
308+ splitterPos <- holdDyn splitter0 $ leftmost [fst <$> dragSplitter, resizeSplitter]
309+ splitterFrac <- holdDyn ((1::Double) / 2) $ ffor (attach (current sz) (fst <$> dragSplitter)) $ \((_,h),x) ->
310+ fromIntegral x / fromIntegral h
311+ let dragSplitter = fforMaybe (attach (current splitterCheckpoint) dragE) $
312+ \(splitterY, Drag (_, fromY) (_, toY) _ _ end) ->
313+ if splitterY == fromY then Just (toY, end) else Nothing
314+ regA = (\(w,_) sp -> Region 0 0 w sp) <$> sz <*> splitterPos
315+ regS = (\(w,_) sp -> Region 0 sp w 1) <$> sz <*> splitterPos
316+ regB = (\(w,h) sp -> Region 0 (sp + 1) w (h - sp - 1)) <$> sz <*> splitterPos
317+ resizeSplitter = ffor (attach (current splitterFrac) (updated sz)) $
318+ \(frac, (_,h)) -> round (frac * fromIntegral h)
319+ focA <- holdDyn True $ leftmost
323+ (mA, rA) <- pane regA focA $ withMouseDown wA
324+ pane regS (pure False) wS
325+ (mB, rB) <- pane regB (not <$> focA) $ withMouseDown wB
328+ withMouseDown x = do
329+ m <- mouseDown V.BLeft
333+-- | Fill the background with a particular character.
334+fill :: (Reflex t, Monad m) => Char -> VtyWidget t m ()
337+ let fillImg = ffor (current sz) $ \(w,h) -> [V.charFill V.defAttr c w h]
340+-- | Fill the background with the bottom
341+hRule :: (Reflex t, Monad m) => BoxStyle -> VtyWidget t m ()
342+hRule boxStyle = fill (_boxStyle_s boxStyle)
344+fractionSz :: Double -> Int -> Int
345+fractionSz x h = round (fromIntegral h * x)
348+ :: (Reflex t, MonadHold t m, MonadFix m)
349+ => Behavior t ([Image] -> [Image])
352+modifyImages f (VtyWidget w) = VtyWidget $ flip censor w $ \wo ->
353+ wo { _vtyWidgetOut_images = f <*> (_vtyWidgetOut_images wo) }
355+data BoxStyle = BoxStyle
356+ { _boxStyle_nw :: Char
357+ , _boxStyle_n :: Char
358+ , _boxStyle_ne :: Char
359+ , _boxStyle_e :: Char
360+ , _boxStyle_se :: Char
361+ , _boxStyle_s :: Char
362+ , _boxStyle_sw :: Char
363+ , _boxStyle_w :: Char
383−-- | A class for widgets that can produce images to draw to the display
384−class (Reflex t, Monad m) => HasImageWriter t m | m -> t where
385− -- | Send images upstream for rendering
386− tellImages :: Behavior t [Image] -> m ()
387− default tellImages :: (f m' ~ m, Monad m', MonadTrans f, HasImageWriter t m') => Behavior t [Image] -> m ()
388− tellImages = lift . tellImages
389− -- | Apply a transformation to the images produced by the child actions
390− mapImages :: (Behavior t [Image] -> Behavior t [Image]) -> m a -> m a
391− default mapImages :: (f m' ~ m, Monad m', MFunctor f, HasImageWriter t m') => (Behavior t [Image] -> Behavior t [Image]) -> m a -> m a
392− mapImages f = hoist (mapImages f)
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 }
405− , MonadReflexCreateTrigger t
413−instance MonadTrans (ImageWriter t) where
366+instance Default BoxStyle where
414− lift = ImageWriter . lift
367+ def = singleBoxStyle
416−instance MFunctor (ImageWriter t) where
417− hoist f = ImageWriter . (hoist f) . unImageWriter
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
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)
431−instance (Monad m, Reflex t) => HasImageWriter t (ImageWriter t m) where
432− tellImages = ImageWriter . tellBehavior
433− mapImages f (ImageWriter x) = ImageWriter $ do
434− (a, images) <- lift $ runBehaviorWriterT x
435− tellBehavior $ f images
438−instance HasDisplayRegion t m => HasDisplayRegion t (ImageWriter t m)
439−instance HasFocusReader t m => HasFocusReader t (ImageWriter t m)
441−-- | Run a widget that can produce images
443− :: (Reflex t, Monad m)
444− => ImageWriter t m a
445− -> m (a, Behavior t [Image])
446−runImageWriter = runBehaviorWriterT . unImageWriter
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)
511− => Behavior t V.Attr
512− -> ThemeReader t m a
514−runThemeReader b = flip runReaderT b . unThemeReader
369+hyphenBoxStyle :: BoxStyle
370+hyphenBoxStyle = BoxStyle '-' '-' '-' '|' '-' '-' '-' '|'
517−-- ** Manipulating images
372+singleBoxStyle :: BoxStyle
373+singleBoxStyle = BoxStyle '┌' '─' '┐' '│' '┘' '─' '└' '│'
519−-- | Translates and crops an 'Image' so that it is contained by
375+thickBoxStyle :: BoxStyle
520−-- the given 'Region'.
376+thickBoxStyle = BoxStyle '┏' '━' '┓' '┃' '┛' '━' '┗' '┃'
378+doubleBoxStyle :: BoxStyle
379+doubleBoxStyle = BoxStyle '╔' '═' '╗' '║' '╝' '═' '╚' '║'
381+roundedBoxStyle :: BoxStyle
382+roundedBoxStyle = BoxStyle '╭' '─' '╮' '│' '╯' '─' '╰' '│'
384+box :: (Monad m, Reflex t)
390+ let boxReg = ffor (current sz) $ \(w,h) -> Region 0 0 w h
391+ innerReg = ffor sz $ \(w,h) -> Region 1 1 (w - 2) (h - 2)
392+ tellImages (fmap boxImages boxReg)
393+ tellImages (fmap (\r -> [regionBlankImage r]) (current innerReg))
394+ pane innerReg (pure True) child
522− :: Region
396+ boxImages :: Region -> [Image]
523− -> Image
397+ boxImages (Region left top width height) =
524− -> Image
398+ let right = left + width - 1
399+ bottom = top + height - 1
401+ [ withinImage (Region (left + 1) top (width - 2) 1) $
402+ V.charFill V.defAttr (_boxStyle_n style) (width - 2) 1
403+ , withinImage (Region right (top + 1) 1 (height - 2)) $
404+ V.charFill V.defAttr (_boxStyle_e style) 1 (height - 2)
405+ , withinImage (Region (left + 1) bottom (width - 2) 1) $
406+ V.charFill V.defAttr (_boxStyle_s style) (width - 2) 1
407+ , withinImage (Region left (top + 1) 1 (height - 2)) $
408+ V.charFill V.defAttr (_boxStyle_w style) 1 (height - 2)
411+ [ withinImage (Region left top 1 1) $
412+ V.char V.defAttr (_boxStyle_nw style)
413+ , withinImage (Region right top 1 1) $
414+ V.char V.defAttr (_boxStyle_ne style)
415+ , withinImage (Region right bottom 1 1) $
416+ V.char V.defAttr (_boxStyle_se style)
417+ , withinImage (Region left bottom 1 1) $
418+ V.char V.defAttr (_boxStyle_sw style)
420+ in sides ++ if width > 1 && height > 1 then corners else []
422+text :: (Reflex t, Monad m) => Behavior t Text -> VtyWidget t m ()
425+ let img = (\w s -> [wrapText w V.defAttr s]) <$> current dw <*> msg
428+display :: (Reflex t, Monad m, Show a) => Behavior t a -> VtyWidget t m ()
429+display a = text $ T.pack . show <$> a
431+regionBlankImage :: Region -> Image
432+regionBlankImage r@(Region _ _ width height) =
433+ withinImage r $ V.charFill V.defAttr ' ' width height
435+withinImage :: Region -> Image -> Image
525withinImage (Region left top width height)
436withinImage (Region left top width height)
526 | width < 0 || height < 0 = withinImage (Region left top 0 0)
437 | width < 0 || height < 0 = withinImage (Region left top 0 0)
527 | otherwise = V.translate left top . V.crop width height
438 | otherwise = V.translate left top . V.crop width height
529−-- | Crop a behavior of images to a behavior of regions. See 'withinImage'.
440+wrapText :: Int -> Attr -> Text -> Image
530−imagesInRegion
441+wrapText maxWidth attrs = V.vertCat
531− :: Reflex t
442+ . concatMap (fmap (V.string attrs . T.unpack) . wrapWithOffset maxWidth 0)
532− => Behavior t Region
443+ . T.split (=='\n')
533− -> Behavior t [Image]
444+
534− -> Behavior t [Image]
445+wrapWithOffset :: Int -> Int -> Text -> [Text]
535−imagesInRegion reg = liftA2 (\r is -> map (withinImage r) is) reg
446+wrapWithOffset maxWidth _ _ | maxWidth <= 0 = []
536−
447+wrapWithOffset maxWidth n xs =
537−-- * Running sub-widgets
448+ let (firstLine, rest) = T.splitAt (maxWidth - n) xs
538−
449+ in firstLine : (fmap (T.take maxWidth) . takeWhile (not . T.null) . iterate (T.drop maxWidth) $ rest)
539−-- | Low-level widget combinator that runs a child widget within
450+
540−-- a given region and context. This widget filters and modifies the input
451+data TextInputConfig t = TextInputConfig
541−-- that the child widget receives such that:
452+ { _textInputConfig_initialValue :: TextZipper
542−-- * unfocused widgets receive no key events
453+ , _textInputConfig_modify :: Event t (TextZipper -> TextZipper)
543−-- * mouse inputs outside the region are ignored
454+ }
544−-- * mouse inputs inside the region have their coordinates translated such
455+
545−-- that (0,0) is the top-left corner of the region
456+instance Reflex t => Default (TextInputConfig t) where
546−pane
457+ def = TextInputConfig TZ.empty never
547− :: (Reflex t, Monad m, HasInput t m, HasImageWriter t m, HasDisplayRegion t m, HasFocusReader t m)
458+
548− => Dynamic t Region
459+textInput
549− -> Dynamic t Bool -- ^ Whether the widget should be focused when the parent is.
460+ :: (Reflex t, MonadHold t m, MonadFix m)
550− -> m a
461+ => TextInputConfig t
551− -> m a
462+ -> VtyWidget t m (Dynamic t Text)
552−pane dr foc child = localRegion (const dr) $
463+textInput cfg = do
553− mapImages (imagesInRegion $ current dr) $
464+ i <- input
554− localFocus (const foc) $
465+ v <- foldDyn ($) (_textInputConfig_initialValue cfg) $ mergeWith (.)
555− inputInFocusedRegion >>= \e -> localInput (const e) child
466+ [ TZ.updateTextZipper <$> i
556−
467+ , _textInputConfig_modify cfg
558−
469+ dw <- displayWidth
559−-- | A widget that draws nothing
470+ dh <- displayHeight
560−blank :: Monad m => m ()
471+ let rows = (\w s -> TZ.displayLines w s) <$> dw <*> v
472+ img = TZ.images . _displayLines_spans <$> rows
473+ y <- holdUniqDyn $ _displayLines_cursorY <$> rows
474+ let newScrollTop st (h, cursorY)
475+ | cursorY < st = cursorY
476+ | cursorY >= st + h = cursorY - h + 1
478+ rec let hy = attachWith newScrollTop (current scrollTop) $ updated $ zipDyn dh y
479+ scrollTop <- holdDyn 0 hy
480+ tellImages $ (\imgs st -> (:[]) . V.vertCat $ drop st imgs) <$> current img <*> current scrollTop
561−blank = return ()
481+ return $ TZ.value <$> v
484+ :: (Reflex t, MonadHold t m, MonadFix m)
485+ => TextInputConfig t
486+ -> VtyWidget t m (Dynamic t Text)
487+multilineTextInput cfg = do
490+ { _textInputConfig_modify = mergeWith (.)
491+ [ fforMaybe i $ \case
492+ V.EvKey V.KEnter [] -> Just $ TZ.insert "\n"
494+ , _textInputConfig_modify cfg