@@ -1,113 +1,43 @@
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(..)
48โ , multilineTextInput
52import Control.Applicative (liftA2)
9import Control.Applicative (liftA2)
53import Control.Monad.Fix (MonadFix)
10import Control.Monad.Fix (MonadFix)
54โimport Control.Monad.Trans (lift)
11+import Control.Monad.IO.Class (MonadIO)
55โimport Control.Monad.Trans.Reader (ReaderT, runReaderT, asks, ask)
12+import Control.Monad.Morph
56โimport Control.Monad.Trans.Writer (WriterT, runWriterT, censor, tell)
13+import Control.Monad.NodeId
57โimport Data.Char
14+import Control.Monad.Reader (ReaderT, ask, local, runReaderT)
58โimport Data.Default
15+import Control.Monad.Ref
59โimport Data.Maybe (fromMaybe)
16+import Control.Monad.Trans (MonadTrans, lift)
60โimport Data.Text (Text)
17+import Data.Set (Set)
61โimport qualified Data.Text as T
18+import qualified Data.Set as Set
62โimport Graphics.Vty (Image, Attr)
19+import Graphics.Vty (Image)
63import qualified Graphics.Vty as V
20import qualified Graphics.Vty as V
64import Reflex
21import Reflex
65โ
22+import Reflex.Class ()
23+import Reflex.Host.Class (MonadReflexCreateTrigger)
66import Reflex.Vty.Host
24import Reflex.Vty.Host
68โ-- | The context within which a 'VtyWidget' runs
26+-- * Running a vty application
69โdata VtyWidgetCtx t = VtyWidgetCtx
27+
70โ { _vtyWidgetCtx_size :: Dynamic t (Int,Int)
71โ -- ^ The width and height of the region allocated to the widget.
72โ , _vtyWidgetCtx_focus :: Dynamic t Bool
73โ -- ^ Whether the widget should behave as if it has focus for keyboard input.
74โ , _vtyWidgetCtx_input :: Event t VtyEvent
75โ -- ^ User input events that the widget's parent chooses to share. These will generally
76โ -- be filtered for relevance:
77โ -- * Keyboard inputs are restricted to focused widgets
78โ -- * Mouse inputs are restricted to the region in which the widget resides and are
79โ -- translated into its internal coordinates.
82โ-- | The output of a 'VtyWidget'
83โdata VtyWidgetOut t = VtyWidgetOut
84โ { _vtyWidgetOut_images :: Behavior t [Image]
85โ -- ^ The visual output of the 'VtyWidget'
86โ , _vtyWidgetOut_shutdown :: Event t ()
89โinstance Reflex t => Semigroup (VtyWidgetOut t) where
90โ wo <> wo' = VtyWidgetOut
91โ { _vtyWidgetOut_images = _vtyWidgetOut_images wo <> _vtyWidgetOut_images wo'
92โ , _vtyWidgetOut_shutdown = _vtyWidgetOut_shutdown wo <> _vtyWidgetOut_shutdown wo'
95โinstance (Reflex t) => Monoid (VtyWidgetOut t) where
96โ mempty = VtyWidgetOut mempty mempty
97โ mappend wo wo' = wo <> wo'
99โnewtype VtyWidget t m a = VtyWidget { unVtyWidget :: WriterT (VtyWidgetOut t) (ReaderT (VtyWidgetCtx t) m) a }
100โ deriving (Functor, Applicative, Monad, MonadSample t, MonadHold t, MonadFix)
102โ-- | Runs a 'VtyWidget' with a given context
103โrunVtyWidget :: (Reflex t)
105โ -> VtyWidget t m a
106โ -> m (a, VtyWidgetOut t)
107โrunVtyWidget ctx w = runReaderT (runWriterT (unVtyWidget w)) ctx
109โ-- | 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
110โmainWidgetWithHandle :: V.Vty -> (forall t m. MonadVtyApp t m => VtyWidget t m ()) -> IO ()
29+mainWidgetWithHandle
35+ , HasDisplayRegion t m
111mainWidgetWithHandle vty child =
41mainWidgetWithHandle vty child =
112 runVtyAppWithHandle vty $ \dr0 inp -> do
42 runVtyAppWithHandle vty $ \dr0 inp -> do
113 size <- holdDyn dr0 $ fforMaybe inp $ \case
43 size <- holdDyn dr0 $ fforMaybe inp $ \case
@@ -116,59 +46,180 @@ mainWidgetWithHandle vty child =
116 let inp' = fforMaybe inp $ \case
46 let inp' = fforMaybe inp $ \case
117 V.EvResize {} -> Nothing
47 V.EvResize {} -> Nothing
118 x -> Just x
48 x -> Just x
119โ let ctx = VtyWidgetCtx
49+ (shutdown, images) <- runThemeReader (constant V.defAttr) $
120โ { _vtyWidgetCtx_size = size
50+ runFocusReader (pure True) $
121โ , _vtyWidgetCtx_input = inp'
51+ runDisplayRegion (fmap (\(w, h) -> Region 0 0 w h) size) $
122โ , _vtyWidgetCtx_focus = constDyn True
52+ runImageWriter $
124โ ((), wo) <- runVtyWidget ctx child
54+ runInput inp' $ do
55+ tellImages . ffor (current size) $ \(w, h) -> [V.charFill V.defAttr ' ' w h]
125 return $ VtyResult
57 return $ VtyResult
126โ { _vtyResult_picture = fmap (V.picForLayers . reverse) (_vtyWidgetOut_images wo)
58+ { _vtyResult_picture = fmap (V.picForLayers . reverse) images
127โ , _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 ()
130-- | Like 'mainWidgetWithHandle', but uses a default vty configuration
67-- | Like 'mainWidgetWithHandle', but uses a default vty configuration
131โmainWidget :: (forall t m. MonadVtyApp t m => VtyWidget t m ()) -> IO ()
70+ ( MonadVtyApp t m
73+ , HasDisplayRegion t m
132mainWidget child = do
79mainWidget child = do
133 vty <- getDefaultVty
80 vty <- getDefaultVty
134 mainWidgetWithHandle vty child
81 mainWidgetWithHandle vty child
136โclass (Reflex t, Monad m) => HasDisplaySize t m | m -> t where
83+-- * Input Events
137โ displaySize :: m (Dynamic t (Int, Int))
139โinstance (Reflex t, Monad m) => HasDisplaySize t (VtyWidget t m) where
140โ displaySize = VtyWidget . lift $ asks _vtyWidgetCtx_size
142โdisplayWidth :: HasDisplaySize t m => m (Dynamic t Int)
143โdisplayWidth = fmap fst <$> displaySize
145โdisplayHeight :: HasDisplaySize t m => m (Dynamic t Int)
85+-- | A class for things that can receive vty events as input
146โdisplayHeight = fmap snd <$> displaySize
148โclass HasVtyInput t m | m -> t where
86+class HasInput t m | m -> t where
149 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
151โinstance (Reflex t, Monad m) => HasVtyInput t (VtyWidget t m) where
181+-- | Filter the keyboard input that a child widget may receive
152โ input = VtyWidget . lift $ asks _vtyWidgetCtx_input
182+filterKeys :: (Reflex t, HasInput t m) => (KeyCombo -> Bool) -> m a -> m a
153โ
183+filterKeys f x = localInput (ffilter (\case
154โclass HasFocus t m | m -> t where
184+ V.EvKey k mods -> f (k, mods)
155โ focus :: m (Dynamic t Bool)
185+ _ -> True)) x
157โinstance (Reflex t, Monad m) => HasFocus t (VtyWidget t m) where
187+-- | Filter mouse input events based on whether they target a particular region
158โ focus = VtyWidget . lift $ asks _vtyWidgetCtx_focus
188+-- and translate them to the internal coordinate system of that region.
160โclass (Reflex t, Monad m) => ImageWriter t m | m -> t where
190+-- NB: Non-mouse events are passed through unfiltered and unchanged
161โ tellImages :: Behavior t [Image] -> m ()
191+mouseInRegion :: Region -> VtyEvent -> Maybe VtyEvent
162โ
192+mouseInRegion (Region l t w h) e = case e of
163โinstance (Reflex t, Monad m) => ImageWriter t (VtyWidget t m) where
193+ V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
164โ tellImages imgs = VtyWidget $ tell (mempty { _vtyWidgetOut_images = imgs })
194+ V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
166โclass (Reflex t, Monad m) => Shutdown t m where
196+ where
167โ tellShutdown :: Event t () -> m ()
197+ mouse con 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
169โinstance (Reflex t, Monad m) => Shutdown t (VtyWidget t m) where
220+-- * Getting and setting the display region
170โ tellShutdown sd = VtyWidget $ tell (mempty { _vtyWidgetOut_shutdown = sd })
222+-- | A chunk of the display area
172data Region = Region
223data Region = Region
173 { _region_left :: Int
224 { _region_left :: Int
174 , _region_top :: Int
225 , _region_top :: Int
@@ -177,394 +228,334 @@ data Region = Region
178 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
235+-- | The width and height of a 'Region'
180regionSize :: Region -> (Int, Int)
236regionSize :: Region -> (Int, Int)
181regionSize (Region _ _ w h) = (w, h)
237regionSize (Region _ _ w h) = (w, h)
183โpane
239+-- | Produces an 'Image' that fills a region with space characters
240+regionBlankImage :: V.Attr -> Region -> Image
241+regionBlankImage attr r@(Region _ _ width height) =
242+ withinImage r $ V.charFill attr ' ' width height
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'
184 :: (Reflex t, Monad m)
311 :: (Reflex t, Monad m)
185โ => Dynamic t Region -- ^ Region into which we should draw the widget (in coordinates relative to our own)
312+ => Dynamic t Region
186โ -> Dynamic t Bool -- ^ Whether the widget should be focused when the parent is.
313+ -> DisplayRegion t m a
187โ -> VtyWidget t m a
314+ -> m a
188โ -> VtyWidget t m a
315+runDisplayRegion r = flip runReaderT r . unDisplayRegion
189โpane reg foc child = VtyWidget $ do
191โ let ctx' = VtyWidgetCtx
192โ { _vtyWidgetCtx_input = leftmost -- TODO: think about this leftmost more.
194โ attachWith (\(r,f) e -> filterInput r f e)
195โ (liftA2 (,) (current reg) (current foc))
196โ (_vtyWidgetCtx_input ctx)
198โ , _vtyWidgetCtx_focus = liftA2 (&&) (_vtyWidgetCtx_focus ctx) foc
199โ , _vtyWidgetCtx_size = fmap regionSize reg }
200โ (result, wo) <- lift . lift $ runVtyWidget ctx' child
201โ let images = _vtyWidgetOut_images wo
202โ images' = liftA2 (\r is -> map (withinImage r) is) (current reg) images
203โ wo' = wo { _vtyWidgetOut_images = images' }
207โ -- Filters input such that:
208โ -- * unfocused widgets receive no key events
209โ -- * mouse inputs outside the region are ignored
210โ -- * mouse inputs inside the region have their coordinates translated
211โ -- such that (0,0) is the top-left corner of the region
212โ filterInput :: Region -> Bool -> VtyEvent -> Maybe VtyEvent
213โ filterInput (Region l t w h) focused e = case e of
214โ V.EvKey _ _ | not focused -> Nothing
215โ V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
216โ V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
223โ , y >= t + h ] = Nothing
225โ Just (con (x - l) (y - t))
228โ { _drag_from :: (Int, Int) -- ^ Where the drag began
229โ , _drag_to :: (Int, Int) -- ^ Where the mouse currently is
230โ , _drag_button :: V.Button -- ^ Which mouse button is dragging
231โ , _drag_modifiers :: [V.Modifier] -- ^ What modifiers are held
232โ , _drag_end :: Bool -- ^ Whether the drag ended (the mouse button was released)
234โ deriving (Eq, Ord, Show)
236โdrag
317+-- * Getting focus state
237โ :: (Reflex t, MonadFix m, MonadHold t m)
239โ -> VtyWidget t m (Event t Drag)
242โ let f :: Drag -> V.Event -> Maybe Drag
243โ f (Drag from _ _ mods end) = \case
244โ V.EvMouseDown x y btn' mods'
245โ | end -> Just $ Drag (x,y) (x,y) btn' mods' False
246โ | btn == btn' -> Just $ Drag from (x,y) btn mods' False
247โ | otherwise -> Nothing -- Ignore other buttons.
248โ V.EvMouseUp x y (Just btn')
250โ | btn == btn' -> Just $ Drag from (x,y) btn mods True
251โ | otherwise -> Nothing
252โ V.EvMouseUp x y Nothing -- Terminal doesn't specify mouse up button,
253โ -- assume it's the right one.
255โ | otherwise -> Just $ Drag from (x,y) btn mods True
257โ rec let newDrag = attachWithMaybe f (current dragD) inp
258โ dragD <- holdDyn (Drag (0,0) (0,0) btn [] True) -- gross, but ok because it'll never be produced.
260โ return (updated dragD)
263โ :: (Reflex t, Monad m)
265โ -> VtyWidget t m (Event t VtyEvent)
268โ return $ fforMaybe i $ \x -> case x of
269โ V.EvMouseDown _ _ btn' _ -> if btn == btn' then Just x else Nothing
272โ-- | A plain split of the available space into vertically stacked panes.
319+-- | A class for things that can dynamically gain and lose focus
273โ-- No visual separator is built in here.
320+class (Reflex t, Monad m) => HasFocusReader t m | m -> t where
274โsplitV :: (Reflex t, Monad m)
321+ focus :: m (Dynamic t Bool)
275โ => Dynamic t (Int -> Int)
322+ default focus :: (f m' ~ m, Monad m', MonadTrans f, HasFocusReader t m') => m (Dynamic t Bool)
276โ -- ^ Function used to determine size of first pane based on available size
323+ focus = lift focus
277โ -> Dynamic t (Bool, Bool)
324+ localFocus :: (Dynamic t Bool -> Dynamic t Bool) -> m a -> m a
278โ -- ^ How to focus the two sub-panes, given that we are focused.
325+ default localFocus :: (f m' ~ m, Monad m', MFunctor f, HasFocusReader t m') => (Dynamic t Bool -> Dynamic t Bool) -> m a -> m a
279โ -> VtyWidget t m a
326+ localFocus f = hoist (localFocus f)
280โ -- ^ Widget for first pane
327+
281โ -> VtyWidget t m b
328+instance HasFocusReader t m => HasFocusReader t (ReaderT x m)
282โ -- ^ Widget for second pane
329+instance HasFocusReader t m => HasFocusReader t (BehaviorWriterT t x m)
283โ -> VtyWidget t m (a,b)
330+instance HasFocusReader t m => HasFocusReader t (DynamicWriterT t x m)
284โsplitV sizeFunD focD wA wB = do
331+instance HasFocusReader t m => HasFocusReader t (EventWriterT t x m)
285โ sz <- displaySize
332+instance HasFocusReader t m => HasFocusReader t (NodeIdT m)
286โ let regA = (\f (w,h) -> Region 0 0 w (f h)) <$> sizeFunD <*> sz
333+
287โ regB = (\(w,h) (Region _ _ _ hA) -> Region 0 hA w (h - hA)) <$> sz <*> regA
334+-- | A widget that has access to information about whether it is focused
288โ ra <- pane regA (fst <$> focD) wA
335+newtype FocusReader t m a = FocusReader
289โ rb <- pane regB (snd <$> focD) wB
336+ { unFocusReader :: ReaderT (Dynamic t Bool) m a }
290โ return (ra,rb)
337+ deriving
292โ-- | A split of the available space into two parts with a draggable separator.
339+ , Applicative
293โ-- Starts with half the space allocated to each, and the first pane has focus.
340+ , Monad
294โ-- Clicking in a pane switches focus.
341+ , MonadFix
295โsplitVDrag :: (Reflex t, MonadFix m, MonadHold t m)
342+ , MonadHold t
296โ => VtyWidget t m ()
343+ , MonadIO
297โ -> VtyWidget t m a
344+ , MonadRef
298โ -> VtyWidget t m b
345+ , MonadSample t
299โ -> VtyWidget t m (a,b)
346+ )
300โsplitVDrag wS wA wB = do
347+
301โ sz <- displaySize
348+instance (Monad m, Reflex t) => HasFocusReader t (FocusReader t m) where
302โ (_, h0) <- sample $ current sz
349+ focus = FocusReader ask
303โ dragE <- drag V.BLeft
350+ localFocus f = FocusReader . local f . unFocusReader
304โ let splitter0 = h0 `div` 2
351+
305โ rec splitterCheckpoint <- holdDyn splitter0 $ leftmost [fst <$> ffilter snd dragSplitter, resizeSplitter]
352+deriving instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (FocusReader t m)
306โ splitterPos <- holdDyn splitter0 $ leftmost [fst <$> dragSplitter, resizeSplitter]
353+deriving instance NotReady t m => NotReady t (FocusReader t m)
307โ splitterFrac <- holdDyn ((1::Double) / 2) $ ffor (attach (current sz) (fst <$> dragSplitter)) $ \((_,h),x) ->
354+deriving instance PerformEvent t m => PerformEvent t (FocusReader t m)
308โ fromIntegral x / fromIntegral h
355+deriving instance PostBuild t m => PostBuild t (FocusReader t m)
309โ let dragSplitter = fforMaybe (attach (current splitterCheckpoint) dragE) $
356+deriving instance TriggerEvent t m => TriggerEvent t (FocusReader t m)
310โ \(splitterY, Drag (_, fromY) (_, toY) _ _ end) ->
357+instance HasImageWriter t m => HasImageWriter t (FocusReader t m)
311โ if splitterY == fromY then Just (toY, end) else Nothing
358+
312โ regA = (\(w,_) sp -> Region 0 0 w sp) <$> sz <*> splitterPos
359+instance (Adjustable t m, MonadFix m, MonadHold t m) => Adjustable t (FocusReader t m) where
313โ regS = (\(w,_) sp -> Region 0 sp w 1) <$> sz <*> splitterPos
360+ runWithReplace (FocusReader a) e = FocusReader $ runWithReplace a $ fmap unFocusReader e
314โ regB = (\(w,h) sp -> Region 0 (sp + 1) w (h - sp - 1)) <$> sz <*> splitterPos
361+ traverseIntMapWithKeyWithAdjust f m e = FocusReader $ traverseIntMapWithKeyWithAdjust (\k v -> unFocusReader $ f k v) m e
315โ resizeSplitter = ffor (attach (current splitterFrac) (updated sz)) $
362+ traverseDMapWithKeyWithAdjust f m e = FocusReader $ traverseDMapWithKeyWithAdjust (\k v -> unFocusReader $ f k v) m e
316โ \(frac, (_,h)) -> round (frac * fromIntegral h)
363+ traverseDMapWithKeyWithAdjustWithMove f m e = FocusReader $ traverseDMapWithKeyWithAdjustWithMove (\k v -> unFocusReader $ f k v) m e
317โ focA <- holdDyn True $ leftmost
364+
318โ [ True <$ mA
365+instance MonadTrans (FocusReader t) where
319โ , False <$ mB
366+ lift = FocusReader . lift
321โ (mA, rA) <- pane regA focA $ withMouseDown wA
368+instance MFunctor (FocusReader t) where
322โ pane regS (pure False) wS
369+ hoist f = FocusReader . hoist f . unFocusReader
323โ (mB, rB) <- pane regB (not <$> focA) $ withMouseDown wB
370+
324โ return (rA, rB)
371+instance MonadNodeId m => MonadNodeId (FocusReader t m)
326โ withMouseDown x = do
373+-- | Run a 'FocusReader' action with the given focus value
327โ m <- mouseDown V.BLeft
374+runFocusReader
331โ-- | Fill the background with a particular character.
332โfill :: (Reflex t, Monad m) => Char -> VtyWidget t m ()
375+ :: (Reflex t, Monad m)
333โfill c = do
376+ => Dynamic t Bool
334โ sz <- displaySize
377+ -> FocusReader t m a
335โ let fillImg = ffor (current sz) $ \(w,h) -> [V.charFill V.defAttr c w h]
378+ -> m a
336โ tellImages fillImg
379+runFocusReader b = flip runReaderT b . unFocusReader
338โ-- | Fill the background with the bottom
339โhRule :: (Reflex t, Monad m) => BoxStyle -> VtyWidget t m ()
340โhRule boxStyle = fill (_boxStyle_s boxStyle)
342โfractionSz :: Double -> Int -> Int
343โfractionSz x h = round (fromIntegral h * x)
346โ :: (Reflex t, MonadHold t m, MonadFix m)
347โ => Behavior t ([Image] -> [Image])
348โ -> VtyWidget t m a
349โ -> VtyWidget t m a
350โmodifyImages f (VtyWidget w) = VtyWidget $ flip censor w $ \wo ->
351โ wo { _vtyWidgetOut_images = f <*> (_vtyWidgetOut_images wo) }
353โdata BoxStyle = BoxStyle
354โ { _boxStyle_nw :: Char
355โ , _boxStyle_n :: Char
356โ , _boxStyle_ne :: Char
357โ , _boxStyle_e :: Char
358โ , _boxStyle_se :: Char
359โ , _boxStyle_s :: Char
360โ , _boxStyle_sw :: Char
361โ , _boxStyle_w :: Char
364โinstance Default BoxStyle where
365โ def = singleBoxStyle
367โhyphenBoxStyle :: BoxStyle
368โhyphenBoxStyle = BoxStyle '-' '-' '-' '|' '-' '-' '-' '|'
370โsingleBoxStyle :: BoxStyle
381+-- * "Image" output
371โsingleBoxStyle = BoxStyle 'โ' 'โ' 'โ' 'โ' 'โ' 'โ' 'โ' 'โ'
373โthickBoxStyle :: BoxStyle
383+-- | A class for widgets that can produce images to draw to the display
374โthickBoxStyle = BoxStyle 'โ' 'โ' 'โ' 'โ' 'โ' 'โ' 'โ' 'โ'
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
414+ lift = ImageWriter . lift
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
376โdoubleBoxStyle :: BoxStyle
377โdoubleBoxStyle = BoxStyle 'โ' 'โ' 'โ' 'โ' 'โ' 'โ' 'โ' 'โ'
379โroundedBoxStyle :: BoxStyle
517+-- ** Manipulating images
380โroundedBoxStyle = BoxStyle 'โญ' 'โ' 'โฎ' 'โ' 'โฏ' 'โ' 'โฐ' 'โ'
382โbox :: (Monad m, Reflex t)
519+-- | Translates and crops an 'Image' so that it is contained by
383โ => BoxStyle
520+-- the given 'Region'.
384โ -> VtyWidget t m a
385โ -> VtyWidget t m a
386โbox style child = do
388โ let boxReg = ffor (current sz) $ \(w,h) -> Region 0 0 w h
389โ innerReg = ffor sz $ \(w,h) -> Region 1 1 (w - 2) (h - 2)
390โ tellImages (fmap boxImages boxReg)
391โ tellImages (fmap (\r -> [regionBlankImage r]) (current innerReg))
392โ pane innerReg (pure True) child
394โ boxImages :: Region -> [Image]
395โ boxImages (Region left top width height) =
396โ let right = left + width - 1
397โ bottom = top + height - 1
399โ [ withinImage (Region (left + 1) top (width - 2) 1) $
400โ V.charFill V.defAttr (_boxStyle_n style) (width - 2) 1
401โ , withinImage (Region right (top + 1) 1 (height - 2)) $
521+withinImage
402โ V.charFill V.defAttr (_boxStyle_e style) 1 (height - 2)
522+ :: Region
403โ , withinImage (Region (left + 1) bottom (width - 2) 1) $
523+ -> Image
404โ V.charFill V.defAttr (_boxStyle_s style) (width - 2) 1
524+ -> Image
405โ , withinImage (Region left (top + 1) 1 (height - 2)) $
406โ V.charFill V.defAttr (_boxStyle_w style) 1 (height - 2)
409โ [ withinImage (Region left top 1 1) $
410โ V.char V.defAttr (_boxStyle_nw style)
411โ , withinImage (Region right top 1 1) $
412โ V.char V.defAttr (_boxStyle_ne style)
413โ , withinImage (Region right bottom 1 1) $
414โ V.char V.defAttr (_boxStyle_se style)
415โ , withinImage (Region left bottom 1 1) $
416โ V.char V.defAttr (_boxStyle_sw style)
418โ in sides ++ if width > 1 && height > 1 then corners else []
420โtext :: (Reflex t, Monad m) => Behavior t Text -> VtyWidget t m ()
422โ dw <- displayWidth
423โ let img = (\w s -> [wrapText w V.defAttr s]) <$> current dw <*> msg
426โregionBlankImage :: Region -> Image
427โregionBlankImage r@(Region left top width height) =
428โ withinImage r $ V.charFill V.defAttr ' ' width height
430โwithinImage :: Region -> Image -> Image
431withinImage (Region left top width height)
525withinImage (Region left top width height)
432 | width < 0 || height < 0 = withinImage (Region left top 0 0)
526 | width < 0 || height < 0 = withinImage (Region left top 0 0)
433 | otherwise = V.translate left top . V.crop width height
527 | otherwise = V.translate left top . V.crop width height
435โwrapText :: Int -> Attr -> Text -> Image
529+-- | Crop a behavior of images to a behavior of regions. See 'withinImage'.
436โwrapText maxWidth attrs = V.vertCat
530+imagesInRegion
437โ . concatMap (fmap (V.string attrs . T.unpack) . wrapWithOffset maxWidth 0)
531+ :: Reflex t
438โ . T.split (=='\n')
532+ => Behavior t Region
439โ
533+ -> Behavior t [Image]
440โwrapWithOffset :: Int -> Int -> Text -> [Text]
534+ -> Behavior t [Image]
441โwrapWithOffset maxWidth n xs =
535+imagesInRegion reg = liftA2 (\r is -> map (withinImage r) is) reg
442โ let (firstLine, rest) = T.splitAt (maxWidth - n) xs
536+
443โ in firstLine : (fmap (T.take maxWidth) . takeWhile (not . T.null) . iterate (T.drop maxWidth) $ rest)
537+-- * Running sub-widgets
445โwrapInputState
539+-- | Low-level widget combinator that runs a child widget within
446โ :: Int -- ^ Maximum line length
540+-- a given region and context. This widget filters and modifies the input
447โ -> Attr -- ^ Normal string attributes
541+-- that the child widget receives such that:
448โ -> Attr -- ^ Cursor character attributes
542+-- * unfocused widgets receive no key events
449โ -> InputState -- ^ The input to render
543+-- * mouse inputs outside the region are ignored
450โ -> Image
544+-- * mouse inputs inside the region have their coordinates translated such
451โwrapInputState maxWidth attrs cursorAttrs (InputState before after) =
545+-- that (0,0) is the top-left corner of the region
452โ let -- Break up the InputState into:
546+pane
453โ -- * A top section of lines before the line containing the cursor
547+ :: (Reflex t, Monad m, HasInput t m, HasImageWriter t m, HasDisplayRegion t m, HasFocusReader t m)
454โ -- * A part of the line containing the cursor that comes immediately before the cursor
548+ => Dynamic t Region
455โ -- * The cursor character (i.e., the character the cursor is on top of)
549+ -> Dynamic t Bool -- ^ Whether the widget should be focused when the parent is.
456โ -- * The remainder of the line containing the cursor
550+ -> m a
457โ -- * The bottom section of lines after the line containing the cursor
551+ -> m a
458โ (top, midBefore, cursorChar, midAfter, bottom) = case (initLast before', headTail after') of
552+pane dr foc child = localRegion (const dr) $
459โ (Nothing, Nothing) -> ([], "", ' ', "", [])
553+ mapImages (imagesInRegion $ current dr) $
460โ (Just (top', mid), Nothing) -> (top', mid, ' ', "", [])
554+ localFocus (const foc) $
461โ (Nothing, Just (mid, bottom')) -> case T.uncons mid of
555+ inputInFocusedRegion >>= \e -> localInput (const e) child
462โ Nothing -> ([], "", ' ', "", bottom')
556+
463โ Just (c, rest) -> ([], "", c, rest, bottom')
557+-- * Misc
464โ (Just (top', midB), Just (midA, bottom')) -> case T.uncons midA of
558+
465โ Nothing -> (top', midB, ' ', "", bottom')
559+-- | A widget that draws nothing
466โ Just (c, rest) -> (top', midB, c, rest, bottom')
560+blank :: Monad m => m ()
467โ (midBeforeTop, midBefore') = fromMaybe ([], "") $ initLast $ wrap [midBefore]
468โ (midAfter', midAfterBottom) =
469โ let offset = if T.length midBefore' == maxWidth then 1 else T.length midBefore' + 1
470โ in case wrapWithOffset maxWidth offset midAfter of
473โ cursor = V.char cursorAttrs cursorChar
474โ in V.vertCat $ mconcat
475โ [ vstring <$> wrap top
476โ , vstring <$> midBeforeTop
477โ , if T.length midBefore' == maxWidth
479โ [ vstring midBefore'
482โ , vstring midAfter'
487โ [ vstring midBefore'
489โ , vstring midAfter'
492โ , vstring <$> midAfterBottom
493โ , vstring <$> bottom
496โ before' = T.split (=='\n') before
497โ after' = T.split (=='\n') after
498โ vstring = V.string attrs . T.unpack
499โ wrap :: [Text] -> [Text]
500โ wrap = concatMap (wrapWithOffset maxWidth 0)
501โ headTail :: [a] -> Maybe (a, [a])
504โ x:xs -> Just (x, xs)
505โ initLast :: [a] -> Maybe ([a], a)
508โ (x:xs) -> case initLast xs of
509โ Nothing -> Just ([], x)
510โ Just (ys, y) -> Just (x:ys, y)
512โdata InputState = InputState
513โ { _inputState_beforeCursor :: Text
514โ , _inputState_afterCursor :: Text
517โinputValue :: InputState -> Text
518โinputValue (InputState a b) = a <> b
520โupdateInputState :: V.Event -> InputState -> InputState
521โupdateInputState k i@(InputState before after) = case k of
522โ -- Regular characters
523โ V.EvKey (V.KChar k) [] -> InputState (T.snoc before k) after
524โ -- Deletion buttons
525โ V.EvKey V.KBS [] -> InputState (if T.null before then T.empty else T.init before) after
526โ V.EvKey V.KDel [] -> case T.uncons after of
528โ Just (_, a) -> InputState before a
529โ -- Key combinations
530โ V.EvKey (V.KChar 'u') [V.MCtrl] -> InputState mempty mempty
531โ V.EvKey (V.KChar 'w') [V.MCtrl] -> InputState (T.dropWhileEnd (not . isSpace) $ T.dropWhileEnd isSpace $ before) after
533โ V.EvKey V.KRight [] -> case T.uncons after of
535โ Just (a, as) -> InputState (T.snoc before a) as
536โ V.EvKey V.KLeft [] -> case T.unsnoc before of
538โ Just (bs, b) -> InputState bs (T.cons b after)
541โdata TextInputConfig t = TextInputConfig
542โ { _textInputConfig_modifyInputState :: Event t (InputState -> InputState)
545โinstance Reflex t => Default (TextInputConfig t) where
546โ def = TextInputConfig never
548โtextInput :: (Reflex t, MonadHold t m, MonadFix m) => TextInputConfig t -> VtyWidget t m (Dynamic t Text)
551โ v <- foldDyn ($) (InputState mempty mempty) $ mergeWith (.)
552โ [ updateInputState <$> i
553โ , _textInputConfig_modifyInputState cfg
555โ dw <- displayWidth
556โ let img = (\w s -> [wrapInputState w V.defAttr (V.withStyle V.defAttr V.reverseVideo) s]) -- TODO cursor ought to blink
560โ return $ inputValue <$> v
561+blank = return ()
562โmultilineTextInput :: (Reflex t, MonadHold t m, MonadFix m) => TextInputConfig t -> VtyWidget t m (Dynamic t Text)
563โmultilineTextInput cfg = do
565โ textInput $ TextInputConfig $ mergeWith (.)
566โ [ fforMaybe i $ \case
567โ V.EvKey V.KEnter [] -> Just $ \(InputState before after) -> InputState (T.snoc before '\n') after
569โ , _textInputConfig_modifyInputState cfg