@@ -2,41 +2,176 @@
22Module: Reflex.Vty.Widget
33Description: Basic set of widgets and building blocks for reflex-vty applications
44-}
5−{-# Language UndecidableInstances #-}
6−
7−module Reflex.Vty.Widget where
5+{-# LANGUAGE DefaultSignatures #-}
6+{-# LANGUAGE DeriveFunctor #-}
7+{-# LANGUAGE FlexibleContexts #-}
8+{-# LANGUAGE FlexibleInstances #-}
9+{-# LANGUAGE FunctionalDependencies #-}
10+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
11+{-# LANGUAGE LambdaCase #-}
12+{-# LANGUAGE MultiParamTypeClasses #-}
13+{-# LANGUAGE RankNTypes #-}
14+{-# LANGUAGE RecursiveDo #-}
15+{-# LANGUAGE ScopedTypeVariables #-}
16+{-# LANGUAGE StandaloneDeriving #-}
17+{-# LANGUAGE TupleSections #-}
18+{-# LANGUAGE TypeFamilies #-}
19+{-# LANGUAGE UndecidableInstances #-}
20+
21+module Reflex.Vty.Widget
22+ ( VtyWidgetCtx(..)
23+ , VtyWidget(..)
24+ , VtyWidgetOut(..)
25+ , ImageWriter(..)
26+ , runVtyWidget
27+ , mainWidget
28+ , mainWidgetWithHandle
29+ , HasDisplaySize(..)
30+ , HasFocus(..)
31+ , HasVtyInput(..)
32+ , DynRegion(..)
33+ , currentRegion
34+ , Region(..)
35+ , regionSize
36+ , regionBlankImage
37+ , Drag(..)
38+ , drag
39+ , MouseDown(..)
40+ , MouseUp(..)
41+ , mouseDown
42+ , mouseUp
43+ , pane
44+ , splitV
45+ , splitVDrag
46+ , box
47+ , boxStatic
48+ , RichTextConfig(..)
49+ , richText
50+ , text
51+ , display
52+ , BoxStyle(..)
53+ , hyphenBoxStyle
54+ , singleBoxStyle
55+ , roundedBoxStyle
56+ , thickBoxStyle
57+ , doubleBoxStyle
58+ , fill
59+ , hRule
60+ , KeyCombo
61+ , key
62+ , keys
63+ , keyCombos
64+ , blank
65+ , Orientation(..)
66+ , Constraint(..)
67+ , Layout
68+ , runLayout
69+ , tile
70+ , fixed
71+ , stretch
72+ , col
73+ , row
74+ , tabNavigation
75+ , askOrientation
76+ ) where
877
978import Control.Applicative (liftA2)
1079import Control.Monad.Fix (MonadFix)
11−import Control.Monad.IO.Class (MonadIO)
12−import Control.Monad.Morph
13−import Control.Monad.NodeId
14−import Control.Monad.Reader (ReaderT, ask, local, runReaderT)
15−import Control.Monad.Ref
16−import Control.Monad.Trans (MonadTrans, lift)
80+import Control.Monad.Trans.Class
81+import Control.Monad.Trans (lift)
82+import Control.Monad.Reader
83+import Data.Bimap (Bimap)
84+import qualified Data.Bimap as Bimap
85+import Data.Default (Default(..))
86+import Data.Map (Map)
87+import qualified Data.Map as Map
88+import Data.Maybe (fromMaybe)
89+import Data.Monoid hiding (First(..))
90+import Data.Ratio
91+import Data.Semigroup (First(..))
1792import Data.Set (Set)
1893import qualified Data.Set as Set
94+import Data.Text (Text)
95+import qualified Data.Text as T
96+import qualified Data.Text.Zipper as TZ
1997import Graphics.Vty (Image)
2098import qualified Graphics.Vty as V
2199import Reflex
22−import Reflex.Class ()
23100import Reflex.Host.Class (MonadReflexCreateTrigger)
101+import Reflex.Class ()
102+
24103import Reflex.Vty.Host
25104
26−-- * Running a vty application
105+import Control.Monad.NodeId
106+
107+-- | The context within which a 'VtyWidget' runs
108+data VtyWidgetCtx t = VtyWidgetCtx
109+ { _vtyWidgetCtx_width :: Dynamic t Int
110+ -- ^ The width of the region allocated to the widget.
111+ , _vtyWidgetCtx_height :: Dynamic t Int
112+ -- ^ The height of the region allocated to the widget.
113+ , _vtyWidgetCtx_focus :: Dynamic t Bool
114+ -- ^ Whether the widget should behave as if it has focus for keyboard input.
115+ , _vtyWidgetCtx_input :: Event t VtyEvent
116+ -- ^ User input events that the widget's parent chooses to share. These will generally
117+ -- be filtered for relevance:
118+ -- * Keyboard inputs are restricted to focused widgets
119+ -- * Mouse inputs are restricted to the region in which the widget resides and are
120+ -- translated into its internal coordinates.
121+ }
122+
123+-- | The output of a 'VtyWidget'
124+data VtyWidgetOut t = VtyWidgetOut
125+ { _vtyWidgetOut_shutdown :: Event t ()
126+ }
127+
128+instance (Adjustable t m, MonadHold t m, Reflex t) => Adjustable t (VtyWidget t m) where
129+ runWithReplace a0 a' = VtyWidget $ runWithReplace (unVtyWidget a0) $ fmap unVtyWidget a'
130+ traverseIntMapWithKeyWithAdjust f dm0 dm' = VtyWidget $
131+ traverseIntMapWithKeyWithAdjust (\k v -> unVtyWidget (f k v)) dm0 dm'
132+ traverseDMapWithKeyWithAdjust f dm0 dm' = VtyWidget $ do
133+ traverseDMapWithKeyWithAdjust (\k v -> unVtyWidget (f k v)) dm0 dm'
134+ traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = VtyWidget $ do
135+ traverseDMapWithKeyWithAdjustWithMove (\k v -> unVtyWidget (f k v)) dm0 dm'
136+
137+-- | A widget that can read its context and produce image output
138+newtype VtyWidget t m a = VtyWidget
139+ { unVtyWidget :: BehaviorWriterT t [Image] (ReaderT (VtyWidgetCtx t) m) a
140+ } deriving
141+ ( Functor
142+ , Applicative
143+ , Monad
144+ , MonadSample t
145+ , MonadHold t
146+ , MonadFix
147+ , NotReady t
148+ , ImageWriter t
149+ , PostBuild t
150+ , TriggerEvent t
151+ , MonadReflexCreateTrigger t
152+ , MonadIO
153+ )
154+
155+deriving instance PerformEvent t m => PerformEvent t (VtyWidget t m)
156+instance MonadTrans (VtyWidget t) where
157+ lift f = VtyWidget $ lift $ lift f
27158
28−-- | Sets up the top-level context for a vty widget and runs it with that context
159+instance MonadNodeId m => MonadNodeId (VtyWidget t m) where
160+ getNextNodeId = VtyWidget $ do
161+ lift $ lift $ getNextNodeId
162+
163+-- | Runs a 'VtyWidget' with a given context
164+runVtyWidget
165+ :: (Reflex t, MonadNodeId m)
166+ => VtyWidgetCtx t
167+ -> VtyWidget t m a
168+ -> m (a, Behavior t [Image])
169+runVtyWidget ctx w = runReaderT (runBehaviorWriterT (unVtyWidget w)) ctx
170+
171+-- | Sets up the top-level context for a 'VtyWidget' and runs it with that context
29172mainWidgetWithHandle
30173 :: V.Vty
31− -> (forall t m.
32− ( MonadVtyApp t m
33− , HasImageWriter t m
34− , MonadNodeId m
35− , HasDisplayRegion t m
36− , HasFocusReader t m
37− , HasInput t m
38− , HasTheme t m
39− ) => m (Event t ()))
174+ -> (forall t m. (MonadVtyApp t m, MonadNodeId m) => VtyWidget t m (Event t ()))
40175 -> IO ()
41176mainWidgetWithHandle vty child =
42177 runVtyAppWithHandle vty $ \dr0 inp -> do
@@ -46,178 +181,71 @@ mainWidgetWithHandle vty child =
46181 let inp' = fforMaybe inp $ \case
47182 V.EvResize {} -> Nothing
48183 x -> Just x
49− (shutdown, images) <- runThemeReader (constant V.defAttr) $
50− runFocusReader (pure True) $
51− runDisplayRegion (fmap (\(w, h) -> Region 0 0 w h) size) $
52− runImageWriter $
53− runNodeIdT $
54− runInput inp' $ do
55− tellImages . ffor (current size) $ \(w, h) -> [V.charFill V.defAttr ' ' w h]
56− child
184+ let ctx = VtyWidgetCtx
185+ { _vtyWidgetCtx_width = fmap fst size
186+ , _vtyWidgetCtx_height = fmap snd size
187+ , _vtyWidgetCtx_input = inp'
188+ , _vtyWidgetCtx_focus = constDyn True
189+ }
190+ (shutdown, images) <- runNodeIdT $ runVtyWidget ctx $ do
191+ tellImages . ffor (current size) $ \(w, h) -> [V.charFill V.defAttr ' ' w h]
192+ child
57193 return $ VtyResult
58194 { _vtyResult_picture = fmap (V.picForLayers . reverse) images
59195 , _vtyResult_shutdown = shutdown
60196 }
61197
62−-- | The output of a vty widget
63−data VtyWidgetOut t = VtyWidgetOut
64− { _vtyWidgetOut_shutdown :: Event t ()
65− }
66−
67198-- | Like 'mainWidgetWithHandle', but uses a default vty configuration
68199mainWidget
69− :: (forall t m.
70− ( MonadVtyApp t m
71− , HasImageWriter t m
72− , MonadNodeId m
73− , HasDisplayRegion t m
74− , HasFocusReader t m
75− , HasTheme t m
76− , HasInput t m
77− ) => m (Event t ()))
200+ :: (forall t m. (MonadVtyApp t m, MonadNodeId m) => VtyWidget t m (Event t ()))
78201 -> IO ()
79202mainWidget child = do
80203 vty <- getDefaultVty
81204 mainWidgetWithHandle vty child
82205
83−-- * Input Events
206+-- | A class for things that know their own display size dimensions
207+class (Reflex t, Monad m) => HasDisplaySize t m | m -> t where
208+ -- | Retrieve the display width (columns)
209+ displayWidth :: m (Dynamic t Int)
210+ default displayWidth :: (f m' ~ m, MonadTrans f, HasDisplaySize t m') => m (Dynamic t Int)
211+ displayWidth = lift displayWidth
212+ -- | Retrieve the display height (rows)
213+ displayHeight :: m (Dynamic t Int)
214+ default displayHeight :: (f m' ~ m, MonadTrans f, HasDisplaySize t m') => m (Dynamic t Int)
215+ displayHeight = lift displayHeight
216+
217+instance (Reflex t, Monad m) => HasDisplaySize t (VtyWidget t m) where
218+ displayWidth = VtyWidget . lift $ asks _vtyWidgetCtx_width
219+ displayHeight = VtyWidget . lift $ asks _vtyWidgetCtx_height
220+
221+instance HasDisplaySize t m => HasDisplaySize t (ReaderT x m)
222+instance HasDisplaySize t m => HasDisplaySize t (BehaviorWriterT t x m)
223+instance HasDisplaySize t m => HasDisplaySize t (DynamicWriterT t x m)
224+instance HasDisplaySize t m => HasDisplaySize t (EventWriterT t x m)
225+
226+instance HasDisplaySize t m => HasDisplaySize t (NodeIdT m)
84227
85228-- | A class for things that can receive vty events as input
86−class HasInput t m | m -> t where
229+class HasVtyInput t m | m -> t where
87230 input :: m (Event t VtyEvent)
88− default input :: (f m' ~ m, Monad m', MonadTrans f, HasInput t m') => m (Event t VtyEvent)
89− input = lift input
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)
95−
96−instance (Reflex t, Monad m) => HasInput t (Input t m) where
97− input = Input ask
98− localInput f (Input m) = Input $ local f m
99−
100−-- | A widget that can receive input events. See 'Graphics.Vty.Event'
101−newtype Input t m a = Input
102− { unInput :: ReaderT (Event t VtyEvent) m a
103− } deriving
104− ( Functor
105− , Applicative
106− , Monad
107− , MonadSample t
108− , MonadHold t
109− , MonadFix
110− , MonadIO
111− , MonadRef
112− )
113231
114−instance (Adjustable t m, MonadHold t m, Reflex t) => Adjustable t (Input t m) where
115− runWithReplace a0 a' = Input $ runWithReplace (unInput a0) $ fmap unInput a'
116− traverseIntMapWithKeyWithAdjust f dm0 dm' = Input $
117− traverseIntMapWithKeyWithAdjust (\k v -> unInput (f k v)) dm0 dm'
118− traverseDMapWithKeyWithAdjust f dm0 dm' = Input $ do
119− traverseDMapWithKeyWithAdjust (\k v -> unInput (f k v)) dm0 dm'
120− traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = Input $ do
121− traverseDMapWithKeyWithAdjustWithMove (\k v -> unInput (f k v)) dm0 dm'
122−
123−deriving instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (Input t m)
124−deriving instance NotReady t m => NotReady t (Input t m)
125−deriving instance PerformEvent t m => PerformEvent t (Input t m)
126−deriving instance PostBuild t m => PostBuild t (Input t m)
127−deriving instance TriggerEvent t m => TriggerEvent t (Input t m)
128−instance HasImageWriter t m => HasImageWriter t (Input t m)
129−instance HasDisplayRegion t m => HasDisplayRegion t (Input t m)
130−instance HasFocusReader t m => HasFocusReader t (Input t m)
131−
132−instance MonadTrans (Input t) where
133− lift f = Input $ lift f
134−
135−instance MFunctor (Input t) where
136− hoist f = Input . hoist f . unInput
137−
138−instance MonadNodeId m => MonadNodeId (Input t m)
139−
140−-- | Runs an 'Input' with a given context
141−runInput
142− :: Reflex t
143− => Event t VtyEvent
144− -> Input t m a
145− -> m a
146−runInput e w = runReaderT (unInput w) e
147−
148−-- ** Filtering input
232+instance (Reflex t, Monad m) => HasVtyInput t (VtyWidget t m) where
233+ input = VtyWidget . lift $ asks _vtyWidgetCtx_input
149234
150−-- | Type synonym for a key and modifier combination
151−type KeyCombo = (V.Key, [V.Modifier])
152−
153−-- | Emits an event that fires on a particular key press (without modifiers)
154−key :: (Monad m, Reflex t, HasInput t m) => V.Key -> m (Event t KeyCombo)
155−key = keyCombos . Set.singleton . (,[])
156−
157−-- | Emits an event that fires on particular key presses (without modifiers)
158−keys :: (Monad m, Reflex t, HasInput t m) => [V.Key] -> m (Event t KeyCombo)
159−keys = keyCombos . Set.fromList . fmap (,[])
160−
161−-- | Emit an event that fires whenever the provided key combination occurs
162−keyCombo
163− :: (Reflex t, Monad m, HasInput t m)
164− => KeyCombo
165− -> m (Event t KeyCombo)
166−keyCombo = keyCombos . Set.singleton
235+-- | A class for things that can dynamically gain and lose focus
236+class HasFocus t m | m -> t where
237+ focus :: m (Dynamic t Bool)
167238
168−-- | Emit an event that fires whenever any of the provided key combinations occur
169−keyCombos
170− :: (Reflex t, Monad m, HasInput t m)
171− => Set KeyCombo
172− -> m (Event t KeyCombo)
173−keyCombos ks = do
174− i <- input
175− return $ fforMaybe i $ \case
176− V.EvKey k m -> if Set.member (k, m) ks
177− then Just (k, m)
178− else Nothing
179− _ -> Nothing
239+instance (Reflex t, Monad m) => HasFocus t (VtyWidget t m) where
240+ focus = VtyWidget . lift $ asks _vtyWidgetCtx_focus
180241
181−-- | Filter the keyboard input that a child widget may receive
182−filterKeys :: (Reflex t, HasInput t m) => (KeyCombo -> Bool) -> m a -> m a
183−filterKeys f x = localInput (ffilter (\case
184− V.EvKey k mods -> f (k, mods)
185− _ -> True)) x
186−
187−-- | Filter mouse input events based on whether they target a particular region
188−-- and translate them to the internal coordinate system of that region.
189−--
190−-- NB: Non-mouse events are passed through unfiltered and unchanged
191−mouseInRegion :: Region -> VtyEvent -> Maybe VtyEvent
192−mouseInRegion (Region l t w h) e = case e of
193− V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
194− V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
195− _ -> Just e
196− where
197− mouse con x y
198− | or [ x < l
199− , y < t
200− , x >= l + w
201− , y >= t + h ] = Nothing
202− | otherwise =
203− Just (con (x - l) (y - t))
204−
205−-- | Filter mouse input outside the current display region and
206−-- all input if the region is not focused
207−inputInFocusedRegion
208− :: (HasDisplayRegion t m, HasFocusReader t m, HasInput t m)
209− => m (Event t VtyEvent)
210−inputInFocusedRegion = do
211− inp <- input
212− reg <- current <$> askRegion
213− foc <- current <$> focus
214− pure $ fmapMaybe id $ attachWith filterInput ((,) <$> reg <*> foc) inp
215− where
216− filterInput (r, f) = \case
217− V.EvKey {} | not f -> Nothing
218− x -> mouseInRegion r x
242+-- | A class for widgets that can produce images to draw to the display
243+class (Reflex t, Monad m) => ImageWriter t m | m -> t where
244+ -- | Send images upstream for rendering
245+ tellImages :: Behavior t [Image] -> m ()
219246
220−-- * Getting and setting the display region
247+instance (Monad m, Reflex t) => ImageWriter t (BehaviorWriterT t [Image] m) where
248+ tellImages = tellBehavior
221249
222250-- | A chunk of the display area
223251data Region = Region
@@ -228,334 +256,614 @@ data Region = Region
228256 }
229257 deriving (Show, Read, Eq, Ord)
230258
231−-- | A region that occupies no space.
232−nilRegion :: Region
233−nilRegion = Region 0 0 0 0
259+-- | A dynamic chunk of the display area
260+data DynRegion t = DynRegion
261+ { _dynRegion_left :: Dynamic t Int
262+ , _dynRegion_top :: Dynamic t Int
263+ , _dynRegion_width :: Dynamic t Int
264+ , _dynRegion_height :: Dynamic t Int
265+ }
234266
235267-- | The width and height of a 'Region'
236268regionSize :: Region -> (Int, Int)
237269regionSize (Region _ _ w h) = (w, h)
238270
239271-- | 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
272+regionBlankImage :: Region -> Image
273+regionBlankImage r@(Region _ _ width height) =
274+ withinImage r $ V.charFill V.defAttr ' ' width height
243275
244−-- | A class for things that know their own display size dimensions
245−class (Reflex t, Monad m) => HasDisplayRegion t m | m -> t where
246− -- | Retrieve the display region
247− askRegion :: m (Dynamic t Region)
248− default askRegion :: (f m' ~ m, MonadTrans f, HasDisplayRegion t m') => m (Dynamic t Region)
249− askRegion = lift askRegion
250− -- | Run an action in a local region, by applying a transformation to the region
251− localRegion :: (Dynamic t Region -> Dynamic t Region) -> m a -> m a
252− default localRegion :: (f m' ~ m, Monad m', MFunctor f, HasDisplayRegion t m') => (Dynamic t Region -> Dynamic t Region) -> m a -> m a
253− localRegion f = hoist (localRegion f)
254−
255−-- | Retrieve the display width
256−displayWidth :: HasDisplayRegion t m => m (Dynamic t Int)
257−displayWidth = fmap _region_width <$> askRegion
258−
259−-- | Retrieve the display height
260−displayHeight :: HasDisplayRegion t m => m (Dynamic t Int)
261−displayHeight = fmap _region_height <$> askRegion
262−
263−instance HasDisplayRegion t m => HasDisplayRegion t (ReaderT x m)
264−instance HasDisplayRegion t m => HasDisplayRegion t (BehaviorWriterT t x m)
265−instance HasDisplayRegion t m => HasDisplayRegion t (DynamicWriterT t x m)
266−instance HasDisplayRegion t m => HasDisplayRegion t (EventWriterT t x m)
267−instance HasDisplayRegion t m => HasDisplayRegion t (NodeIdT m)
268−
269−-- | A widget that has access to a particular region of the vty display
270−newtype DisplayRegion t m a = DisplayRegion
271− { unDisplayRegion :: ReaderT (Dynamic t Region) m a }
272− deriving
273− ( Functor
274− , Applicative
275− , Monad
276− , MonadFix
277− , MonadHold t
278− , MonadIO
279− , MonadRef
280− , MonadSample t
281− )
276+-- | A behavior of the current display area represented by a 'DynRegion'
277+currentRegion :: Reflex t => DynRegion t -> Behavior t Region
278+currentRegion (DynRegion l t w h) = Region <$> current l <*> current t <*> current w <*> current h
282279
283−instance (Monad m, Reflex t) => HasDisplayRegion t (DisplayRegion t m) where
284− askRegion = DisplayRegion ask
285− localRegion f = DisplayRegion . local f . unDisplayRegion
286−
287−deriving instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (DisplayRegion t m)
288−deriving instance NotReady t m => NotReady t (DisplayRegion t m)
289−deriving instance PerformEvent t m => PerformEvent t (DisplayRegion t m)
290−deriving instance PostBuild t m => PostBuild t (DisplayRegion t m)
291−deriving instance TriggerEvent t m => TriggerEvent t (DisplayRegion t m)
292−instance HasImageWriter t m => HasImageWriter t (DisplayRegion t m)
293−instance HasFocusReader t m => HasFocusReader t (DisplayRegion t m)
294−
295−instance (Adjustable t m, MonadFix m, MonadHold t m) => Adjustable t (DisplayRegion t m) where
296− runWithReplace (DisplayRegion a) e = DisplayRegion $ runWithReplace a $ fmap unDisplayRegion e
297− traverseIntMapWithKeyWithAdjust f m e = DisplayRegion $ traverseIntMapWithKeyWithAdjust (\k v -> unDisplayRegion $ f k v) m e
298− traverseDMapWithKeyWithAdjust f m e = DisplayRegion $ traverseDMapWithKeyWithAdjust (\k v -> unDisplayRegion $ f k v) m e
299− traverseDMapWithKeyWithAdjustWithMove f m e = DisplayRegion $ traverseDMapWithKeyWithAdjustWithMove (\k v -> unDisplayRegion $ f k v) m e
300−
301−instance MonadTrans (DisplayRegion t) where
302− lift = DisplayRegion . lift
303−
304−instance MFunctor (DisplayRegion t) where
305− hoist f = DisplayRegion . hoist f . unDisplayRegion
280+-- | Translates and crops an 'Image' so that it is contained by
281+-- the given 'Region'.
282+withinImage
283+ :: Region
284+ -> Image
285+ -> Image
286+withinImage (Region left top width height)
287+ | width < 0 || height < 0 = withinImage (Region left top 0 0)
288+ | otherwise = V.translate left top . V.crop width height
306289
307−instance MonadNodeId m => MonadNodeId (DisplayRegion t m)
290+-- | Low-level widget combinator that runs a child 'VtyWidget' within
291+-- a given region and context. This widget filters and modifies the input
292+-- that the child widget receives such that:
293+-- * unfocused widgets receive no key events
294+-- * mouse inputs outside the region are ignored
295+-- * mouse inputs inside the region have their coordinates translated such
296+-- that (0,0) is the top-left corner of the region
297+pane
298+ :: (Reflex t, Monad m, MonadNodeId m)
299+ => DynRegion t
300+ -> Dynamic t Bool -- ^ Whether the widget should be focused when the parent is.
301+ -> VtyWidget t m a
302+ -> VtyWidget t m a
303+pane dr foc child = VtyWidget $ do
304+ ctx <- lift ask
305+ let reg = currentRegion dr
306+ let ctx' = VtyWidgetCtx
307+ { _vtyWidgetCtx_input = leftmost -- TODO: think about this leftmost more.
308+ [ fmapMaybe id $
309+ attachWith (\(r,f) e -> filterInput r f e)
310+ (liftA2 (,) reg (current foc))
311+ (_vtyWidgetCtx_input ctx)
312+ ]
313+ , _vtyWidgetCtx_focus = liftA2 (&&) (_vtyWidgetCtx_focus ctx) foc
314+ , _vtyWidgetCtx_width = _dynRegion_width dr
315+ , _vtyWidgetCtx_height = _dynRegion_height dr
316+ }
317+ (result, images) <- lift . lift $ runVtyWidget ctx' child
318+ let images' = liftA2 (\r is -> map (withinImage r) is) reg images
319+ tellImages images'
320+ return result
321+ where
322+ filterInput :: Region -> Bool -> VtyEvent -> Maybe VtyEvent
323+ filterInput (Region l t w h) focused e = case e of
324+ V.EvKey _ _ | not focused -> Nothing
325+ V.EvMouseDown x y btn m -> mouse (\u v -> V.EvMouseDown u v btn m) x y
326+ V.EvMouseUp x y btn -> mouse (\u v -> V.EvMouseUp u v btn) x y
327+ _ -> Just e
328+ where
329+ mouse con x y
330+ | or [ x < l
331+ , y < t
332+ , x >= l + w
333+ , y >= t + h ] = Nothing
334+ | otherwise =
335+ Just (con (x - l) (y - t))
336+
337+-- | Information about a drag operation
338+data Drag = Drag
339+ { _drag_from :: (Int, Int) -- ^ Where the drag began
340+ , _drag_to :: (Int, Int) -- ^ Where the mouse currently is
341+ , _drag_button :: V.Button -- ^ Which mouse button is dragging
342+ , _drag_modifiers :: [V.Modifier] -- ^ What modifiers are held
343+ , _drag_end :: Bool -- ^ Whether the drag ended (the mouse button was released)
344+ }
345+ deriving (Eq, Ord, Show)
346+
347+-- | Converts raw vty mouse drag events into an event stream of 'Drag's
348+drag
349+ :: (Reflex t, MonadFix m, MonadHold t m)
350+ => V.Button
351+ -> VtyWidget t m (Event t Drag)
352+drag btn = do
353+ inp <- input
354+ let f :: Maybe Drag -> V.Event -> Maybe Drag
355+ f Nothing = \case
356+ V.EvMouseDown x y btn' mods
357+ | btn == btn' -> Just $ Drag (x,y) (x,y) btn' mods False
358+ | otherwise -> Nothing
359+ _ -> Nothing
360+ f (Just (Drag from _ _ mods end)) = \case
361+ V.EvMouseDown x y btn' mods'
362+ | end -> Just $ Drag (x,y) (x,y) btn' mods' False
363+ | btn == btn' -> Just $ Drag from (x,y) btn mods' False
364+ | otherwise -> Nothing -- Ignore other buttons.
365+ V.EvMouseUp x y (Just btn')
366+ | end -> Nothing
367+ | btn == btn' -> Just $ Drag from (x,y) btn mods True
368+ | otherwise -> Nothing
369+ V.EvMouseUp x y Nothing -- Terminal doesn't specify mouse up button,
370+ -- assume it's the right one.
371+ | end -> Nothing
372+ | otherwise -> Just $ Drag from (x,y) btn mods True
373+ _ -> Nothing
374+ rec let newDrag = attachWithMaybe f (current dragD) inp
375+ dragD <- holdDyn Nothing $ Just <$> newDrag
376+ return (fmapMaybe id $ updated dragD)
377+
378+-- | Mouse down events for a particular mouse button
379+mouseDown
380+ :: (Reflex t, Monad m)
381+ => V.Button
382+ -> VtyWidget t m (Event t MouseDown)
383+mouseDown btn = do
384+ i <- input
385+ return $ fforMaybe i $ \case
386+ V.EvMouseDown x y btn' mods -> if btn == btn'
387+ then Just $ MouseDown btn' (x, y) mods
388+ else Nothing
389+ _ -> Nothing
308390
309−-- | Run a 'DisplayRegion' action with a given 'Region'
310−runDisplayRegion
391+-- | Mouse up events for a particular mouse button
392+mouseUp
311393 :: (Reflex t, Monad m)
312− => Dynamic t Region
313− -> DisplayRegion t m a
314− -> m a
315−runDisplayRegion r = flip runReaderT r . unDisplayRegion
394+ => VtyWidget t m (Event t MouseUp)
395+mouseUp = do
396+ i <- input
397+ return $ fforMaybe i $ \case
398+ V.EvMouseUp x y btn' -> Just $ MouseUp btn' (x, y)
399+ _ -> Nothing
316400
317−-- * Getting focus state
401+-- | Information about a mouse down event
402+data MouseDown = MouseDown
403+ { _mouseDown_button :: V.Button
404+ , _mouseDown_coordinates :: (Int, Int)
405+ , _mouseDown_modifiers :: [V.Modifier]
406+ }
407+ deriving (Eq, Ord, Show)
318408
319−-- | A class for things that can dynamically gain and lose focus
320−class (Reflex t, Monad m) => HasFocusReader t m | m -> t where
321− focus :: m (Dynamic t Bool)
322− default focus :: (f m' ~ m, Monad m', MonadTrans f, HasFocusReader t m') => m (Dynamic t Bool)
323− focus = lift focus
324− localFocus :: (Dynamic t Bool -> Dynamic t Bool) -> m a -> m a
325− default localFocus :: (f m' ~ m, Monad m', MFunctor f, HasFocusReader t m') => (Dynamic t Bool -> Dynamic t Bool) -> m a -> m a
326− localFocus f = hoist (localFocus f)
327−
328−instance HasFocusReader t m => HasFocusReader t (ReaderT x m)
329−instance HasFocusReader t m => HasFocusReader t (BehaviorWriterT t x m)
330−instance HasFocusReader t m => HasFocusReader t (DynamicWriterT t x m)
331−instance HasFocusReader t m => HasFocusReader t (EventWriterT t x m)
332−instance HasFocusReader t m => HasFocusReader t (NodeIdT m)
333−
334−-- | A widget that has access to information about whether it is focused
335−newtype FocusReader t m a = FocusReader
336− { unFocusReader :: ReaderT (Dynamic t Bool) m a }
337− deriving
338− ( Functor
339− , Applicative
340− , Monad
341− , MonadFix
342− , MonadHold t
343− , MonadIO
344− , MonadRef
345− , MonadSample t
346− )
409+-- | Information about a mouse up event
410+data MouseUp = MouseUp
411+ { _mouseUp_button :: Maybe V.Button
412+ , _mouseUp_coordinates :: (Int, Int)
413+ }
414+ deriving (Eq, Ord, Show)
347415
348−instance (Monad m, Reflex t) => HasFocusReader t (FocusReader t m) where
349− focus = FocusReader ask
350− localFocus f = FocusReader . local f . unFocusReader
416+-- | Type synonym for a key and modifier combination
417+type KeyCombo = (V.Key, [V.Modifier])
351418
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)
419+-- | Emits an event that fires on a particular key press (without modifiers)
420+key :: (Monad m, Reflex t) => V.Key -> VtyWidget t m (Event t KeyCombo)
421+key = keyCombos . Set.singleton . (,[])
422+
423+-- | Emits an event that fires on particular key presses (without modifiers)
424+keys :: (Monad m, Reflex t) => [V.Key] -> VtyWidget t m (Event t KeyCombo)
425+keys = keyCombos . Set.fromList . fmap (,[])
358426
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
427+-- | Emit an event that fires whenever any of the provided key combinations occur
428+keyCombos
429+ :: (Reflex t, Monad m)
430+ => Set KeyCombo
431+ -> VtyWidget t m (Event t KeyCombo)
432+keyCombos ks = do
433+ i <- input
434+ return $ fforMaybe i $ \case
435+ V.EvKey k m -> if Set.member (k, m) ks
436+ then Just (k, m)
437+ else Nothing
438+ _ -> Nothing
364439
365−instance MonadTrans (FocusReader t) where
366− lift = FocusReader . lift
440+-- | A plain split of the available space into vertically stacked panes.
441+-- No visual separator is built in here.
442+splitV :: (Reflex t, Monad m, MonadNodeId m)
443+ => Dynamic t (Int -> Int)
444+ -- ^ Function used to determine size of first pane based on available size
445+ -> Dynamic t (Bool, Bool)
446+ -- ^ How to focus the two sub-panes, given that we are focused.
447+ -> VtyWidget t m a
448+ -- ^ Widget for first pane
449+ -> VtyWidget t m b
450+ -- ^ Widget for second pane
451+ -> VtyWidget t m (a,b)
452+splitV sizeFunD focD wA wB = do
453+ dw <- displayWidth
454+ dh <- displayHeight
455+ let regA = DynRegion
456+ { _dynRegion_left = pure 0
457+ , _dynRegion_top = pure 0
458+ , _dynRegion_width = dw
459+ , _dynRegion_height = sizeFunD <*> dh
460+ }
461+ regB = DynRegion
462+ { _dynRegion_left = pure 0
463+ , _dynRegion_top = _dynRegion_height regA
464+ , _dynRegion_width = dw
465+ , _dynRegion_height = liftA2 (-) dh (_dynRegion_height regA)
466+ }
467+ ra <- pane regA (fst <$> focD) wA
468+ rb <- pane regB (snd <$> focD) wB
469+ return (ra,rb)
470+
471+-- | A split of the available space into two parts with a draggable separator.
472+-- Starts with half the space allocated to each, and the first pane has focus.
473+-- Clicking in a pane switches focus.
474+splitVDrag :: (Reflex t, MonadFix m, MonadHold t m, MonadNodeId m)
475+ => VtyWidget t m ()
476+ -> VtyWidget t m a
477+ -> VtyWidget t m b
478+ -> VtyWidget t m (a,b)
479+splitVDrag wS wA wB = do
480+ dh <- displayHeight
481+ dw <- displayWidth
482+ h0 <- sample $ current dh -- TODO
483+ dragE <- drag V.BLeft
484+ let splitter0 = h0 `div` 2
485+ rec splitterCheckpoint <- holdDyn splitter0 $ leftmost [fst <$> ffilter snd dragSplitter, resizeSplitter]
486+ splitterPos <- holdDyn splitter0 $ leftmost [fst <$> dragSplitter, resizeSplitter]
487+ splitterFrac <- holdDyn ((1::Double) / 2) $ ffor (attach (current dh) (fst <$> dragSplitter)) $ \(h, x) ->
488+ fromIntegral x / (max 1 (fromIntegral h))
489+ let dragSplitter = fforMaybe (attach (current splitterCheckpoint) dragE) $
490+ \(splitterY, Drag (_, fromY) (_, toY) _ _ end) ->
491+ if splitterY == fromY then Just (toY, end) else Nothing
492+ regA = DynRegion 0 0 dw splitterPos
493+ regS = DynRegion 0 splitterPos dw 1
494+ regB = DynRegion 0 (splitterPos + 1) dw (dh - splitterPos - 1)
495+ resizeSplitter = ffor (attach (current splitterFrac) (updated dh)) $
496+ \(frac, h) -> round (frac * fromIntegral h)
497+ focA <- holdDyn True $ leftmost
498+ [ True <$ mA
499+ , False <$ mB
500+ ]
501+ (mA, rA) <- pane regA focA $ withMouseDown wA
502+ pane regS (pure False) wS
503+ (mB, rB) <- pane regB (not <$> focA) $ withMouseDown wB
504+ return (rA, rB)
505+ where
506+ withMouseDown x = do
507+ m <- mouseDown V.BLeft
508+ x' <- x
509+ return (m, x')
510+
511+-- | Fill the background with a particular character.
512+fill :: (Reflex t, Monad m) => Char -> VtyWidget t m ()
513+fill c = do
514+ dw <- displayWidth
515+ dh <- displayHeight
516+ let fillImg = current $ liftA2 (\w h -> [V.charFill V.defAttr c w h]) dw dh
517+ tellImages fillImg
518+
519+-- | Fill the background with the bottom
520+hRule :: (Reflex t, Monad m) => BoxStyle -> VtyWidget t m ()
521+hRule boxStyle = fill (_boxStyle_s boxStyle)
522+
523+-- | Defines a set of symbols to use to draw the outlines of boxes
524+-- C.f. https://en.wikipedia.org/wiki/Box-drawing_character
525+data BoxStyle = BoxStyle
526+ { _boxStyle_nw :: Char
527+ , _boxStyle_n :: Char
528+ , _boxStyle_ne :: Char
529+ , _boxStyle_e :: Char
530+ , _boxStyle_se :: Char
531+ , _boxStyle_s :: Char
532+ , _boxStyle_sw :: Char
533+ , _boxStyle_w :: Char
534+ }
367535
368−instance MFunctor (FocusReader t) where
369− hoist f = FocusReader . hoist f . unFocusReader
536+instance Default BoxStyle where
537+ def = singleBoxStyle
538+
539+-- | A box style that uses hyphens and pipe characters. Doesn't handle
540+-- corners very well.
541+hyphenBoxStyle :: BoxStyle
542+hyphenBoxStyle = BoxStyle '-' '-' '-' '|' '-' '-' '-' '|'
543+
544+-- | A single line box style
545+singleBoxStyle :: BoxStyle
546+singleBoxStyle = BoxStyle '┌' '─' '┐' '│' '┘' '─' '└' '│'
547+
548+-- | A thick single line box style
549+thickBoxStyle :: BoxStyle
550+thickBoxStyle = BoxStyle '┏' '━' '┓' '┃' '┛' '━' '┗' '┃'
551+
552+-- | A double line box style
553+doubleBoxStyle :: BoxStyle
554+doubleBoxStyle = BoxStyle '╔' '═' '╗' '║' '╝' '═' '╚' '║'
555+
556+-- | A single line box style with rounded corners
557+roundedBoxStyle :: BoxStyle
558+roundedBoxStyle = BoxStyle '╭' '─' '╮' '│' '╯' '─' '╰' '│'
559+
560+-- | Draws a box in the provided style and a child widget inside of that box
561+box :: (Monad m, Reflex t, MonadNodeId m)
562+ => Behavior t BoxStyle
563+ -> VtyWidget t m a
564+ -> VtyWidget t m a
565+box boxStyle child = do
566+ dh <- displayHeight
567+ dw <- displayWidth
568+ let boxReg = DynRegion (pure 0) (pure 0) dw dh
569+ innerReg = DynRegion (pure 1) (pure 1) (subtract 2 <$> dw) (subtract 2 <$> dh)
570+ tellImages (boxImages <$> boxStyle <*> currentRegion boxReg)
571+ tellImages (fmap (\r -> [regionBlankImage r]) (currentRegion innerReg))
572+ pane innerReg (pure True) child
573+ where
574+ boxImages :: BoxStyle -> Region -> [Image]
575+ boxImages style (Region left top width height) =
576+ let right = left + width - 1
577+ bottom = top + height - 1
578+ sides =
579+ [ withinImage (Region (left + 1) top (width - 2) 1) $
580+ V.charFill V.defAttr (_boxStyle_n style) (width - 2) 1
581+ , withinImage (Region right (top + 1) 1 (height - 2)) $
582+ V.charFill V.defAttr (_boxStyle_e style) 1 (height - 2)
583+ , withinImage (Region (left + 1) bottom (width - 2) 1) $
584+ V.charFill V.defAttr (_boxStyle_s style) (width - 2) 1
585+ , withinImage (Region left (top + 1) 1 (height - 2)) $
586+ V.charFill V.defAttr (_boxStyle_w style) 1 (height - 2)
587+ ]
588+ corners =
589+ [ withinImage (Region left top 1 1) $
590+ V.char V.defAttr (_boxStyle_nw style)
591+ , withinImage (Region right top 1 1) $
592+ V.char V.defAttr (_boxStyle_ne style)
593+ , withinImage (Region right bottom 1 1) $
594+ V.char V.defAttr (_boxStyle_se style)
595+ , withinImage (Region left bottom 1 1) $
596+ V.char V.defAttr (_boxStyle_sw style)
597+ ]
598+ in sides ++ if width > 1 && height > 1 then corners else []
599+
600+-- | A box whose style is static
601+boxStatic
602+ :: (Reflex t, Monad m, MonadNodeId m)
603+ => BoxStyle
604+ -> VtyWidget t m a
605+ -> VtyWidget t m a
606+boxStatic = box . pure
607+
608+-- | Configuration options for displaying "rich" text
609+data RichTextConfig t = RichTextConfig
610+ { _richTextConfig_attributes :: Behavior t V.Attr
611+ }
370612
371−instance MonadNodeId m => MonadNodeId (FocusReader t m)
613+instance Reflex t => Default (RichTextConfig t) where
614+ def = RichTextConfig $ pure V.defAttr
372615
373−-- | Run a 'FocusReader' action with the given focus value
374−runFocusReader
616+-- | A widget that displays text with custom time-varying attributes
617+richText
375618 :: (Reflex t, Monad m)
376− => Dynamic t Bool
377− -> FocusReader t m a
378− -> m a
379−runFocusReader b = flip runReaderT b . unFocusReader
380−
381−-- * "Image" output
619+ => RichTextConfig t
620+ -> Behavior t Text
621+ -> VtyWidget t m ()
622+richText cfg t = do
623+ dw <- displayWidth
624+ let img = (\w a s -> [wrapText w a s])
625+ <$> current dw
626+ <*> _richTextConfig_attributes cfg
627+ <*> t
628+ tellImages img
629+ where
630+ wrapText maxWidth attrs = V.vertCat
631+ . concatMap (fmap (V.string attrs . T.unpack) . TZ.wrapWithOffset maxWidth 0)
632+ . T.split (=='\n')
382633
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)
393−
394−-- | A widget that can produce images to draw onto the display
395−newtype ImageWriter t m a = ImageWriter
396− { unImageWriter :: BehaviorWriterT t [Image] m a }
397− deriving
398− ( Functor
399− , Applicative
400− , Monad
401− , MonadFix
402− , MonadHold t
403− , MonadIO
404− , MonadRef
405− , MonadReflexCreateTrigger t
406− , MonadSample t
407− , NotReady t
408− , PerformEvent t
409− , PostBuild t
410− , TriggerEvent t
411− )
634+-- | Renders text, wrapped to the container width
635+text
636+ :: (Reflex t, Monad m)
637+ => Behavior t Text
638+ -> VtyWidget t m ()
639+text = richText def
640+
641+-- | Renders any behavior whose value can be converted to
642+-- 'String' as text
643+display
644+ :: (Reflex t, Monad m, Show a)
645+ => Behavior t a
646+ -> VtyWidget t m ()
647+display a = text $ T.pack . show <$> a
648+
649+data Constraint = Constraint_Fixed Int
650+ | Constraint_Min Int
651+ deriving (Show, Read, Eq, Ord)
412652
413−instance MonadTrans (ImageWriter t) where
414− lift = ImageWriter . lift
653+-- | Compute the size of each widget "@k@" based on the total set of 'Constraint's
654+computeSizes
655+ :: Ord k
656+ => Int
657+ -> Map k (a, Constraint)
658+ -> Map k (a, Int)
659+computeSizes available constraints =
660+ let minTotal = sum $ ffor (Map.elems constraints) $ \case
661+ (_, Constraint_Fixed n) -> n
662+ (_, Constraint_Min n) -> n
663+ leftover = max 0 (available - minTotal)
664+ numStretch = Map.size $ Map.filter (isMin . snd) constraints
665+ szStretch = floor $ leftover % (max numStretch 1)
666+ adjustment = max 0 $ available - minTotal - szStretch * numStretch
667+ in snd $ Map.mapAccum (\adj (a, c) -> case c of
668+ Constraint_Fixed n -> (adj, (a, n))
669+ Constraint_Min n -> (0, (a, n + szStretch + adj))) adjustment constraints
670+ where
671+ isMin (Constraint_Min _) = True
672+ isMin _ = False
415673
416−instance MFunctor (ImageWriter t) where
417− hoist f = ImageWriter . (hoist f) . unImageWriter
674+computeEdges :: (Ord k) => Map k (a, Int) -> Map k (a, (Int, Int))
675+computeEdges = fst . Map.foldlWithKey' (\(m, offset) k (a, sz) ->
676+ (Map.insert k (a, (offset, sz)) m, sz + offset)) (Map.empty, 0)
418677
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
678+blank :: Monad m => VtyWidget t m ()
679+blank = return ()
424680
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)
681+-- | The main-axis orientation of a 'StackWidget' widget
682+data Orientation = Orientation_Column
683+ | Orientation_Row
684+ deriving (Show, Read, Eq, Ord)
430685
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
436− pure a
686+data LayoutSegment = LayoutSegment
687+ { _layoutSegment_offset :: Int
688+ , _layoutSegment_size :: Int
689+ }
437690
438−instance HasDisplayRegion t m => HasDisplayRegion t (ImageWriter t m)
439−instance HasFocusReader t m => HasFocusReader t (ImageWriter t m)
691+data LayoutCtx t = LayoutCtx
692+ { _layoutCtx_regions :: Dynamic t (Map NodeId LayoutSegment)
693+ , _layoutCtx_focusDemux :: Demux t (Maybe NodeId)
694+ , _layoutCtx_orientation :: Dynamic t Orientation
695+ }
440696
441−-- | Run a widget that can produce images
442−runImageWriter
443− :: (Reflex t, Monad m)
444− => ImageWriter t m a
445− -> m (a, Behavior t [Image])
446−runImageWriter = runBehaviorWriterT . unImageWriter
447−
448−-- * Theming
449−
450−-- | A class for things that can be visually styled
451−class (Reflex t, Monad m) => HasTheme t m | m -> t where
452− theme :: m (Behavior t V.Attr)
453− default theme :: (f m' ~ m, Monad m', MonadTrans f, HasTheme t m') => m (Behavior t V.Attr)
454− theme = lift theme
455− localTheme :: (Behavior t V.Attr -> Behavior t V.Attr) -> m a -> m a
456− default localTheme :: (f m' ~ m, Monad m', MFunctor f, HasTheme t m') => (Behavior t V.Attr -> Behavior t V.Attr) -> m a -> m a
457− localTheme f = hoist (localTheme f)
458−
459−instance HasTheme t m => HasTheme t (ReaderT x m)
460−instance HasTheme t m => HasTheme t (BehaviorWriterT t x m)
461−instance HasTheme t m => HasTheme t (DynamicWriterT t x m)
462−instance HasTheme t m => HasTheme t (EventWriterT t x m)
463−instance HasTheme t m => HasTheme t (NodeIdT m)
464−instance HasTheme t m => HasTheme t (Input t m)
465−instance HasTheme t m => HasTheme t (ImageWriter t m)
466−instance HasTheme t m => HasTheme t (DisplayRegion t m)
467−instance HasTheme t m => HasTheme t (FocusReader t m)
468−
469−-- | A widget that has access to theme information
470−newtype ThemeReader t m a = ThemeReader
471− { unThemeReader :: ReaderT (Behavior t V.Attr) m a }
472− deriving
697+newtype Layout t m a = Layout
698+ { unLayout :: EventWriterT t (First NodeId)
699+ (DynamicWriterT t (Endo [(NodeId, (Bool, Constraint))])
700+ (ReaderT (LayoutCtx t)
701+ (VtyWidget t m))) a
702+ } deriving
473703 ( Functor
474704 , Applicative
475705 , Monad
476− , MonadFix
477706 , MonadHold t
478− , MonadIO
479− , MonadRef
480707 , MonadSample t
708+ , MonadFix
709+ , TriggerEvent t
710+ , PerformEvent t
711+ , NotReady t
712+ , MonadReflexCreateTrigger t
713+ , HasDisplaySize t
714+ , MonadNodeId
481715 )
482716
483−instance (Monad m, Reflex t) => HasTheme t (ThemeReader t m) where
484− theme = ThemeReader ask
485− localTheme f = ThemeReader . local f . unThemeReader
486−
487−deriving instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (ThemeReader t m)
488−deriving instance NotReady t m => NotReady t (ThemeReader t m)
489−deriving instance PerformEvent t m => PerformEvent t (ThemeReader t m)
490−deriving instance PostBuild t m => PostBuild t (ThemeReader t m)
491−deriving instance TriggerEvent t m => TriggerEvent t (ThemeReader t m)
492−instance HasImageWriter t m => HasImageWriter t (ThemeReader t m)
493−
494−instance (Adjustable t m, MonadFix m, MonadHold t m) => Adjustable t (ThemeReader t m) where
495− runWithReplace (ThemeReader a) e = ThemeReader $ runWithReplace a $ fmap unThemeReader e
496− traverseIntMapWithKeyWithAdjust f m e = ThemeReader $ traverseIntMapWithKeyWithAdjust (\k v -> unThemeReader $ f k v) m e
497− traverseDMapWithKeyWithAdjust f m e = ThemeReader $ traverseDMapWithKeyWithAdjust (\k v -> unThemeReader $ f k v) m e
498− traverseDMapWithKeyWithAdjustWithMove f m e = ThemeReader $ traverseDMapWithKeyWithAdjustWithMove (\k v -> unThemeReader $ f k v) m e
499−
500−instance MonadTrans (ThemeReader t) where
501− lift = ThemeReader . lift
502−
503−instance MFunctor (ThemeReader t) where
504− hoist f = ThemeReader . hoist f . unThemeReader
505−
506−instance MonadNodeId m => MonadNodeId (ThemeReader t m)
717+instance MonadTrans (Layout t) where
718+ lift x = Layout $ lift $ lift $ lift $ lift x
719+
720+instance (Adjustable t m, MonadFix m, MonadHold t m) => Adjustable t (Layout t m) where
721+ runWithReplace (Layout a) e = Layout $ runWithReplace a $ fmap unLayout e
722+ traverseIntMapWithKeyWithAdjust f m e = Layout $ traverseIntMapWithKeyWithAdjust (\k v -> unLayout $ f k v) m e
723+ traverseDMapWithKeyWithAdjust f m e = Layout $ traverseDMapWithKeyWithAdjust (\k v -> unLayout $ f k v) m e
724+ traverseDMapWithKeyWithAdjustWithMove f m e = Layout $ traverseDMapWithKeyWithAdjustWithMove (\k v -> unLayout $ f k v) m e
725+
726+runLayout
727+ :: (MonadFix m, MonadHold t m, PostBuild t m, Monad m, MonadNodeId m)
728+ => Dynamic t Orientation
729+ -> Int
730+ -> Event t Int
731+ -> Layout t m a
732+ -> VtyWidget t m a
733+runLayout ddir focus0 focusShift (Layout child) = do
734+ dw <- displayWidth
735+ dh <- displayHeight
736+ let main = ffor3 ddir dw dh $ \d w h -> case d of
737+ Orientation_Column -> h
738+ Orientation_Row -> w
739+ pb <- getPostBuild
740+ rec ((a, focusReq), queriesEndo) <- runReaderT (runDynamicWriterT $ runEventWriterT child) $ LayoutCtx solutionMap focusDemux ddir
741+ let queries = flip appEndo [] <$> queriesEndo
742+ solution = ffor2 main queries $ \sz qs -> Map.fromList
743+ . Map.elems
744+ . computeEdges
745+ . computeSizes sz
746+ . fmap (fmap snd)
747+ . Map.fromList
748+ . zip [0::Integer ..]
749+ $ qs
750+ solutionMap = ffor solution $ \ss -> ffor ss $ \(offset, sz) -> LayoutSegment
751+ { _layoutSegment_offset = offset
752+ , _layoutSegment_size = sz
753+ }
754+ focusable = fmap (Bimap.fromList . zip [0..]) $
755+ ffor queries $ \qs -> fforMaybe qs $ \(nodeId, (f, _)) ->
756+ if f then Just nodeId else Nothing
757+ adjustFocus
758+ :: (Bimap Int NodeId, (Int, Maybe NodeId))
759+ -> Either Int NodeId
760+ -> (Int, Maybe NodeId)
761+ adjustFocus (fm, (cur, _)) (Left shift) =
762+ let ix = (cur + shift) `mod` (max 1 $ Bimap.size fm)
763+ in (ix, Bimap.lookup ix fm)
764+ adjustFocus (fm, (cur, _)) (Right goto) =
765+ let ix = fromMaybe cur $ Bimap.lookupR goto fm
766+ in (ix, Just goto)
767+ focusChange = attachWith
768+ adjustFocus
769+ (current $ (,) <$> focusable <*> focussed)
770+ $ leftmost [Left <$> focusShift, Left 0 <$ pb, Right . getFirst <$> focusReq]
771+ -- A pair (Int, Maybe NodeId) which represents the index
772+ -- that we're trying to focus, and the node that actually gets
773+ -- focused (at that index) if it exists
774+ focussed <- holdDyn (focus0, Nothing) focusChange
775+ let focusDemux = demux $ snd <$> focussed
776+ return a
777+
778+tile
779+ :: (Reflex t, Monad m, MonadNodeId m)
780+ => Dynamic t Constraint
781+ -> Dynamic t Bool
782+ -> VtyWidget t m (Event t x, a)
783+ -> Layout t m a
784+tile con focusable child = do
785+ nodeId <- getNextNodeId
786+ Layout $ tellDyn $ ffor2 con focusable $ \c f -> Endo ((nodeId, (f, c)):)
787+ seg <- Layout $ asks $
788+ fmap (Map.findWithDefault (LayoutSegment 0 0) nodeId) . _layoutCtx_regions
789+ dw <- displayWidth
790+ dh <- displayHeight
791+ o <- askOrientation
792+ let cross = join $ ffor o $ \case
793+ Orientation_Column -> dw
794+ Orientation_Row -> dh
795+ let reg = DynRegion
796+ { _dynRegion_top = ffor2 seg o $ \s -> \case
797+ Orientation_Column -> _layoutSegment_offset s
798+ Orientation_Row -> 0
799+ , _dynRegion_left = ffor2 seg o $ \s -> \case
800+ Orientation_Column -> 0
801+ Orientation_Row -> _layoutSegment_offset s
802+ , _dynRegion_width = ffor3 seg cross o $ \s c -> \case
803+ Orientation_Column -> c
804+ Orientation_Row -> _layoutSegment_size s
805+ , _dynRegion_height = ffor3 seg cross o $ \s c -> \case
806+ Orientation_Column -> _layoutSegment_size s
807+ Orientation_Row -> c
808+ }
809+ focussed <- Layout $ asks _layoutCtx_focusDemux
810+ (focusReq, a) <- Layout $ lift $ lift $ lift $
811+ pane reg (demuxed focussed $ Just nodeId) $ child
812+ Layout $ tellEvent $ First nodeId <$ focusReq
813+ return a
814+
815+data TileConfig t = TileConfig
816+ { _tileConfig_constraint :: Dynamic t Constraint
817+ , _tileConfig_focusable :: Dynamic t Bool
818+ , _tileConfig_clickable :: Behavior t Bool
819+ }
507820
508−-- | Run a 'ThemeReader' action with the given focus value
509−runThemeReader
821+instance Reflex t => Default (TileConfig t) where
822+ def = TileConfig (pure $ Constraint_Min 0) (pure True) (pure True)
823+
824+fixed
825+ :: (Reflex t, Monad m, MonadNodeId m)
826+ => Dynamic t Int
827+ -> VtyWidget t m a
828+ -> Layout t m a
829+fixed sz = tile (Constraint_Fixed <$> sz) (pure True) . clickable
830+
831+stretch
832+ :: (Reflex t, Monad m, MonadNodeId m)
833+ => VtyWidget t m a
834+ -> Layout t m a
835+stretch = tile (Constraint_Min <$> 0) (pure True) . clickable
836+
837+col
838+ :: (MonadFix m, MonadHold t m, PostBuild t m, MonadNodeId m)
839+ => Layout t m a
840+ -> VtyWidget t m a
841+col child = do
842+ nav <- tabNavigation
843+ runLayout (pure Orientation_Column) 0 nav child
844+
845+row
846+ :: (MonadFix m, MonadHold t m, PostBuild t m, MonadNodeId m)
847+ => Layout t m a
848+ -> VtyWidget t m a
849+row child = do
850+ nav <- tabNavigation
851+ runLayout (pure Orientation_Column) 0 nav child
852+
853+tabNavigation :: (Reflex t, Monad m) => VtyWidget t m (Event t Int)
854+tabNavigation = do
855+ fwd <- fmap (const 1) <$> key (V.KChar '\t')
856+ back <- fmap (const (-1)) <$> key V.KBackTab
857+ return $ leftmost [fwd, back]
858+
859+clickable
510860 :: (Reflex t, Monad m)
511− => Behavior t V.Attr
512− -> ThemeReader t m a
513− -> m a
514−runThemeReader b = flip runReaderT b . unThemeReader
515−
516−
517−-- ** Manipulating images
518−
519−-- | Translates and crops an 'Image' so that it is contained by
520−-- the given 'Region'.
521−withinImage
522− :: Region
523− -> Image
524− -> Image
525−withinImage (Region left top width height)
526− | width < 0 || height < 0 = withinImage (Region left top 0 0)
527− | otherwise = V.translate left top . V.crop width height
528−
529−-- | Crop a behavior of images to a behavior of regions. See 'withinImage'.
530−imagesInRegion
531− :: Reflex t
532− => Behavior t Region
533− -> Behavior t [Image]
534− -> Behavior t [Image]
535−imagesInRegion reg = liftA2 (\r is -> map (withinImage r) is) reg
536−
537−-- * Running sub-widgets
538−
539−-- | Low-level widget combinator that runs a child widget within
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
546−pane
547− :: (Reflex t, Monad m, HasInput t m, HasImageWriter t m, HasDisplayRegion t m, HasFocusReader t m)
548− => Dynamic t Region
549− -> Dynamic t Bool -- ^ Whether the widget should be focused when the parent is.
550− -> m a
551− -> m a
552−pane dr foc child = localRegion (const dr) $
553− mapImages (imagesInRegion $ current dr) $
554− localFocus (const foc) $
555− inputInFocusedRegion >>= \e -> localInput (const e) child
556−
557−-- * Misc
558−
559−-- | A widget that draws nothing
560−blank :: Monad m => m ()
561−blank = return ()
861+ => VtyWidget t m a
862+ -> VtyWidget t m (Event t (), a)
863+clickable child = do
864+ click <- mouseDown V.BLeft
865+ a <- child
866+ return (() <$ click, a)
867+
868+askOrientation :: Monad m => Layout t m (Dynamic t Orientation)
869+askOrientation = Layout $ asks _layoutCtx_orientation