@@ -9,7 +9,6 @@
99{-# LANGUAGE GADTs #-}
1010{-# LANGUAGE GeneralizedNewtypeDeriving #-}
1111{-# LANGUAGE LambdaCase #-}
12−{-# LANGUAGE MultiWayIf #-}
1312{-# LANGUAGE RankNTypes #-}
1413{-# LANGUAGE RoleAnnotations #-}
1514{-# LANGUAGE ScopedTypeVariables #-}
@@ -20,7 +19,7 @@
2019{-# LANGUAGE DeriveFunctor #-}
2120{-# LANGUAGE StandaloneDeriving #-}
2221{-# LANGUAGE InstanceSigs #-}
23−{-# LANGUAGE RecursiveDo #-}
22+{-# LANGUAGE MultiWayIf #-}
2423
2524#ifdef USE_REFLEX_OPTIMIZER
2625{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
@@ -39,15 +38,17 @@ import Control.Monad hiding (forM, forM_, mapM, mapM_)
3938import Control.Monad.Exception
4039import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_)
4140import Control.Monad.Primitive
42−--import Control.Monad.Reader hiding (forM, forM_, mapM, mapM_)
4341import Control.Monad.Reader.Class
4442import Control.Monad.IO.Class
4543import Control.Monad.ReaderIO
4644import Control.Monad.Ref
45+import Control.Monad.Fail (MonadFail)
46+import qualified Control.Monad.Fail as MonadFail
4747import Data.Align
4848import Data.Coerce
49−import Data.Dependent.Map (DMap, DSum (..))
49+import Data.Dependent.Map (DMap)
5050import qualified Data.Dependent.Map as DMap
51+import Data.Dependent.Sum (DSum (..))
5152import Data.FastMutableIntMap (FastMutableIntMap, PatchIntMap (..))
5253import qualified Data.FastMutableIntMap as FastMutableIntMap
5354import Data.Foldable hiding (concat, elem, sequence_)
@@ -64,6 +65,7 @@ import Data.Monoid (mempty, (<>))
6465import Data.Proxy
6566import Data.These
6667import Data.Traversable
68+import Data.Type.Equality ((:~:)(Refl))
6769import Data.Witherable (Filterable, mapMaybe)
6870import GHC.Exts hiding (toList)
6971import GHC.IORef (IORef (..))
@@ -104,15 +106,21 @@ import qualified Reflex.Class
104106import qualified Reflex.Class as R
105107import qualified Reflex.Host.Class
106108import Reflex.NotReady.Class
107−import Reflex.Patch
108−import qualified Reflex.Patch.DMapWithMove as PatchDMapWithMove
109+import Data.Patch
110+import qualified Data.Patch.DMapWithMove as PatchDMapWithMove
109111import Reflex.PerformEvent.Base (PerformEventT)
110112
111113#ifdef DEBUG_TRACE_EVENTS
112114import qualified Data.ByteString.Char8 as BS8
113115import System.IO (stderr)
114116import Data.List (isPrefixOf)
117+#endif
115118
119+-- TODO stdout might not be the best channel for debug output
120+debugStrLn :: String -> IO ()
121+debugStrLn = putStrLn
122+
123+#ifdef DEBUG_TRACE_EVENTS
116124withStackOneLine :: (BS8.ByteString -> a) -> a
117125withStackOneLine expr = unsafePerformIO $ do
118126 stack <- currentCallStack
@@ -121,9 +129,33 @@ withStackOneLine expr = unsafePerformIO $ do
121129
122130#endif
123131
132+debugPropagate :: Bool
133+
134+debugInvalidateHeight :: Bool
135+
136+debugInvalidate :: Bool
137+
124138#ifdef DEBUG
125139#define DEBUG_NODEIDS
126140
141+#ifdef DEBUG_TRACE_PROPAGATION
142+debugPropagate = True
143+#else
144+debugPropagate = False
145+#endif
146+
147+#ifdef DEBUG_TRACE_HEIGHT
148+debugInvalidateHeight = True
149+#else
150+debugInvalidateHeight = False
151+#endif
152+
153+#ifdef DEBUG_TRACE_INVALIDATION
154+debugInvalidate = True
155+#else
156+debugInvalidate = False
157+#endif
158+
127159class HasNodeId a where
128160 getNodeId :: a -> Int
129161
@@ -161,6 +193,10 @@ showNodeId' = ("#"<>) . show
161193
162194#else
163195
196+debugPropagate = False
197+debugInvalidateHeight = False
198+debugInvalidate = False
199+
164200-- This must be inline, or error messages will cause memory leaks due to retaining the node in question
165201{-# INLINE showNodeId #-}
166202showNodeId :: a -> String
@@ -217,11 +253,11 @@ subscribeAndRead = unEvent
217253{-# INLINE [1] pushCheap #-}
218254pushCheap :: HasSpiderTimeline x => (a -> ComputeM x (Maybe b)) -> Event x a -> Event x b
219255pushCheap !f e = Event $ \sub -> do
220− (subscription, occ) <- subscribeAndRead e $ debugSubscriber' "push" (sub
256+ (subscription, occ) <- subscribeAndRead e $ debugSubscriber' "push" $ sub
221257 { subscriberPropagate = \a -> do
222258 mb <- f a
223259 mapM_ (subscriberPropagate sub) mb
224− })
260+ }
225261 occ' <- join <$> mapM f occ
226262 return (subscription, occ')
227263
@@ -271,7 +307,20 @@ data CacheSubscribed x a
271307#endif
272308 }
273309
274−
310+nowSpiderEventM :: (HasSpiderTimeline x) => EventM x (R.Event (SpiderTimeline x) ())
311+nowSpiderEventM =
312+ SpiderEvent <$> now
313+
314+now :: (MonadIO m, Defer (Some Clear) m, HasSpiderTimeline x
315+ ) => m (Event x ())
316+now = do
317+ nowOrNot <- liftIO $ newIORef $ Just ()
318+ scheduleClear nowOrNot
319+ return . Event $ \_ -> do
320+ occ <- liftIO . readIORef $ nowOrNot
321+ return ( EventSubscription (return ()) eventSubscribedNow
322+ , occ
323+ )
275324
276325-- | Construct an 'Event' whose value is guaranteed not to be recomputed
277326-- repeatedly
@@ -415,16 +464,6 @@ data Subscriber x a = Subscriber
415464 , subscriberRecalculateHeight :: !(Height -> IO ())
416465 }
417466
418−--TODO: Move this comment to WeakBag
419−-- These function are constructor functions that are marked NOINLINE so they are
420−-- opaque to GHC. If we do not do this, then GHC will sometimes fuse the constructor away
421−-- so any weak references that are attached to the constructors will have their
422−-- finalizer run. Using the opaque constructor, does not see the
423−-- constructor application, so it behaves like an IORef and cannot be fused away.
424−--
425−-- The result is also evaluated to WHNF, since forcing a thunk invalidates
426−-- the weak pointer to it in some cases.
427−
428467newSubscriberHold :: (HasSpiderTimeline x, Patch p) => Hold x p -> IO (Subscriber x p)
429468newSubscriberHold h = return $ Subscriber
430469 { subscriberPropagate = {-# SCC "traverseHold" #-} propagateSubscriberHold h
@@ -568,6 +607,16 @@ eventSubscribedNever = EventSubscribed
568607 , eventSubscribedWhoCreated = return ["never"]
569608#endif
570609 }
610+eventSubscribedNow :: EventSubscribed x
611+eventSubscribedNow = EventSubscribed
612+ { eventSubscribedHeightRef = zeroRef
613+ , eventSubscribedRetained = toAny ()
614+#ifdef DEBUG_CYCLES
615+ , eventSubscribedGetParents = return []
616+ , eventSubscribedHasOwnHeightRef = False
617+ , eventSubscribedWhoCreated = return ["now"]
618+#endif
619+ }
571620
572621eventSubscribedFan :: FanSubscribed x k v -> EventSubscribed x
573622eventSubscribedFan !subscribed = EventSubscribed
@@ -945,8 +994,10 @@ instance Monad (BehaviorM x) where
945994 BehaviorM x >> BehaviorM y = BehaviorM $ x >> y
946995 {-# INLINE return #-}
947996 return x = BehaviorM $ return x
997+#if !MIN_VERSION_base(4,13,0)
948998 {-# INLINE fail #-}
949999 fail s = BehaviorM $ fail s
1000+#endif
9501001
9511002data BehaviorSubscribed x a
9521003 = forall p. BehaviorSubscribedHold (Hold x p)
@@ -1295,7 +1346,7 @@ mkWeakPtrWithDebug x debugNote = do
12951346 x' <- evaluate x
12961347 mkWeakPtr x' $
12971348 if debugFinalize
1298− then Just $ putStrLn $ "finalizing: " ++ debugNote
1349+ then Just $ debugStrLn $ "finalizing: " ++ debugNote
12991350 else Nothing
13001351
13011352type WeakList a = [Weak a]
@@ -1317,13 +1368,13 @@ debugSubscriber' description subscribed = Subscriber
13171368 tracePropagate (Proxy :: Proxy x) ("subscriberPropagate: " <> description)
13181369 subscriberPropagate subscribed m
13191370 , subscriberInvalidateHeight = \old -> do
1320− putStrLn $ "invalidateSubscriberHeight: " <> description <> ", old = " <> show (unHeight old)
1371+ traceInvalidateHeight $ "invalidateSubscriberHeight: " <> description <> ", old = " <> show (unHeight old)
13211372 subscriberInvalidateHeight subscribed old
1322− putStrLn $ "invalidateSubscriberHeight: " <> description <> ", done"
1373+ traceInvalidateHeight $ "invalidateSubscriberHeight: " <> description <> ", done"
13231374 , subscriberRecalculateHeight = \new -> do
1324− putStrLn $ "subscriberRecalculateHeight: " <> description <> ", new = " <> show (unHeight new)
1375+ traceInvalidateHeight $ "subscriberRecalculateHeight: " <> description <> ", new = " <> show (unHeight new)
13251376 subscriberRecalculateHeight subscribed new
1326− putStrLn $ "subscriberRecalculateHeight: " <> description <> ", done"
1377+ traceInvalidateHeight $ "subscriberRecalculateHeight: " <> description <> ", done"
13271378 }
13281379
13291380
@@ -1337,11 +1388,15 @@ withIncreasedDepth _ a = do
13371388
13381389{-# INLINE tracePropagate #-}
13391390tracePropagate :: (CanTrace x m) => proxy x -> String -> m ()
1340−tracePropagate p = trace p
1391+tracePropagate p = when debugPropagate . trace p
13411392
13421393{-# INLINE traceInvalidate #-}
13431394traceInvalidate :: String -> IO ()
1344−traceInvalidate = liftIO . putStrLn
1395+traceInvalidate = when debugInvalidate . liftIO . debugStrLn
1396+
1397+{-# INLINE traceInvalidateHeight #-}
1398+traceInvalidateHeight :: String -> IO ()
1399+traceInvalidateHeight = when debugInvalidateHeight . liftIO . debugStrLn
13451400
13461401{-# INLINE trace #-}
13471402trace :: (CanTrace x m) => proxy x -> String -> m ()
@@ -1352,7 +1407,7 @@ traceM :: forall x proxy m. (CanTrace x m) => proxy x -> m String -> m ()
13521407traceM _ getMessage = do
13531408 message <- getMessage
13541409 d <- liftIO $ readIORef $ _spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)
1355− liftIO $ putStrLn $ replicate d ' ' <> message
1410+ liftIO $ debugStrLn $ replicate d ' ' <> message
13561411
13571412#else
13581413
@@ -1368,6 +1423,10 @@ tracePropagate _ _ = return ()
13681423traceInvalidate :: String -> IO ()
13691424traceInvalidate _ = return ()
13701425
1426+{-# INLINE traceInvalidateHeight #-}
1427+traceInvalidateHeight :: String -> IO ()
1428+traceInvalidateHeight _ = return ()
1429+
13711430{-# INLINE debugSubscriber #-}
13721431debugSubscriber :: String -> Subscriber x a -> IO (Subscriber x a)
13731432debugSubscriber _ = return
@@ -1408,8 +1467,11 @@ showStacks :: [[String]] -> String
14081467showStacks = drawForest . listsToForest . fmap (filterStack "Reflex.Spider.Internal")
14091468
14101469filterStack :: String -> [String] -> [String]
1470+#ifdef DEBUG_HIDE_INTERNALS
14111471filterStack prefix = filter (not . (prefix `isPrefixOf`))
1412−
1472+#else
1473+filterStack prefix = id
1474+#endif
14131475
14141476#ifdef DEBUG_CYCLES
14151477
@@ -1436,7 +1498,7 @@ instance Show EventLoopException where
14361498{-# INLINE propagateSubscriberHold #-}
14371499propagateSubscriberHold :: forall x p. (HasSpiderTimeline x, Patch p) => Hold x p -> p -> EventM x ()
14381500propagateSubscriberHold h a = do
1439− traceM (Proxy :: Proxy x) $ liftIO $ do
1501+ {-# SCC "trace" #-} when debugPropagate $ traceM (Proxy :: Proxy x) $ liftIO $ do
14401502 invalidators <- liftIO $ readIORef $ holdInvalidators h
14411503 return $ "SubscriberHold" <> showNodeId h <> ": " ++ show (length invalidators)
14421504
@@ -1444,7 +1506,7 @@ propagateSubscriberHold h a = do
14441506 case {-# SCC "apply" #-} apply a v of
14451507 Nothing -> return ()
14461508 Just v' -> do
1447− withIncreasedDepth (Proxy :: Proxy x) $
1509+ {-# SCC "trace2" #-} withIncreasedDepth (Proxy :: Proxy x) $
14481510 tracePropagate (Proxy :: Proxy x) ("propagateSubscriberHold: assigning Hold" <> showNodeId h)
14491511 vRef <- {-# SCC "vRef" #-} liftIO $ evaluate $ holdValue h
14501512 iRef <- {-# SCC "iRef" #-} liftIO $ evaluate $ holdInvalidators h
@@ -1976,7 +2038,7 @@ revalidateMergeHeight m = do
19762038 LT -> return ()
19772039 EQ -> do
19782040 let height = succHeight $ heightBagMax heights
1979− traceInvalidate $ "recalculateSubscriberHeight: height: " <> show height
2041+ traceInvalidateHeight $ "recalculateSubscriberHeight: height: " <> show height
19802042 writeIORef (_merge_heightRef m) $! height
19812043 subscriberRecalculateHeight (_merge_sub m) height
19822044 GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show (DMap.size parents) <> ") for Merge"
@@ -2140,7 +2202,7 @@ mergeIntCheap d = Event $ \sub -> do
21402202 LT -> return ()
21412203 EQ -> do
21422204 let height = succHeight $ heightBagMax heights
2143− traceInvalidate $ "recalculateSubscriberHeight: height: " <> show height
2205+ traceInvalidateHeight $ "recalculateSubscriberHeight: height: " <> show height
21442206 writeIORef heightRef $! height
21452207 subscriberRecalculateHeight sub height
21462208 GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show numParents <> ") for Merge"
@@ -2323,7 +2385,7 @@ runFrame a = SpiderHost $ do
23232385 subscription <- unSpiderHost $ runFrame $ {-# SCC "subscribeSwitch" #-} subscribe e sub --TODO: Assert that the event isn't firing --TODO: This should not loop because none of the events should be firing, but still, it is inefficient
23242386 {-
23252387 stackTrace <- liftIO $ fmap renderStack $ ccsToStrings =<< (getCCSOf $! switchSubscribedParent subscribed)
2326− liftIO $ putStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
2388+ liftIO $ debugStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
23272389 EventRoot _ -> "EventRoot"
23282390 EventNever -> "EventNever"
23292391 _ -> "something else"
@@ -2458,6 +2520,8 @@ instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Event
24582520 {-# INLINABLE headE #-}
24592521 headE = R.slowHeadE
24602522-- headE (SpiderEvent e) = SpiderEvent <$> Reflex.Spider.Internal.headE e
2523+ {-# INLINABLE now #-}
2524+ now = nowSpiderEventM
24612525
24622526instance Reflex.Class.MonadSample (SpiderTimeline x) (SpiderPullM x) where
24632527 {-# INLINABLE sample #-}
@@ -2479,6 +2543,9 @@ instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Spide
24792543 {-# INLINABLE headE #-}
24802544 headE = R.slowHeadE
24812545-- headE (SpiderEvent e) = SpiderPushM $ SpiderEvent <$> Reflex.Spider.Internal.headE e
2546+ {-# INLINABLE now #-}
2547+ now = SpiderPushM nowSpiderEventM
2548+
24822549
24832550instance HasSpiderTimeline x => Monad (Reflex.Class.Dynamic (SpiderTimeline x)) where
24842551 {-# INLINE return #-}
@@ -2487,8 +2554,10 @@ instance HasSpiderTimeline x => Monad (Reflex.Class.Dynamic (SpiderTimeline x))
24872554 x >>= f = SpiderDynamic $ dynamicDynIdentity $ newJoinDyn $ newMapDyn (unSpiderDynamic . f) $ unSpiderDynamic x
24882555 {-# INLINE (>>) #-}
24892556 (>>) = (*>)
2557+#if !MIN_VERSION_base(4,13,0)
24902558 {-# INLINE fail #-}
24912559 fail _ = error "Dynamic does not support 'fail'"
2560+#endif
24922561
24932562{-# INLINABLE newJoinDyn #-}
24942563newJoinDyn :: HasSpiderTimeline x => DynamicS x (Identity (DynamicS x (Identity a))) -> Reflex.Spider.Internal.Dyn x (Identity a)
@@ -2540,6 +2609,9 @@ instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Spide
25402609 buildDynamic getV0 e = runFrame . runSpiderHostFrame $ Reflex.Class.buildDynamic getV0 e
25412610 {-# INLINABLE headE #-}
25422611 headE e = runFrame . runSpiderHostFrame $ Reflex.Class.headE e
2612+ {-# INLINABLE now #-}
2613+ now = runFrame . runSpiderHostFrame $ Reflex.Class.now
2614+
25432615
25442616instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHostFrame x) where
25452617 sample = SpiderHostFrame . readBehaviorUntracked . unSpiderBehavior --TODO: This can cause problems with laziness, so we should get rid of it if we can
@@ -2556,6 +2628,8 @@ instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Spide
25562628 {-# INLINABLE headE #-}
25572629 headE = R.slowHeadE
25582630-- headE (SpiderEvent e) = SpiderHostFrame $ SpiderEvent <$> Reflex.Spider.Internal.headE e
2631+ {-# INLINABLE now #-}
2632+ now = SpiderHostFrame Reflex.Class.now
25592633
25602634instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHost x) where
25612635 {-# INLINABLE sample #-}
@@ -2576,6 +2650,8 @@ instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Refle
25762650 buildDynamic getV0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.buildDynamic getV0 e
25772651 {-# INLINABLE headE #-}
25782652 headE e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.headE e
2653+ {-# INLINABLE now #-}
2654+ now = Reflex.Spider.Internal.ReadPhase Reflex.Class.now
25792655
25802656--------------------------------------------------------------------------------
25812657-- Deprecated items
@@ -2699,7 +2775,7 @@ instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
26992775 fanG e = R.EventSelectorG $ SpiderEvent . selectG (fanG (unSpiderEvent e))
27002776 {-# INLINABLE mergeG #-}
27012777 mergeG
2702− :: forall (k :: k2 -> *) q (v :: k2 -> *). GCompare k
2778+ :: forall k2 (k :: k2 -> *) q (v :: k2 -> *). GCompare k
27032779 => (forall a. q a -> R.Event (SpiderTimeline x) (v a))
27042780 -> DMap k q
27052781 -> R.Event (SpiderTimeline x) (DMap k v)
@@ -2767,8 +2843,14 @@ instance Monad (SpiderHost x) where
27672843 SpiderHost x >> SpiderHost y = SpiderHost $ x >> y
27682844 {-# INLINABLE return #-}
27692845 return x = SpiderHost $ return x
2846+#if !MIN_VERSION_base(4,13,0)
27702847 {-# INLINABLE fail #-}
2771− fail s = SpiderHost $ fail s
2848+ fail = MonadFail.fail
2849+#endif
2850+
2851+instance MonadFail (SpiderHost x) where
2852+ {-# INLINABLE fail #-}
2853+ fail s = SpiderHost $ MonadFail.fail s
27722854
27732855-- | Run an action affecting the global Spider timeline; this will be guarded by
27742856-- a mutex for that timeline
@@ -2790,8 +2872,10 @@ instance Monad (SpiderHostFrame x) where
27902872 SpiderHostFrame x >> SpiderHostFrame y = SpiderHostFrame $ x >> y
27912873 {-# INLINABLE return #-}
27922874 return x = SpiderHostFrame $ return x
2875+#if !MIN_VERSION_base(4,13,0)
27932876 {-# INLINABLE fail #-}
27942877 fail s = SpiderHostFrame $ fail s
2878+#endif
27952879
27962880instance NotReady (SpiderTimeline x) (SpiderHostFrame x) where
27972881 notReadyUntil _ = pure ()