@@ -1,82 +1,210 @@
1−{-# LANGUAGE CPP, ExistentialQuantification, GADTs, ScopedTypeVariables, TypeFamilies, FlexibleInstances, MultiParamTypeClasses, GeneralizedNewtypeDeriving, RankNTypes, BangPatterns, UndecidableInstances, EmptyDataDecls, RecursiveDo, RoleAnnotations, LambdaCase #-}
2−module Reflex.Spider.Internal where
3−
4−import Prelude hiding (mapM, mapM_, any, sequence, concat)
5−
6−import qualified Reflex.Class as R
7−import qualified Reflex.Host.Class as R
1+{-# LANGUAGE BangPatterns #-}
2+{-# LANGUAGE CPP #-}
3+{-# LANGUAGE ConstraintKinds #-}
4+{-# LANGUAGE EmptyDataDecls #-}
5+{-# LANGUAGE ExistentialQuantification #-}
6+{-# LANGUAGE FlexibleContexts #-}
7+{-# LANGUAGE FlexibleInstances #-}
8+{-# LANGUAGE FunctionalDependencies #-}
9+{-# LANGUAGE GADTs #-}
10+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
11+{-# LANGUAGE LambdaCase #-}
12+{-# LANGUAGE RankNTypes #-}
13+{-# LANGUAGE RoleAnnotations #-}
14+{-# LANGUAGE ScopedTypeVariables #-}
15+{-# LANGUAGE TypeFamilies #-}
16+{-# LANGUAGE TypeOperators #-}
17+{-# LANGUAGE UndecidableInstances #-}
18+{-# LANGUAGE PolyKinds #-}
19+{-# LANGUAGE DeriveFunctor #-}
20+{-# LANGUAGE StandaloneDeriving #-}
21+{-# LANGUAGE InstanceSigs #-}
22+{-# LANGUAGE MultiWayIf #-}
23+
24+#ifdef USE_REFLEX_OPTIMIZER
25+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
26+#endif
27+{-# OPTIONS_GHC -Wunused-binds #-}
28+-- | This module is the implementation of the 'Spider' 'Reflex' engine. It uses
29+-- a graph traversal algorithm to propagate 'Event's and 'Behavior's.
30+module Reflex.Spider.Internal (module Reflex.Spider.Internal) where
831
9−import Data.IORef
10−import System.Mem.Weak
11−import Data.Foldable
12−import Data.Traversable
13−import Control.Monad hiding (mapM, mapM_, forM_, forM, sequence)
14−import Control.Monad.Reader hiding (mapM, mapM_, forM_, forM, sequence)
15−import GHC.Exts
16−import Control.Applicative
17−import Data.Dependent.Map (DMap, DSum (..))
32+#if MIN_VERSION_base(4,10,0)
33+import Control.Applicative (liftA2)
34+#endif
35+import Control.Concurrent
36+import Control.Exception
37+import Control.Monad hiding (forM, forM_, mapM, mapM_)
38+import Control.Monad.Exception
39+import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_)
40+import Control.Monad.Primitive
41+import Control.Monad.Reader.Class
42+import Control.Monad.IO.Class
43+import Control.Monad.ReaderIO
44+import Control.Monad.Ref
45+import Control.Monad.Fail (MonadFail)
46+import qualified Control.Monad.Fail as MonadFail
47+import Data.Align
48+import Data.Coerce
49+import Data.Dependent.Map (DMap)
1850import qualified Data.Dependent.Map as DMap
19−import Data.GADT.Compare
51+import Data.Dependent.Sum (DSum (..))
52+import Data.FastMutableIntMap (FastMutableIntMap, PatchIntMap (..))
53+import qualified Data.FastMutableIntMap as FastMutableIntMap
54+import Data.Foldable hiding (concat, elem, sequence_)
55+import Data.Functor.Constant
2056import Data.Functor.Misc
21−import Data.Maybe
22−import Data.IntMap (IntMap)
23−import qualified Data.IntMap as IntMap
24−import Control.Lens hiding (coerce)
25−import Control.Monad.TypedId
26−import Control.Monad.Ref
27−import Data.Monoid ((<>))
28−
57+import Data.Functor.Product
58+import Data.GADT.Compare
59+import Data.IntMap.Strict (IntMap)
60+import qualified Data.IntMap.Strict as IntMap
61+import Data.IORef
62+import Data.Kind (Type)
63+import Data.Maybe hiding (mapMaybe)
64+import Data.Monoid (mempty, (<>))
65+import Data.Proxy
66+import Data.These
67+import Data.Traversable
68+import Data.Type.Equality ((:~:)(Refl))
69+import Data.Witherable (Filterable, mapMaybe)
70+import GHC.Exts hiding (toList)
71+import GHC.IORef (IORef (..))
72+import GHC.Stack
73+import Reflex.FastWeak
2974import System.IO.Unsafe
75+import System.Mem.Weak
3076import Unsafe.Coerce
31−import Control.Monad.Primitive
77+
78+#ifdef MIN_VERSION_semialign
79+#if MIN_VERSION_these(0,8,0)
80+import Data.These.Combinators (justThese)
81+#endif
82+#if MIN_VERSION_semialign(1,1,0)
83+import Data.Zip (Zip (..))
84+#endif
85+#endif
86+
87+#ifdef DEBUG_CYCLES
88+import Control.Monad.State hiding (forM, forM_, mapM, mapM_, sequence)
89+#endif
90+
91+import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
92+import qualified Data.List.NonEmpty as NonEmpty
93+import Data.Tree (Forest, Tree (..), drawForest)
94+import Data.List (isPrefixOf)
95+
96+import Data.FastWeakBag (FastWeakBag, FastWeakBagTicket)
97+import qualified Data.FastWeakBag as FastWeakBag
98+
99+import Data.Reflection
100+import Data.Some (Some(Some))
101+import Data.Type.Coercion
102+import Data.Profunctor.Unsafe ((#.), (.#))
103+import Data.WeakBag (WeakBag, WeakBagTicket, _weakBag_children)
104+import qualified Data.WeakBag as WeakBag
105+import qualified Reflex.Class
106+import qualified Reflex.Class as R
107+import qualified Reflex.Host.Class
108+import Reflex.NotReady.Class
109+import Data.Patch
110+import qualified Data.Patch.DMapWithMove as PatchDMapWithMove
111+import Reflex.PerformEvent.Base (PerformEventT)
112+
113+#ifdef DEBUG_TRACE_EVENTS
114+import qualified Data.ByteString.Char8 as BS8
115+import System.IO (stderr)
116+import Data.List (isPrefixOf)
117+#endif
118+
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
124+withStackOneLine :: (BS8.ByteString -> a) -> a
125+withStackOneLine expr = unsafePerformIO $ do
126+ stack <- currentCallStack
127+ return (expr . BS8.pack . unwords . dropInternal . reverse $ stack)
128+ where dropInternal = filterStack "Reflex.Spider.Internal"
129+
130+#endif
32131
33132debugPropagate :: Bool
34133
35134debugInvalidateHeight :: Bool
36135
37−#ifdef DEBUG
136+debugInvalidate :: Bool
38137
138+#ifdef DEBUG
39139#define DEBUG_NODEIDS
40140
141+#ifdef DEBUG_TRACE_PROPAGATION
41142debugPropagate = True
143+#else
144+debugPropagate = False
145+#endif
42146
147+#ifdef DEBUG_TRACE_HEIGHT
43148debugInvalidateHeight = True
149+#else
150+debugInvalidateHeight = False
151+#endif
152+
153+#ifdef DEBUG_TRACE_INVALIDATION
154+debugInvalidate = True
155+#else
156+debugInvalidate = False
157+#endif
44158
45159class HasNodeId a where
46160 getNodeId :: a -> Int
47161
48−instance HasNodeId (Hold a) where
49− getNodeId = holdNodeId
162+instance HasNodeId (CacheSubscribed x a) where
163+ getNodeId = _cacheSubscribed_nodeId
50164
51−instance HasNodeId (PushSubscribed a b) where
52− getNodeId = pushSubscribedNodeId
165+instance HasNodeId (FanInt x a) where
166+ getNodeId = _fanInt_nodeId
53167
54−instance HasNodeId (SwitchSubscribed a) where
55− getNodeId = switchSubscribedNodeId
168+instance HasNodeId (Hold x p) where
169+ getNodeId = holdNodeId
56170
57−instance HasNodeId (MergeSubscribed a) where
58− getNodeId = mergeSubscribedNodeId
171+instance HasNodeId (SwitchSubscribed x a) where
172+ getNodeId = switchSubscribedNodeId
59173
60−instance HasNodeId (FanSubscribed a) where
174+instance HasNodeId (FanSubscribed x v a) where
61175 getNodeId = fanSubscribedNodeId
62176
63−instance HasNodeId (CoincidenceSubscribed a) where
177+instance HasNodeId (CoincidenceSubscribed x a) where
64178 getNodeId = coincidenceSubscribedNodeId
65179
66−instance HasNodeId (RootSubscribed a) where
180+instance HasNodeId (RootSubscribed x a) where
67181 getNodeId = rootSubscribedNodeId
68182
183+instance HasNodeId (Pull x a) where
184+ getNodeId = pullNodeId
185+
186+{-# INLINE showNodeId #-}
69187showNodeId :: HasNodeId a => a -> String
70−showNodeId = ("#"<>) . show . getNodeId
188+showNodeId = showNodeId' . getNodeId
189+
190+showNodeId' :: Int -> String
191+showNodeId' = ("#"<>) . show
192+
71193
72194#else
73195
74196debugPropagate = False
75−
76197debugInvalidateHeight = False
198+debugInvalidate = False
77199
200+-- This must be inline, or error messages will cause memory leaks due to retaining the node in question
201+{-# INLINE showNodeId #-}
78202showNodeId :: a -> String
79−showNodeId = const ""
203+showNodeId _ = ""
204+
205+{-# INLINE showNodeId' #-}
206+showNodeId' :: Int -> String
207+showNodeId' _ = ""
80208
81209#endif
82210
@@ -85,873 +213,1632 @@ showNodeId = const ""
85213nextNodeIdRef :: IORef Int
86214nextNodeIdRef = unsafePerformIO $ newIORef 1
87215
88−{-# NOINLINE unsafeNodeId #-}
89−unsafeNodeId :: a -> Int
90−unsafeNodeId a = unsafePerformIO $ do
91− touch a
92− atomicModifyIORef' nextNodeIdRef $ \n -> (succ n, n)
216+newNodeId :: IO Int
217+newNodeId = atomicModifyIORef' nextNodeIdRef $ \n -> (succ n, n)
218+#endif
219+
220+--------------------------------------------------------------------------------
221+-- EventSubscription
222+--------------------------------------------------------------------------------
223+
224+--NB: Once you subscribe to an Event, you must always hold on the the WHOLE EventSubscription you get back
225+-- If you do not retain the subscription, you may be prematurely unsubscribed from the parent event.
226+data EventSubscription x = EventSubscription
227+ { _eventSubscription_unsubscribe :: !(IO ())
228+ , _eventSubscription_subscribed :: {-# UNPACK #-} !(EventSubscribed x)
229+ }
230+
231+unsubscribe :: EventSubscription x -> IO ()
232+unsubscribe (EventSubscription u _) = u
233+
234+--------------------------------------------------------------------------------
235+-- Event
236+--------------------------------------------------------------------------------
237+
238+newtype Event x a = Event { unEvent :: Subscriber x a -> EventM x (EventSubscription x, Maybe a) }
239+
240+{-# INLINE subscribeAndRead #-}
241+subscribeAndRead :: Event x a -> Subscriber x a -> EventM x (EventSubscription x, Maybe a)
242+subscribeAndRead = unEvent
243+
244+{-# RULES
245+"cacheEvent/cacheEvent" forall e. cacheEvent (cacheEvent e) = cacheEvent e
246+"cacheEvent/pushCheap" forall f e. pushCheap f (cacheEvent e) = cacheEvent (pushCheap f e)
247+"hold/cacheEvent" forall f e. hold f (cacheEvent e) = hold f e
248+ #-}
249+
250+-- | Construct an 'Event' equivalent to that constructed by 'push', but with no
251+-- caching; if the computation function is very cheap, this is (much) more
252+-- efficient than 'push'
253+{-# INLINE [1] pushCheap #-}
254+pushCheap :: HasSpiderTimeline x => (a -> ComputeM x (Maybe b)) -> Event x a -> Event x b
255+pushCheap !f e = Event $ \sub -> do
256+ (subscription, occ) <- subscribeAndRead e $ debugSubscriber' "push" $ sub
257+ { subscriberPropagate = \a -> do
258+ mb <- f a
259+ mapM_ (subscriberPropagate sub) mb
260+ }
261+ occ' <- join <$> mapM f occ
262+ return (subscription, occ')
263+
264+-- | A subscriber that never triggers other 'Event's
265+{-# INLINE terminalSubscriber #-}
266+terminalSubscriber :: (a -> EventM x ()) -> Subscriber x a
267+terminalSubscriber p = Subscriber
268+ { subscriberPropagate = p
269+ , subscriberInvalidateHeight = \_ -> return ()
270+ , subscriberRecalculateHeight = \_ -> return ()
271+ }
272+
273+-- | Subscribe to an Event only for the duration of one occurrence
274+{-# INLINE subscribeAndReadHead #-}
275+subscribeAndReadHead :: HasSpiderTimeline x => Event x a -> Subscriber x a -> EventM x (EventSubscription x, Maybe a)
276+subscribeAndReadHead e sub = do
277+ subscriptionRef <- liftIO $ newIORef $ error "subscribeAndReadHead: not initialized"
278+ (subscription, occ) <- subscribeAndRead e $ debugSubscriber' "head" $ sub
279+ { subscriberPropagate = \a -> do
280+ liftIO $ unsubscribe =<< readIORef subscriptionRef
281+ subscriberPropagate sub a
282+ }
283+ liftIO $ case occ of
284+ Nothing -> writeIORef subscriptionRef $! subscription
285+ Just _ -> unsubscribe subscription
286+ return (subscription, occ)
287+
288+--TODO: Make this lazy in its input event
289+headE :: (MonadIO m, Defer (SomeMergeInit x) m, HasSpiderTimeline x) => Event x a -> m (Event x a)
290+headE originalE = do
291+ parent <- liftIO $ newIORef $ Just originalE
292+ defer $ SomeMergeInit $ do --TODO: Rename SomeMergeInit appropriately
293+ let clearParent = liftIO $ writeIORef parent Nothing
294+ (_, occ) <- subscribeAndReadHead originalE $ terminalSubscriber $ const clearParent
295+ when (isJust occ) clearParent
296+ return $ Event $ \sub ->
297+ liftIO (readIORef parent) >>= \case
298+ Nothing -> subscribeAndReadNever
299+ Just e -> subscribeAndReadHead e sub
300+
301+data CacheSubscribed x a
302+ = CacheSubscribed { _cacheSubscribed_subscribers :: {-# UNPACK #-} !(FastWeakBag (Subscriber x a))
303+ , _cacheSubscribed_parent :: {-# UNPACK #-} !(EventSubscription x)
304+ , _cacheSubscribed_occurrence :: {-# UNPACK #-} !(IORef (Maybe a))
305+#ifdef DEBUG_NODEIDS
306+ , _cacheSubscribed_nodeId :: {-# UNPACK #-} !Int
307+#endif
308+ }
309+
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+ )
324+
325+-- | Construct an 'Event' whose value is guaranteed not to be recomputed
326+-- repeatedly
327+--
328+--TODO: Try a caching strategy where we subscribe directly to the parent when
329+--there's only one subscriber, and then build our own FastWeakBag only when a second
330+--subscriber joins
331+{-# NOINLINE [0] cacheEvent #-}
332+cacheEvent :: forall x a. HasSpiderTimeline x => Event x a -> Event x a
333+cacheEvent e =
334+#ifdef DEBUG_TRACE_EVENTS
335+ withStackOneLine $ \callSite -> Event $
336+#else
337+ Event $
338+#endif
339+ unsafePerformIO $ do
340+ mSubscribedRef :: IORef (FastWeak (CacheSubscribed x a))
341+ <- newIORef emptyFastWeak
342+ pure $ \sub -> {-# SCC "cacheEvent" #-} do
343+#ifdef DEBUG_TRACE_EVENTS
344+ unless (BS8.null callSite) $ liftIO $ BS8.hPutStrLn stderr callSite
345+#endif
346+ subscribedTicket <- liftIO (readIORef mSubscribedRef >>= getFastWeakTicket) >>= \case
347+ Just subscribedTicket -> return subscribedTicket
348+ Nothing -> do
349+#ifdef DEBUG_NODEIDS
350+ nodeId <- liftIO newNodeId
351+#endif
352+ subscribers <- liftIO FastWeakBag.empty
353+ occRef <- liftIO $ newIORef Nothing -- This should never be read prior to being set below
354+#ifdef DEBUG_NODEIDS
355+ (parentSub, occ) <- subscribeAndRead e $ debugSubscriber' ("cacheEvent" <> showNodeId' nodeId) $ Subscriber
356+#else
357+ (parentSub, occ) <- subscribeAndRead e $ Subscriber
358+#endif
359+ { subscriberPropagate = \a -> do
360+ liftIO $ writeIORef occRef (Just a)
361+ scheduleClear occRef
362+ propagateFast a subscribers
363+ , subscriberInvalidateHeight = FastWeakBag.traverse_ subscribers . invalidateSubscriberHeight
364+ , subscriberRecalculateHeight = FastWeakBag.traverse_ subscribers . recalculateSubscriberHeight
365+ }
366+ when (isJust occ) $ do
367+ liftIO $ writeIORef occRef occ -- Set the initial value of occRef; we don't need to do this if occ is Nothing
368+ scheduleClear occRef
369+ let !subscribed = CacheSubscribed
370+ { _cacheSubscribed_subscribers = subscribers
371+ , _cacheSubscribed_parent = parentSub
372+ , _cacheSubscribed_occurrence = occRef
373+#ifdef DEBUG_NODEIDS
374+ , _cacheSubscribed_nodeId = nodeId
375+#endif
376+ }
377+ subscribedTicket <- liftIO $ mkFastWeakTicket subscribed
378+ liftIO $ writeIORef mSubscribedRef =<< getFastWeakTicketWeak subscribedTicket
379+ return subscribedTicket
380+ liftIO $ cacheSubscription sub mSubscribedRef subscribedTicket
381+
382+cacheSubscription :: Subscriber x a -> IORef (FastWeak (CacheSubscribed x a))
383+ -> FastWeakTicket (CacheSubscribed x a) -> IO (EventSubscription x, Maybe a)
384+cacheSubscription sub mSubscribedRef subscribedTicket = do
385+ subscribed <- getFastWeakTicketValue subscribedTicket
386+ ticket <- FastWeakBag.insert sub $ _cacheSubscribed_subscribers subscribed
387+ occ <- readIORef $ _cacheSubscribed_occurrence subscribed
388+
389+ let parentSub = _cacheSubscribed_parent subscribed
390+ es = EventSubscription
391+ { _eventSubscription_unsubscribe = do
392+ FastWeakBag.remove ticket
393+
394+ isEmpty <- FastWeakBag.isEmpty $ _cacheSubscribed_subscribers subscribed
395+ when isEmpty $ do
396+ writeIORef mSubscribedRef emptyFastWeak
397+ unsubscribe parentSub
398+ touch ticket
399+ touch subscribedTicket
400+ , _eventSubscription_subscribed = EventSubscribed
401+ { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed parentSub
402+ , eventSubscribedRetained = toAny subscribedTicket
403+#ifdef DEBUG_CYCLES
404+ , eventSubscribedGetParents = return [_eventSubscription_subscribed parentSub]
405+ , eventSubscribedHasOwnHeightRef = False
406+ , eventSubscribedWhoCreated = whoCreatedIORef mSubscribedRef
407+#endif
408+ }
409+ }
410+ return (es, occ)
411+
412+
413+subscribe :: Event x a -> Subscriber x a -> EventM x (EventSubscription x)
414+subscribe e s = fst <$> subscribeAndRead e s
415+
416+{-# INLINE wrap #-}
417+wrap :: MonadIO m => (t -> EventSubscribed x) -> (Subscriber x a -> m (WeakBagTicket, t, Maybe a)) -> Subscriber x a -> m (EventSubscription x, Maybe a)
418+wrap tag getSpecificSubscribed sub = do
419+ (sln, subd, occ) <- getSpecificSubscribed sub
420+ let es = tag subd
421+ return (EventSubscription (WeakBag.remove sln >> touch sln) es, occ)
422+
423+eventRoot :: (GCompare k, HasSpiderTimeline x) => k a -> Root x k -> Event x a
424+eventRoot !k !r = Event $ wrap eventSubscribedRoot $ liftIO . getRootSubscribed k r
425+
426+subscribeAndReadNever :: EventM x (EventSubscription x, Maybe a)
427+subscribeAndReadNever = return (EventSubscription (return ()) eventSubscribedNever, Nothing)
428+
429+eventNever :: Event x a
430+eventNever = Event $ const subscribeAndReadNever
431+
432+eventFan :: (GCompare k, HasSpiderTimeline x) => k a -> Fan x k v -> Event x (v a)
433+eventFan !k !f = Event $ wrap eventSubscribedFan $ getFanSubscribed k f
434+
435+eventSwitch :: HasSpiderTimeline x => Switch x a -> Event x a
436+eventSwitch !s = Event $ wrap eventSubscribedSwitch $ getSwitchSubscribed s
437+
438+eventCoincidence :: HasSpiderTimeline x => Coincidence x a -> Event x a
439+eventCoincidence !c = Event $ wrap eventSubscribedCoincidence $ getCoincidenceSubscribed c
440+
441+eventHold :: Hold x p -> Event x p
442+eventHold !h = Event $ subscribeHoldEvent h
443+
444+eventDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> Event x p
445+eventDyn !j = Event $ \sub -> getDynHold j >>= \h -> subscribeHoldEvent h sub
446+
447+{-# INLINE subscribeCoincidenceInner #-}
448+subscribeCoincidenceInner :: HasSpiderTimeline x => Event x a -> Height -> CoincidenceSubscribed x a -> EventM x (Maybe a, Height, EventSubscribed x)
449+subscribeCoincidenceInner inner outerHeight subscribedUnsafe = do
450+ subInner <- liftIO $ newSubscriberCoincidenceInner subscribedUnsafe
451+ (subscription@(EventSubscription _ innerSubd), innerOcc) <- subscribeAndRead inner subInner
452+ innerHeight <- liftIO $ getEventSubscribedHeight innerSubd
453+ let height = max innerHeight outerHeight
454+ defer $ SomeResetCoincidence subscription $ if height > outerHeight then Just subscribedUnsafe else Nothing
455+ return (innerOcc, height, innerSubd)
456+
457+--------------------------------------------------------------------------------
458+-- Subscriber
459+--------------------------------------------------------------------------------
460+
461+data Subscriber x a = Subscriber
462+ { subscriberPropagate :: !(a -> EventM x ())
463+ , subscriberInvalidateHeight :: !(Height -> IO ())
464+ , subscriberRecalculateHeight :: !(Height -> IO ())
465+ }
466+
467+newSubscriberHold :: (HasSpiderTimeline x, Patch p) => Hold x p -> IO (Subscriber x p)
468+newSubscriberHold h = return $ Subscriber
469+ { subscriberPropagate = {-# SCC "traverseHold" #-} propagateSubscriberHold h
470+ , subscriberInvalidateHeight = \_ -> return ()
471+ , subscriberRecalculateHeight = \_ -> return ()
472+ }
473+
474+newSubscriberFan :: forall x k v. (HasSpiderTimeline x, GCompare k) => FanSubscribed x k v -> IO (Subscriber x (DMap k v))
475+newSubscriberFan subscribed = debugSubscriber ("SubscriberFan " <> showNodeId subscribed) $ Subscriber
476+ { subscriberPropagate = \a -> {-# SCC "traverseFan" #-} do
477+ subs <- liftIO $ readIORef $ fanSubscribedSubscribers subscribed
478+ tracePropagate (Proxy :: Proxy x) $ show (DMap.size subs) <> " keys subscribed, " <> show (DMap.size a) <> " keys firing"
479+ liftIO $ writeIORef (fanSubscribedOccurrence subscribed) $ Just a
480+ scheduleClear $ fanSubscribedOccurrence subscribed
481+ let f _ (Pair v subsubs) = do
482+ propagate v $ _fanSubscribedChildren_list subsubs
483+ return $ Constant ()
484+ _ <- DMap.traverseWithKey f $ DMap.intersectionWithKey (\_ -> Pair) a subs --TODO: Would be nice to have DMap.traverse_
485+ return ()
486+ , subscriberInvalidateHeight = \old -> do
487+ subscribers <- readIORef $ fanSubscribedSubscribers subscribed
488+ forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse_ (_fanSubscribedChildren_list v) $ invalidateSubscriberHeight old
489+ , subscriberRecalculateHeight = \new -> do
490+ subscribers <- readIORef $ fanSubscribedSubscribers subscribed
491+ forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse_ (_fanSubscribedChildren_list v) $ recalculateSubscriberHeight new
492+ }
493+
494+newSubscriberSwitch :: forall x a. HasSpiderTimeline x => SwitchSubscribed x a -> IO (Subscriber x a)
495+newSubscriberSwitch subscribed = debugSubscriber ("SubscriberCoincidenceOuter" <> showNodeId subscribed) $ Subscriber
496+ { subscriberPropagate = \a -> {-# SCC "traverseSwitch" #-} do
497+ liftIO $ writeIORef (switchSubscribedOccurrence subscribed) $ Just a
498+ scheduleClear $ switchSubscribedOccurrence subscribed
499+ propagate a $ switchSubscribedSubscribers subscribed
500+ , subscriberInvalidateHeight = \_ -> do
501+ oldHeight <- readIORef $ switchSubscribedHeight subscribed
502+ when (oldHeight /= invalidHeight) $ do
503+ writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
504+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
505+ , subscriberRecalculateHeight = (`updateSwitchHeight` subscribed)
506+ }
507+
508+newSubscriberCoincidenceOuter :: forall x b. HasSpiderTimeline x => CoincidenceSubscribed x b -> IO (Subscriber x (Event x b))
509+newSubscriberCoincidenceOuter subscribed = debugSubscriber ("SubscriberCoincidenceOuter" <> showNodeId subscribed) $ Subscriber
510+ { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceOuter" #-} do
511+ outerHeight <- liftIO $ readIORef $ coincidenceSubscribedHeight subscribed
512+ tracePropagate (Proxy :: Proxy x) $ " outerHeight = " <> show outerHeight
513+ (occ, innerHeight, innerSubd) <- subscribeCoincidenceInner a outerHeight subscribed
514+ tracePropagate (Proxy :: Proxy x) $ " isJust occ = " <> show (isJust occ)
515+ tracePropagate (Proxy :: Proxy x) $ " innerHeight = " <> show innerHeight
516+
517+ liftIO $ writeIORef (coincidenceSubscribedInnerParent subscribed) $ Just innerSubd
518+ scheduleClear $ coincidenceSubscribedInnerParent subscribed
519+ case occ of
520+ Nothing ->
521+ when (innerHeight > outerHeight) $ liftIO $ do -- If the event fires, it will fire at a later height
522+ writeIORef (coincidenceSubscribedHeight subscribed) $! innerHeight
523+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight outerHeight
524+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight innerHeight
525+ Just o -> do -- Since it's already firing, no need to adjust height
526+ liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) occ
527+ scheduleClear $ coincidenceSubscribedOccurrence subscribed
528+ propagate o $ coincidenceSubscribedSubscribers subscribed
529+ , subscriberInvalidateHeight = \_ -> invalidateCoincidenceHeight subscribed
530+ , subscriberRecalculateHeight = \_ -> recalculateCoincidenceHeight subscribed
531+ }
532+
533+newSubscriberCoincidenceInner :: forall x a. HasSpiderTimeline x => CoincidenceSubscribed x a -> IO (Subscriber x a)
534+newSubscriberCoincidenceInner subscribed = debugSubscriber ("SubscriberCoincidenceInner" <> showNodeId subscribed) $ Subscriber
535+ { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceInner" #-} do
536+ occ <- liftIO $ readIORef $ coincidenceSubscribedOccurrence subscribed
537+ case occ of
538+ Just _ -> return () -- SubscriberCoincidenceOuter must have already propagated this event
539+ Nothing -> do
540+ liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) $ Just a
541+ scheduleClear $ coincidenceSubscribedOccurrence subscribed
542+ propagate a $ coincidenceSubscribedSubscribers subscribed
543+ , subscriberInvalidateHeight = \_ -> invalidateCoincidenceHeight subscribed
544+ , subscriberRecalculateHeight = \_ -> recalculateCoincidenceHeight subscribed
545+ }
546+
547+invalidateSubscriberHeight :: Height -> Subscriber x a -> IO ()
548+invalidateSubscriberHeight = flip subscriberInvalidateHeight
549+
550+recalculateSubscriberHeight :: Height -> Subscriber x a -> IO ()
551+recalculateSubscriberHeight = flip subscriberRecalculateHeight
552+
553+-- | Propagate everything at the current height
554+propagate :: forall x a. HasSpiderTimeline x => a -> WeakBag (Subscriber x a) -> EventM x ()
555+propagate a subscribers = withIncreasedDepth (Proxy::Proxy x) $
556+ -- Note: in the following traversal, we do not visit nodes that are added to the list during our traversal; they are new events, which will necessarily have full information already, so there is no need to traverse them
557+ --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
558+ WeakBag.traverse_ subscribers $ \s -> subscriberPropagate s a
559+
560+-- | Propagate everything at the current height
561+propagateFast :: forall x a. HasSpiderTimeline x => a -> FastWeakBag (Subscriber x a) -> EventM x ()
562+propagateFast a subscribers = withIncreasedDepth (Proxy::Proxy x) $
563+ -- Note: in the following traversal, we do not visit nodes that are added to the list during our traversal; they are new events, which will necessarily have full information already, so there is no need to traverse them
564+ --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
565+ FastWeakBag.traverse_ subscribers $ \s -> subscriberPropagate s a
566+
567+--------------------------------------------------------------------------------
568+-- EventSubscribed
569+--------------------------------------------------------------------------------
570+
571+toAny :: a -> Any
572+toAny = unsafeCoerce
573+
574+-- Why do we use Any here, instead of just giving eventSubscribedRetained an
575+-- existential type? Sadly, GHC does not currently know how to unbox types
576+-- with existentially quantified fields. So instead we just coerce values
577+-- to type Any on the way in. Since we never coerce them back, this is
578+-- perfectly safe.
579+data EventSubscribed x = EventSubscribed
580+ { eventSubscribedHeightRef :: {-# UNPACK #-} !(IORef Height)
581+ , eventSubscribedRetained :: {-# NOUNPACK #-} !Any
582+#ifdef DEBUG_CYCLES
583+ , eventSubscribedGetParents :: !(IO [EventSubscribed x]) -- For debugging loops
584+ , eventSubscribedHasOwnHeightRef :: !Bool
585+ , eventSubscribedWhoCreated :: !(IO [String])
93586#endif
587+ }
588+
589+eventSubscribedRoot :: RootSubscribed x a -> EventSubscribed x
590+eventSubscribedRoot !r = EventSubscribed
591+ { eventSubscribedHeightRef = zeroRef
592+ , eventSubscribedRetained = toAny r
593+#ifdef DEBUG_CYCLES
594+ , eventSubscribedGetParents = return []
595+ , eventSubscribedHasOwnHeightRef = False
596+ , eventSubscribedWhoCreated = return ["root"]
597+#endif
598+ }
599+
600+eventSubscribedNever :: EventSubscribed x
601+eventSubscribedNever = EventSubscribed
602+ { eventSubscribedHeightRef = zeroRef
603+ , eventSubscribedRetained = toAny ()
604+#ifdef DEBUG_CYCLES
605+ , eventSubscribedGetParents = return []
606+ , eventSubscribedHasOwnHeightRef = False
607+ , eventSubscribedWhoCreated = return ["never"]
608+#endif
609+ }
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+ }
620+
621+eventSubscribedFan :: FanSubscribed x k v -> EventSubscribed x
622+eventSubscribedFan !subscribed = EventSubscribed
623+ { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ fanSubscribedParent subscribed
624+ , eventSubscribedRetained = toAny subscribed
625+#ifdef DEBUG_CYCLES
626+ , eventSubscribedGetParents = return [_eventSubscription_subscribed $ fanSubscribedParent subscribed]
627+ , eventSubscribedHasOwnHeightRef = False
628+ , eventSubscribedWhoCreated = whoCreatedIORef $ fanSubscribedCachedSubscribed subscribed
629+#endif
630+ }
631+
632+eventSubscribedSwitch :: SwitchSubscribed x a -> EventSubscribed x
633+eventSubscribedSwitch !subscribed = EventSubscribed
634+ { eventSubscribedHeightRef = switchSubscribedHeight subscribed
635+ , eventSubscribedRetained = toAny subscribed
636+#ifdef DEBUG_CYCLES
637+ , eventSubscribedGetParents = do
638+ s <- readIORef $ switchSubscribedCurrentParent subscribed
639+ return [_eventSubscription_subscribed s]
640+ , eventSubscribedHasOwnHeightRef = True
641+ , eventSubscribedWhoCreated = whoCreatedIORef $ switchSubscribedCachedSubscribed subscribed
642+#endif
643+ }
644+
645+eventSubscribedCoincidence :: CoincidenceSubscribed x a -> EventSubscribed x
646+eventSubscribedCoincidence !subscribed = EventSubscribed
647+ { eventSubscribedHeightRef = coincidenceSubscribedHeight subscribed
648+ , eventSubscribedRetained = toAny subscribed
649+#ifdef DEBUG_CYCLES
650+ , eventSubscribedGetParents = do
651+ innerSubscription <- readIORef $ coincidenceSubscribedInnerParent subscribed
652+ let outerParent = _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
653+ innerParents = maybeToList $ innerSubscription
654+ return $ outerParent : innerParents
655+ , eventSubscribedHasOwnHeightRef = True
656+ , eventSubscribedWhoCreated = whoCreatedIORef $ coincidenceSubscribedCachedSubscribed subscribed
657+#endif
658+ }
659+
660+getEventSubscribedHeight :: EventSubscribed x -> IO Height
661+getEventSubscribedHeight es = readIORef $ eventSubscribedHeightRef es
662+
663+#ifdef DEBUG_CYCLES
664+whoCreatedEventSubscribed :: EventSubscribed x -> IO [String]
665+whoCreatedEventSubscribed = eventSubscribedWhoCreated
666+
667+walkInvalidHeightParents :: EventSubscribed x -> IO [EventSubscribed x]
668+walkInvalidHeightParents s0 = do
669+ subscribers <- flip execStateT mempty $ ($ s0) $ fix $ \loop s -> do
670+ h <- liftIO $ readIORef $ eventSubscribedHeightRef s
671+ when (h == invalidHeight) $ do
672+ when (eventSubscribedHasOwnHeightRef s) $ liftIO $ writeIORef (eventSubscribedHeightRef s) $! invalidHeightBeingTraversed
673+ modify (s :)
674+ mapM_ loop =<< liftIO (eventSubscribedGetParents s)
675+ forM_ subscribers $ \s -> writeIORef (eventSubscribedHeightRef s) $! invalidHeight
676+ return subscribers
677+#endif
678+
679+{-# INLINE subscribeHoldEvent #-}
680+subscribeHoldEvent :: Hold x p -> Subscriber x p -> EventM x (EventSubscription x, Maybe p)
681+subscribeHoldEvent = subscribeAndRead . holdEvent
682+
683+--------------------------------------------------------------------------------
684+-- Behavior
685+--------------------------------------------------------------------------------
686+
687+newtype Behavior x a = Behavior { readBehaviorTracked :: BehaviorM x a }
688+
689+behaviorHold :: Hold x p -> Behavior x (PatchTarget p)
690+behaviorHold !h = Behavior $ readHoldTracked h
691+
692+behaviorHoldIdentity :: Hold x (Identity a) -> Behavior x a
693+behaviorHoldIdentity = behaviorHold
694+
695+behaviorConst :: a -> Behavior x a
696+behaviorConst !a = Behavior $ return a
697+
698+behaviorPull :: Pull x a -> Behavior x a
699+behaviorPull !p = Behavior $ do
700+ val <- liftIO $ readIORef $ pullValue p
701+ case val of
702+ Just subscribed -> do
703+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (Some (BehaviorSubscribedPull subscribed)) :))
704+ askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (pullSubscribedInvalidators subscribed) (wi:))
705+ liftIO $ touch $ pullSubscribedOwnInvalidator subscribed
706+ return $ pullSubscribedValue subscribed
707+ Nothing -> do
708+ i <- liftIO $ newInvalidatorPull p
709+ wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorPull"
710+ parentsRef <- liftIO $ newIORef []
711+ holdInits <- askBehaviorHoldInits
712+ a <- liftIO $ runReaderIO (unBehaviorM $ pullCompute p) (Just (wi, parentsRef), holdInits)
713+ invsRef <- liftIO . newIORef . maybeToList =<< askInvalidator
714+ parents <- liftIO $ readIORef parentsRef
715+ let subscribed = PullSubscribed
716+ { pullSubscribedValue = a
717+ , pullSubscribedInvalidators = invsRef
718+ , pullSubscribedOwnInvalidator = i
719+ , pullSubscribedParents = parents
720+ }
721+ liftIO $ writeIORef (pullValue p) $ Just subscribed
722+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (Some (BehaviorSubscribedPull subscribed)) :))
723+ return a
724+
725+behaviorDyn :: Patch p => Dyn x p -> Behavior x (PatchTarget p)
726+behaviorDyn !d = Behavior $ readHoldTracked =<< getDynHold d
727+
728+{-# INLINE readHoldTracked #-}
729+readHoldTracked :: Hold x p -> BehaviorM x (PatchTarget p)
730+readHoldTracked h = do
731+ result <- liftIO $ readIORef $ holdValue h
732+ askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (holdInvalidators h) (wi:))
733+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (Some (BehaviorSubscribedHold h)) :))
734+ liftIO $ touch h -- Otherwise, if this gets inlined enough, the hold's parent reference may get collected
735+ return result
736+
737+{-# INLINABLE readBehaviorUntracked #-}
738+readBehaviorUntracked :: Defer (SomeHoldInit x) m => Behavior x a -> m a
739+readBehaviorUntracked b = do
740+ holdInits <- getDeferralQueue
741+ liftIO $ runBehaviorM (readBehaviorTracked b) Nothing holdInits --TODO: Specialize readBehaviorTracked to the Nothing and Just cases
742+
743+--------------------------------------------------------------------------------
744+-- Dynamic
745+--------------------------------------------------------------------------------
746+
747+type DynamicS x p = Dynamic x (PatchTarget p) p
748+
749+data Dynamic x target p = Dynamic
750+ { dynamicCurrent :: !(Behavior x target)
751+ , dynamicUpdated :: Event x p -- This must be lazy; see the comment on holdEvent --TODO: Would this let us eliminate `Dyn`?
752+ }
753+
754+deriving instance (HasSpiderTimeline x) => Functor (Dynamic x target)
755+
756+
757+
758+
759+dynamicHold :: Hold x p -> DynamicS x p
760+dynamicHold !h = Dynamic
761+ { dynamicCurrent = behaviorHold h
762+ , dynamicUpdated = eventHold h
763+ }
764+
765+dynamicHoldIdentity :: Hold x (Identity a) -> DynamicS x (Identity a)
766+dynamicHoldIdentity = dynamicHold
767+
768+dynamicConst :: PatchTarget p -> DynamicS x p
769+dynamicConst !a = Dynamic
770+ { dynamicCurrent = behaviorConst a
771+ , dynamicUpdated = eventNever
772+ }
773+
774+dynamicDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> DynamicS x p
775+dynamicDyn !d = Dynamic
776+ { dynamicCurrent = behaviorDyn d
777+ , dynamicUpdated = eventDyn d
778+ }
779+
780+dynamicDynIdentity :: HasSpiderTimeline x => Dyn x (Identity a) -> DynamicS x (Identity a)
781+dynamicDynIdentity = dynamicDyn
782+
783+--------------------------------------------------------------------------------
784+-- Combinators
785+--------------------------------------------------------------------------------
94786
95−--TODO: Figure out why certain things are not 'representational', then make them representational so we can use coerce
96787--type role Hold representational
97−data Hold a
98− = Hold { holdValue :: !(IORef a)
99− , holdInvalidators :: !(IORef [Weak Invalidator])
100− -- We need to use 'Any' for the next two things, because otherwise Hold inherits a nominal role for its 'a' parameter, and we want to be able to use 'coerce'
101− , holdSubscriber :: !(IORef Any) -- Keeps its subscription alive; for some reason, a regular (or strict) reference to the Subscriber itself wasn't working, so had to use an IORef
102− , holdParent :: !(IORef Any) -- Keeps its parent alive (will be undefined until the hold is initialized --TODO: Probably shouldn't be an IORef
788+data Hold x p
789+ = Hold { holdValue :: !(IORef (PatchTarget p))
790+ , holdInvalidators :: !(IORef [Weak (Invalidator x)])
791+ , holdEvent :: Event x p -- This must be lazy, or holds cannot be defined before their input Events
792+ , holdParent :: !(IORef (Maybe (EventSubscription x))) -- Keeps its parent alive (will be undefined until the hold is initialized) --TODO: Probably shouldn't be an IORef
103793#ifdef DEBUG_NODEIDS
104794 , holdNodeId :: Int
105795#endif
106796 }
107797
108−data EventEnv
109− = EventEnv { eventEnvAssignments :: !(IORef [SomeAssignment])
110− , eventEnvHoldInits :: !(IORef [SomeHoldInit])
111− , eventEnvClears :: !(IORef [SomeMaybeIORef])
112− , eventEnvCurrentHeight :: !(IORef Int)
113− , eventEnvCoincidenceInfos :: !(IORef [SomeCoincidenceInfo])
114− , eventEnvDelayedMerges :: !(IORef (IntMap [DelayedMerge]))
798+-- | A statically allocated 'SpiderTimeline'
799+data Global
800+
801+{-# NOINLINE globalSpiderTimelineEnv #-}
802+globalSpiderTimelineEnv :: SpiderTimelineEnv Global
803+globalSpiderTimelineEnv = unsafePerformIO unsafeNewSpiderTimelineEnv
804+
805+-- | Stores all global data relevant to a particular Spider timeline; only one
806+-- value should exist for each type @x@
807+newtype SpiderTimelineEnv x = STE {unSTE :: SpiderTimelineEnv' x}
808+-- We implement SpiderTimelineEnv with a newtype wrapper so
809+-- we can get the coercions we want safely.
810+type role SpiderTimelineEnv nominal
811+
812+data SpiderTimelineEnv' x = SpiderTimelineEnv
813+ { _spiderTimeline_lock :: {-# UNPACK #-} !(MVar ())
814+ , _spiderTimeline_eventEnv :: {-# UNPACK #-} !(EventEnv x)
815+#ifdef DEBUG
816+ , _spiderTimeline_depth :: {-# UNPACK #-} !(IORef Int)
817+#endif
818+ }
819+type role SpiderTimelineEnv' phantom
820+
821+instance Eq (SpiderTimelineEnv x) where
822+ _ == _ = True -- Since only one exists of each type
823+
824+instance GEq SpiderTimelineEnv where
825+ a `geq` b = if _spiderTimeline_lock (unSTE a) == _spiderTimeline_lock (unSTE b)
826+ then Just $ unsafeCoerce Refl -- This unsafeCoerce is safe because the same SpiderTimelineEnv can't have two different 'x' arguments
827+ else Nothing
828+
829+data EventEnv x
830+ = EventEnv { eventEnvAssignments :: !(IORef [SomeAssignment x]) -- Needed for Subscribe
831+ , eventEnvHoldInits :: !(IORef [SomeHoldInit x]) -- Needed for Subscribe
832+ , eventEnvDynInits :: !(IORef [SomeDynInit x])
833+ , eventEnvMergeUpdates :: !(IORef [SomeMergeUpdate x])
834+ , eventEnvMergeInits :: !(IORef [SomeMergeInit x]) -- Needed for Subscribe
835+ , eventEnvClears :: !(IORef [Some Clear]) -- Needed for Subscribe
836+ , eventEnvIntClears :: !(IORef [Some IntClear])
837+ , eventEnvRootClears :: !(IORef [Some RootClear])
838+ , eventEnvCurrentHeight :: !(IORef Height) -- Needed for Subscribe
839+ , eventEnvResetCoincidences :: !(IORef [SomeResetCoincidence x]) -- Needed for Subscribe
840+ , eventEnvDelayedMerges :: !(IORef (IntMap [EventM x ()]))
115841 }
116842
117−runEventM :: EventM a -> EventEnv -> IO a
118−runEventM = runReaderT . unEventM
843+{-# INLINE runEventM #-}
844+runEventM :: EventM x a -> IO a
845+runEventM = unEventM
119846
120−askToAssignRef :: EventM (IORef [SomeAssignment])
121−askToAssignRef = EventM $ asks eventEnvAssignments
847+asksEventEnv :: forall x a. HasSpiderTimeline x => (EventEnv x -> a) -> EventM x a
848+asksEventEnv f = return $ f $ _spiderTimeline_eventEnv (unSTE (spiderTimeline :: SpiderTimelineEnv x))
122849
123−askHoldInitRef :: EventM (IORef [SomeHoldInit])
124−askHoldInitRef = EventM $ asks eventEnvHoldInits
850+class MonadIO m => Defer a m where
851+ getDeferralQueue :: m (IORef [a])
125852
126−getCurrentHeight :: EventM Int
127−getCurrentHeight = EventM $ do
128− heightRef <- asks eventEnvCurrentHeight
129− liftIO $ readIORef heightRef
853+{-# INLINE defer #-}
854+defer :: Defer a m => a -> m ()
855+defer a = do
856+ q <- getDeferralQueue
857+ liftIO $ modifyIORef' q (a:)
130858
131−putCurrentHeight :: Int -> EventM ()
132−putCurrentHeight h = EventM $ do
133− heightRef <- asks eventEnvCurrentHeight
134− liftIO $ writeIORef heightRef h
859+instance HasSpiderTimeline x => Defer (SomeAssignment x) (EventM x) where
860+ {-# INLINE getDeferralQueue #-}
861+ getDeferralQueue = asksEventEnv eventEnvAssignments
135862
136−scheduleClear :: IORef (Maybe a) -> EventM ()
137−scheduleClear r = EventM $ do
138− clears <- asks eventEnvClears
139− liftIO $ modifyIORef' clears (SomeMaybeIORef r :)
863+instance HasSpiderTimeline x => Defer (SomeHoldInit x) (EventM x) where
864+ {-# INLINE getDeferralQueue #-}
865+ getDeferralQueue = asksEventEnv eventEnvHoldInits
140866
141−scheduleMerge :: Int -> MergeSubscribed a -> EventM ()
142−scheduleMerge height subscribed = EventM $ do
143− delayedRef <- asks eventEnvDelayedMerges
144− liftIO $ modifyIORef' delayedRef $ IntMap.insertWith (++) height [DelayedMerge subscribed]
867+instance HasSpiderTimeline x => Defer (SomeDynInit x) (EventM x) where
868+ {-# INLINE getDeferralQueue #-}
869+ getDeferralQueue = asksEventEnv eventEnvDynInits
145870
146−emitCoincidenceInfo :: SomeCoincidenceInfo -> EventM ()
147−emitCoincidenceInfo sci = EventM $ do
148− ciRef <- asks eventEnvCoincidenceInfos
149− liftIO $ modifyIORef' ciRef (sci:)
871+instance Defer (SomeHoldInit x) (BehaviorM x) where
872+ {-# INLINE getDeferralQueue #-}
873+ getDeferralQueue = BehaviorM $ asks snd
874+
875+instance HasSpiderTimeline x => Defer (SomeMergeUpdate x) (EventM x) where
876+ {-# INLINE getDeferralQueue #-}
877+ getDeferralQueue = asksEventEnv eventEnvMergeUpdates
878+
879+instance HasSpiderTimeline x => Defer (SomeMergeInit x) (EventM x) where
880+ {-# INLINE getDeferralQueue #-}
881+ getDeferralQueue = asksEventEnv eventEnvMergeInits
882+
883+class HasSpiderTimeline x => HasCurrentHeight x m | m -> x where
884+ getCurrentHeight :: m Height
885+ scheduleMerge :: Height -> EventM x () -> m ()
886+
887+instance HasSpiderTimeline x => HasCurrentHeight x (EventM x) where
888+ {-# INLINE getCurrentHeight #-}
889+ getCurrentHeight = do
890+ heightRef <- asksEventEnv eventEnvCurrentHeight
891+ liftIO $ readIORef heightRef
892+ {-# INLINE scheduleMerge #-}
893+ scheduleMerge height subscribed = do
894+ delayedRef <- asksEventEnv eventEnvDelayedMerges
895+ liftIO $ modifyIORef' delayedRef $ IntMap.insertWith (++) (unHeight height) [subscribed]
896+
897+class HasSpiderTimeline x where
898+ -- | Retrieve the current SpiderTimelineEnv
899+ spiderTimeline :: SpiderTimelineEnv x
900+
901+instance HasSpiderTimeline Global where
902+ spiderTimeline = globalSpiderTimelineEnv
903+
904+putCurrentHeight :: HasSpiderTimeline x => Height -> EventM x ()
905+putCurrentHeight h = do
906+ heightRef <- asksEventEnv eventEnvCurrentHeight
907+ liftIO $ writeIORef heightRef $! h
908+
909+instance HasSpiderTimeline x => Defer (Some Clear) (EventM x) where
910+ {-# INLINE getDeferralQueue #-}
911+ getDeferralQueue = asksEventEnv eventEnvClears
912+
913+{-# INLINE scheduleClear #-}
914+scheduleClear :: Defer (Some Clear) m => IORef (Maybe a) -> m ()
915+scheduleClear r = defer $ Some $ Clear r
916+
917+instance HasSpiderTimeline x => Defer (Some IntClear) (EventM x) where
918+ {-# INLINE getDeferralQueue #-}
919+ getDeferralQueue = asksEventEnv eventEnvIntClears
920+
921+{-# INLINE scheduleIntClear #-}
922+scheduleIntClear :: Defer (Some IntClear) m => IORef (IntMap a) -> m ()
923+scheduleIntClear r = defer $ Some $ IntClear r
924+
925+instance HasSpiderTimeline x => Defer (Some RootClear) (EventM x) where
926+ {-# INLINE getDeferralQueue #-}
927+ getDeferralQueue = asksEventEnv eventEnvRootClears
928+
929+{-# INLINE scheduleRootClear #-}
930+scheduleRootClear :: Defer (Some RootClear) m => IORef (DMap k Identity) -> m ()
931+scheduleRootClear r = defer $ Some $ RootClear r
932+
933+instance HasSpiderTimeline x => Defer (SomeResetCoincidence x) (EventM x) where
934+ {-# INLINE getDeferralQueue #-}
935+ getDeferralQueue = asksEventEnv eventEnvResetCoincidences
150936
151937-- Note: hold cannot examine its event until after the phase is over
152−hold :: a -> Event a -> EventM (Behavior a)
938+{-# INLINE [1] hold #-}
939+hold :: (Patch p, Defer (SomeHoldInit x) m) => PatchTarget p -> Event x p -> m (Hold x p)
153940hold v0 e = do
154− holdInitRef <- askHoldInitRef
155− liftIO $ do
156− valRef <- newIORef v0
157− invsRef <- newIORef []
158− parentRef <- newIORef $ error "hold not yet initialized (parent)"
159− subscriberRef <- newIORef $ error "hold not yet initialized (subscriber)"
160− let h = Hold
161− { holdValue = valRef
162− , holdInvalidators = invsRef
163− , holdSubscriber = subscriberRef
164− , holdParent = parentRef
941+ valRef <- liftIO $ newIORef v0
942+ invsRef <- liftIO $ newIORef []
943+ parentRef <- liftIO $ newIORef Nothing
165944#ifdef DEBUG_NODEIDS
166− , holdNodeId = unsafeNodeId (v0, e)
945+ nodeId <- liftIO newNodeId
167946#endif
168− }
169− !s = SubscriberHold h
170− writeIORef subscriberRef $ unsafeCoerce s
171− modifyIORef' holdInitRef (SomeHoldInit e h :)
172− return $ BehaviorHold h
173−
174−subscribeHold :: Event a -> Hold a -> EventM ()
175−subscribeHold e h = do
176− toAssignRef <- askToAssignRef
177− !s <- liftIO $ liftM unsafeCoerce $ readIORef $ holdSubscriber h -- This must be performed strictly so that the weak pointer points at the actual item
178− ws <- liftIO $ mkWeakPtrWithDebug s "holdSubscriber"
179− subd <- subscribe e $ WeakSubscriberSimple ws
180− liftIO $ writeIORef (holdParent h) $ unsafeCoerce subd
181− occ <- liftIO $ getEventSubscribedOcc subd
182− case occ of
183− Nothing -> return ()
184− Just o -> liftIO $ modifyIORef' toAssignRef (SomeAssignment h o :)
947+ let h = Hold
948+ { holdValue = valRef
949+ , holdInvalidators = invsRef
950+ , holdEvent = e
951+ , holdParent = parentRef
952+#ifdef DEBUG_NODEIDS
953+ , holdNodeId = nodeId
954+#endif
955+ }
956+ defer $ SomeHoldInit h
957+ return h
958+
959+{-# INLINE getHoldEventSubscription #-}
960+getHoldEventSubscription :: forall p x. (HasSpiderTimeline x, Patch p) => Hold x p -> EventM x (EventSubscription x)
961+getHoldEventSubscription h = do
962+ ep <- liftIO $ readIORef $ holdParent h
963+ case ep of
964+ Just subd -> return subd
965+ Nothing -> do
966+ let e = holdEvent h
967+ subscriptionRef <- liftIO $ newIORef $ error "getHoldEventSubscription: subdRef uninitialized"
968+ (subscription@(EventSubscription _ _), occ) <- subscribeAndRead e =<< liftIO (newSubscriberHold h)
969+ liftIO $ writeIORef subscriptionRef $! subscription
970+ case occ of
971+ Nothing -> return ()
972+ Just o -> do
973+ old <- liftIO $ readIORef $ holdValue h
974+ case apply o old of
975+ Nothing -> return ()
976+ Just new -> do
977+ -- Need to evaluate these so that we don't retain the Hold itself
978+ v <- liftIO $ evaluate $ holdValue h
979+ i <- liftIO $ evaluate $ holdInvalidators h
980+ defer $ SomeAssignment v i new
981+ liftIO $ writeIORef (holdParent h) $ Just subscription
982+ return subscription
983+
984+type BehaviorEnv x = (Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]), IORef [SomeHoldInit x])
185985
186−--type role BehaviorM representational
187986-- BehaviorM can sample behaviors
188−newtype BehaviorM a = BehaviorM { unBehaviorM :: ReaderT (Maybe (Weak Invalidator, IORef [SomeBehaviorSubscribed])) IO a } deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
987+newtype BehaviorM x a = BehaviorM { unBehaviorM :: ReaderIO (BehaviorEnv x) a }
988+ deriving (Functor, Applicative, MonadIO, MonadFix, MonadReader (BehaviorEnv x))
989+
990+instance Monad (BehaviorM x) where
991+ {-# INLINE (>>=) #-}
992+ BehaviorM x >>= f = BehaviorM $ x >>= unBehaviorM . f
993+ {-# INLINE (>>) #-}
994+ BehaviorM x >> BehaviorM y = BehaviorM $ x >> y
995+ {-# INLINE return #-}
996+ return x = BehaviorM $ return x
997+#if !MIN_VERSION_base(4,13,0)
998+ {-# INLINE fail #-}
999+ fail s = BehaviorM $ fail s
1000+#endif
1891001
190−data BehaviorSubscribed a
191− = BehaviorSubscribedHold (Hold a)
192− | BehaviorSubscribedPull (PullSubscribed a)
1002+data BehaviorSubscribed x a
1003+ = forall p. BehaviorSubscribedHold (Hold x p)
1004+ | BehaviorSubscribedPull (PullSubscribed x a)
1931005
194−data SomeBehaviorSubscribed = forall a. SomeBehaviorSubscribed (BehaviorSubscribed a)
1006+newtype SomeBehaviorSubscribed x = SomeBehaviorSubscribed (Some (BehaviorSubscribed x))
1951007
1961008--type role PullSubscribed representational
197−data PullSubscribed a
1009+data PullSubscribed x a
1981010 = PullSubscribed { pullSubscribedValue :: !a
199− , pullSubscribedInvalidators :: !(IORef [Weak Invalidator])
200− , pullSubscribedOwnInvalidator :: !Invalidator
201− , pullSubscribedParents :: ![SomeBehaviorSubscribed] -- Need to keep parent behaviors alive, or they won't let us know when they're invalidated
1011+ , pullSubscribedInvalidators :: !(IORef [Weak (Invalidator x)])
1012+ , pullSubscribedOwnInvalidator :: !(Invalidator x)
1013+ , pullSubscribedParents :: ![SomeBehaviorSubscribed x] -- Need to keep parent behaviors alive, or they won't let us know when they're invalidated
2021014 }
2031015
2041016--type role Pull representational
205−data Pull a
206− = Pull { pullValue :: !(IORef (Maybe (PullSubscribed a)))
207− , pullCompute :: !(BehaviorM a)
1017+data Pull x a
1018+ = Pull { pullValue :: !(IORef (Maybe (PullSubscribed x a)))
1019+ , pullCompute :: !(BehaviorM x a)
1020+#ifdef DEBUG_NODEIDS
1021+ , pullNodeId :: Int
1022+#endif
2081023 }
2091024
210−data Invalidator
211− = forall a. InvalidatorPull (Pull a)
212− | forall a. InvalidatorSwitch (SwitchSubscribed a)
213−
214−data RootSubscribed a
215− = RootSubscribed { rootSubscribedSubscribers :: !(IORef [WeakSubscriber a])
216− , rootSubscribedOccurrence :: !(IORef (Maybe a)) -- Alias to rootOccurrence
217− }
1025+data Invalidator x
1026+ = forall a. InvalidatorPull (Pull x a)
1027+ | forall a. InvalidatorSwitch (SwitchSubscribed x a)
1028+
1029+data RootSubscribed x a = forall k. GCompare k => RootSubscribed
1030+ { rootSubscribedKey :: !(k a)
1031+ , rootSubscribedCachedSubscribed :: !(IORef (DMap k (RootSubscribed x))) -- From the original Root
1032+ , rootSubscribedSubscribers :: !(WeakBag (Subscriber x a))
1033+ , rootSubscribedOccurrence :: !(IO (Maybe a)) -- Lookup from rootOccurrence
1034+ , rootSubscribedUninit :: IO ()
1035+ , rootSubscribedWeakSelf :: !(IORef (Weak (RootSubscribed x a))) --TODO: Can we make this a lazy non-IORef and then force it manually to avoid an indirection each time we use it?
1036+#ifdef DEBUG_NODEIDS
1037+ , rootSubscribedNodeId :: Int
1038+#endif
1039+ }
2181040
219−data Root a
220− = Root { rootOccurrence :: !(IORef (Maybe a)) -- The currently-firing occurrence of this event
221− , rootSubscribed :: !(IORef (Maybe (RootSubscribed a)))
222− , rootInit :: !(RootTrigger a -> IO (IO ()))
1041+data Root x k
1042+ = Root { rootOccurrence :: !(IORef (DMap k Identity)) -- The currently-firing occurrence of this event
1043+ , rootSubscribed :: !(IORef (DMap k (RootSubscribed x)))
1044+ , rootInit :: !(forall a. k a -> RootTrigger x a -> IO (IO ()))
2231045 }
2241046
225−data SomeHoldInit = forall a. SomeHoldInit (Event a) (Hold a)
1047+data SomeHoldInit x = forall p. Patch p => SomeHoldInit !(Hold x p)
1048+
1049+data SomeDynInit x = forall p. Patch p => SomeDynInit !(Dyn x p)
1050+
1051+data SomeMergeUpdate x = SomeMergeUpdate
1052+ { _someMergeUpdate_update :: !(EventM x [EventSubscription x])
1053+ , _someMergeUpdate_invalidateHeight :: !(IO ())
1054+ , _someMergeUpdate_recalculateHeight :: !(IO ())
1055+ }
1056+
1057+newtype SomeMergeInit x = SomeMergeInit { unSomeMergeInit :: EventM x () }
2261058
2271059-- EventM can do everything BehaviorM can, plus create holds
228−newtype EventM a = EventM { unEventM :: ReaderT EventEnv IO a } deriving (Functor, Applicative, Monad, MonadFix, MonadIO) -- The environment should be Nothing if we are not in a frame, and Just if we are - in which case it is a list of assignments to be done after the frame is over
229−
230−data PushSubscribed a b
231− = PushSubscribed { pushSubscribedOccurrence :: !(IORef (Maybe b)) -- If the current height is less than our height, this should always be Nothing; during our height, this will get filled in at some point, always before our children are notified; after our height, this will be filled in with the correct value (Nothing if we are not firing, Just if we are)
232− , pushSubscribedHeight :: !(IORef Int)
233− , pushSubscribedSubscribers :: !(IORef [WeakSubscriber b])
234− , pushSubscribedSelf :: !(Subscriber a) -- Hold this in memory to ensure our WeakReferences don't die
235− , pushSubscribedParent :: !(EventSubscribed a)
236−#ifdef DEBUG_NODEIDS
237− , pushSubscribedNodeId :: Int
238−#endif
239− }
1060+newtype EventM x a = EventM { unEventM :: IO a } deriving (Functor, Applicative, Monad, MonadIO, MonadFix, MonadException, MonadAsyncException)
2401061
241−data Push a b
242− = Push { pushCompute :: !(a -> EventM (Maybe b)) -- Compute the current firing value; assumes that its parent has been computed
243− , pushParent :: !(Event a)
244− , pushSubscribed :: !(IORef (Maybe (PushSubscribed a b))) --TODO: Can we replace this with an unsafePerformIO thunk?
245− }
1062+newtype MergeSubscribedParent x a = MergeSubscribedParent { unMergeSubscribedParent :: EventSubscription x }
2461063
247−data MergeSubscribed k
248− = MergeSubscribed { mergeSubscribedOccurrence :: !(IORef (Maybe (DMap k)))
249− , mergeSubscribedAccum :: !(IORef (DMap k)) -- This will accumulate occurrences until our height is reached, at which point it will be transferred to mergeSubscribedOccurrence
250− , mergeSubscribedHeight :: !(IORef Int)
251− , mergeSubscribedSubscribers :: !(IORef [WeakSubscriber (DMap k)])
252− , mergeSubscribedSelf :: !Any -- Hold all our Subscribers in memory
253− , mergeSubscribedParents :: !(DMap (WrapArg EventSubscribed k))
254−#ifdef DEBUG_NODEIDS
255− , mergeSubscribedNodeId :: Int
1064+data MergeSubscribedParentWithMove x k a = MergeSubscribedParentWithMove
1065+ { _mergeSubscribedParentWithMove_subscription :: !(EventSubscription x)
1066+ , _mergeSubscribedParentWithMove_key :: !(IORef (k a))
1067+ }
1068+
1069+data HeightBag = HeightBag
1070+ { _heightBag_size :: {-# UNPACK #-} !Int
1071+ , _heightBag_contents :: !(IntMap Word) -- Number of excess in each bucket
1072+ }
1073+ deriving (Show, Read, Eq, Ord)
1074+
1075+heightBagEmpty :: HeightBag
1076+heightBagEmpty = heightBagVerify $ HeightBag 0 IntMap.empty
1077+
1078+heightBagSize :: HeightBag -> Int
1079+heightBagSize = _heightBag_size
1080+
1081+heightBagFromList :: [Height] -> HeightBag
1082+heightBagFromList heights = heightBagVerify $ foldl' (flip heightBagAdd) heightBagEmpty heights
1083+
1084+heightBagAdd :: Height -> HeightBag -> HeightBag
1085+heightBagAdd (Height h) (HeightBag s c) = heightBagVerify $ HeightBag (succ s) $
1086+ IntMap.insertWithKey (\_ _ old -> succ old) h 0 c
1087+
1088+heightBagRemove :: Height -> HeightBag -> HeightBag
1089+heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.lookup h c of
1090+ Nothing -> error $ "heightBagRemove: Height " <> show h <> " not present in bag " <> show b
1091+ Just old -> HeightBag (pred s) $ case old of
1092+ 0 -> IntMap.delete h c
1093+ _ -> IntMap.insert h (pred old) c
1094+
1095+heightBagRemoveMaybe :: Height -> HeightBag -> Maybe HeightBag
1096+heightBagRemoveMaybe (Height h) b@(HeightBag s c) = heightBagVerify . removed <$> IntMap.lookup h c where
1097+ removed old = HeightBag (pred s) $ case old of
1098+ 0 -> IntMap.delete h c
1099+ _ -> IntMap.insert h (pred old) c
1100+
1101+
1102+heightBagMax :: HeightBag -> Height
1103+heightBagMax (HeightBag _ c) = case IntMap.maxViewWithKey c of
1104+ Just ((h, _), _) -> Height h
1105+ Nothing -> zeroHeight
1106+
1107+heightBagVerify :: HeightBag -> HeightBag
1108+#ifdef DEBUG
1109+heightBagVerify b@(HeightBag s c) = if
1110+ | s /= IntMap.size c + fromIntegral (sum (IntMap.elems c))
1111+ -> error $ "heightBagVerify: size doesn't match: " <> show b
1112+ | unHeight invalidHeight `IntMap.member` c
1113+ -> error $ "heightBagVerify: contains invalid height: " <> show b
1114+ | otherwise -> b
1115+#else
1116+heightBagVerify = id
2561117#endif
257− }
2581118
259−--TODO: DMap sucks; we should really write something better (with a functor for the value as well as the key)
260−data Merge k
261− = Merge { mergeParents :: !(DMap (WrapArg Event k))
262− , mergeSubscribed :: !(IORef (Maybe (MergeSubscribed k))) --TODO: Can we replace this with an unsafePerformIO thunk?
263− }
264−
265−data FanSubscriberKey k a where
266− FanSubscriberKey :: k a -> FanSubscriberKey k [WeakSubscriber a]
267−
268−instance GEq k => GEq (FanSubscriberKey k) where
269− geq (FanSubscriberKey a) (FanSubscriberKey b) = case geq a b of
270− Nothing -> Nothing
271− Just Refl -> Just Refl
272−
273−instance GCompare k => GCompare (FanSubscriberKey k) where
274− gcompare (FanSubscriberKey a) (FanSubscriberKey b) = case gcompare a b of
275− GLT -> GLT
276− GEQ -> GEQ
277− GGT -> GGT
278−
279−data FanSubscribed k
280− = FanSubscribed { fanSubscribedSubscribers :: !(IORef (DMap (FanSubscriberKey k)))
281− , fanSubscribedParent :: !(EventSubscribed (DMap k))
282− , fanSubscribedSelf :: !(Subscriber (DMap k))
1119+data FanSubscribedChildren x k v a = FanSubscribedChildren
1120+ { _fanSubscribedChildren_list :: !(WeakBag (Subscriber x (v a)))
1121+ , _fanSubscribedChildren_self :: {-# NOUNPACK #-} !(k a, FanSubscribed x k v)
1122+ , _fanSubscribedChildren_weakSelf :: !(IORef (Weak (k a, FanSubscribed x k v)))
1123+ }
1124+
1125+data FanSubscribed x k v
1126+ = FanSubscribed { fanSubscribedCachedSubscribed :: !(IORef (Maybe (FanSubscribed x k v)))
1127+ , fanSubscribedOccurrence :: !(IORef (Maybe (DMap k v)))
1128+ , fanSubscribedSubscribers :: !(IORef (DMap k (FanSubscribedChildren x k v))) -- This DMap should never be empty
1129+ , fanSubscribedParent :: !(EventSubscription x)
2831130#ifdef DEBUG_NODEIDS
2841131 , fanSubscribedNodeId :: Int
2851132#endif
2861133 }
2871134
288−data Fan k
289− = Fan { fanParent :: !(Event (DMap k))
290− , fanSubscribed :: !(IORef (Maybe (FanSubscribed k)))
1135+data Fan x k v
1136+ = Fan { fanParent :: !(Event x (DMap k v))
1137+ , fanSubscribed :: !(IORef (Maybe (FanSubscribed x k v)))
2911138 }
2921139
293−data SwitchSubscribed a
294− = SwitchSubscribed { switchSubscribedOccurrence :: !(IORef (Maybe a))
295− , switchSubscribedHeight :: !(IORef Int)
296− , switchSubscribedSubscribers :: !(IORef [WeakSubscriber a])
297− , switchSubscribedSelf :: !(Subscriber a)
298− , switchSubscribedSelfWeak :: !(IORef (Weak (Subscriber a)))
299− , switchSubscribedOwnInvalidator :: !Invalidator
300− , switchSubscribedOwnWeakInvalidator :: !(IORef (Weak Invalidator))
301− , switchSubscribedBehaviorParents :: !(IORef [SomeBehaviorSubscribed])
302− , switchSubscribedParent :: !(Behavior (Event a))
303− , switchSubscribedCurrentParent :: !(IORef (EventSubscribed a))
1140+data SwitchSubscribed x a
1141+ = SwitchSubscribed { switchSubscribedCachedSubscribed :: !(IORef (Maybe (SwitchSubscribed x a)))
1142+ , switchSubscribedOccurrence :: !(IORef (Maybe a))
1143+ , switchSubscribedHeight :: !(IORef Height)
1144+ , switchSubscribedSubscribers :: !(WeakBag (Subscriber x a))
1145+ , switchSubscribedOwnInvalidator :: {-# NOUNPACK #-} !(Invalidator x)
1146+ , switchSubscribedOwnWeakInvalidator :: !(IORef (Weak (Invalidator x)))
1147+ , switchSubscribedBehaviorParents :: !(IORef [SomeBehaviorSubscribed x])
1148+ , switchSubscribedParent :: !(Behavior x (Event x a))
1149+ , switchSubscribedCurrentParent :: !(IORef (EventSubscription x))
1150+ , switchSubscribedWeakSelf :: !(IORef (Weak (SwitchSubscribed x a)))
3041151#ifdef DEBUG_NODEIDS
3051152 , switchSubscribedNodeId :: Int
3061153#endif
3071154 }
3081155
309−data Switch a
310− = Switch { switchParent :: !(Behavior (Event a))
311− , switchSubscribed :: !(IORef (Maybe (SwitchSubscribed a)))
1156+data Switch x a
1157+ = Switch { switchParent :: !(Behavior x (Event x a))
1158+ , switchSubscribed :: !(IORef (Maybe (SwitchSubscribed x a)))
3121159 }
3131160
314−data CoincidenceSubscribed a
315− = CoincidenceSubscribed { coincidenceSubscribedOccurrence :: !(IORef (Maybe a))
316− , coincidenceSubscribedSubscribers :: !(IORef [WeakSubscriber a])
317− , coincidenceSubscribedHeight :: !(IORef Int)
318− , coincidenceSubscribedOuter :: !(Subscriber (Event a))
319− , coincidenceSubscribedOuterParent :: !(EventSubscribed (Event a))
320− , coincidenceSubscribedInnerParent :: !(IORef (Maybe (EventSubscribed a)))
1161+#ifdef USE_TEMPLATE_HASKELL
1162+{-# ANN CoincidenceSubscribed "HLint: ignore Redundant bracket" #-}
1163+#endif
1164+data CoincidenceSubscribed x a
1165+ = CoincidenceSubscribed { coincidenceSubscribedCachedSubscribed :: !(IORef (Maybe (CoincidenceSubscribed x a)))
1166+ , coincidenceSubscribedOccurrence :: !(IORef (Maybe a))
1167+ , coincidenceSubscribedSubscribers :: !(WeakBag (Subscriber x a))
1168+ , coincidenceSubscribedHeight :: !(IORef Height)
1169+ , coincidenceSubscribedOuter :: {-# NOUNPACK #-} (Subscriber x (Event x a))
1170+ , coincidenceSubscribedOuterParent :: !(EventSubscription x)
1171+ , coincidenceSubscribedInnerParent :: !(IORef (Maybe (EventSubscribed x)))
1172+ , coincidenceSubscribedWeakSelf :: !(IORef (Weak (CoincidenceSubscribed x a)))
3211173#ifdef DEBUG_NODEIDS
3221174 , coincidenceSubscribedNodeId :: Int
3231175#endif
3241176 }
3251177
326−data Coincidence a
327− = Coincidence { coincidenceParent :: !(Event (Event a))
328− , coincidenceSubscribed :: !(IORef (Maybe (CoincidenceSubscribed a)))
1178+data Coincidence x a
1179+ = Coincidence { coincidenceParent :: !(Event x (Event x a))
1180+ , coincidenceSubscribed :: !(IORef (Maybe (CoincidenceSubscribed x a)))
3291181 }
3301182
331−data Box a = Box { unBox :: a }
332−
333−--type WeakSubscriber a = Weak (Subscriber a)
334−data WeakSubscriber a
335− = forall k. GCompare k => WeakSubscriberMerge !(k a) !(Weak (Box (MergeSubscribed k))) --TODO: Can we inline the GCompare?
336− | WeakSubscriberSimple !(Weak (Subscriber a))
337−
338−showWeakSubscriberType :: WeakSubscriber a -> String
339−showWeakSubscriberType = \case
340− WeakSubscriberMerge _ _ -> "WeakSubscriberMerge"
341− WeakSubscriberSimple _ -> "WeakSubscriberSimple"
342−
343−deRefWeakSubscriber :: WeakSubscriber a -> IO (Maybe (Subscriber a))
344−deRefWeakSubscriber ws = case ws of
345− WeakSubscriberSimple w -> deRefWeak w
346− WeakSubscriberMerge k w -> liftM (fmap $ SubscriberMerge k . unBox) $ deRefWeak w
347−
348−data Subscriber a
349− = forall b. SubscriberPush !(a -> EventM (Maybe b)) (PushSubscribed a b)
350− | forall k. GCompare k => SubscriberMerge !(k a) (MergeSubscribed k) --TODO: Can we inline the GCompare?
351− | forall k. (GCompare k, a ~ DMap k) => SubscriberFan (FanSubscribed k)
352− | SubscriberHold !(Hold a)
353− | SubscriberSwitch (SwitchSubscribed a)
354− | forall b. a ~ Event b => SubscriberCoincidenceOuter (CoincidenceSubscribed b)
355− | SubscriberCoincidenceInner (CoincidenceSubscribed a)
356−
357−showSubscriberType :: Subscriber a -> String
358−showSubscriberType = \case
359− SubscriberPush _ _ -> "SubscriberPush"
360− SubscriberMerge _ _ -> "SubscriberMerge"
361− SubscriberFan _ -> "SubscriberFan"
362− SubscriberHold _ -> "SubscriberHold"
363− SubscriberSwitch _ -> "SubscriberSwitch"
364− SubscriberCoincidenceOuter _ -> "SubscriberCoincidenceOuter"
365− SubscriberCoincidenceInner _ -> "SubscriberCoincidenceInner"
366−
367−data Event a
368− = EventRoot !(Root a)
369− | EventNever
370− | forall b. EventPush !(Push b a)
371− | forall k. (GCompare k, a ~ DMap k) => EventMerge !(Merge k)
372− | forall k. GCompare k => EventFan !(k a) !(Fan k)
373− | EventSwitch !(Switch a)
374− | EventCoincidence !(Coincidence a)
375−
376−showEventType :: Event a -> String
377−showEventType = \case
378− EventRoot _ -> "EventRoot"
379− EventNever -> "EventNever"
380− EventPush _ -> "EventPush"
381− EventMerge _ -> "EventMerge"
382− EventFan _ _ -> "EventFan"
383− EventSwitch _ -> "EventSwitch"
384− EventCoincidence _ -> "EventCoincidence"
385−
386−data EventSubscribed a
387− = EventSubscribedRoot !(RootSubscribed a)
388− | EventSubscribedNever
389− | forall b. EventSubscribedPush !(PushSubscribed b a)
390− | forall k. (GCompare k, a ~ DMap k) => EventSubscribedMerge !(MergeSubscribed k)
391− | forall k. GCompare k => EventSubscribedFan !(k a) !(FanSubscribed k)
392− | EventSubscribedSwitch !(SwitchSubscribed a)
393− | EventSubscribedCoincidence !(CoincidenceSubscribed a)
394−
395−--type role Behavior representational
396−data Behavior a
397− = BehaviorHold !(Hold a)
398− | BehaviorConst !a
399− | BehaviorPull !(Pull a)
1183+{-# NOINLINE newInvalidatorSwitch #-}
1184+newInvalidatorSwitch :: SwitchSubscribed x a -> IO (Invalidator x)
1185+newInvalidatorSwitch subd = return $! InvalidatorSwitch subd
4001186
401−-- ResultM can read behaviors and events
402−type ResultM = EventM
1187+{-# NOINLINE newInvalidatorPull #-}
1188+newInvalidatorPull :: Pull x a -> IO (Invalidator x)
1189+newInvalidatorPull p = return $! InvalidatorPull p
4031190
404−{-# NOINLINE unsafeNewIORef #-}
405−unsafeNewIORef :: a -> b -> IORef b
406−unsafeNewIORef _ b = unsafePerformIO $ newIORef b
1191+instance HasSpiderTimeline x => Filterable (Event x) where
1192+ mapMaybe f = push $ return . f
4071193
408−instance Functor Event where
409− fmap f = push $ return . Just . f
1194+instance HasSpiderTimeline x => Align (Event x) where
1195+ nil = eventNever
1196+#if MIN_VERSION_these(0, 8, 0)
1197+instance HasSpiderTimeline x => Semialign (Event x) where
1198+#endif
1199+ align ea eb = mapMaybe dmapToThese $ mergeG coerce $ dynamicConst $
1200+ DMap.fromDistinctAscList [LeftTag :=> ea, RightTag :=> eb]
4101201
411−instance Functor Behavior where
412− fmap f = pull . liftM f . readBehaviorTracked
1202+#ifdef MIN_VERSION_semialign
1203+#if MIN_VERSION_semialign(1,1,0)
1204+instance HasSpiderTimeline x => Zip (Event x) where
1205+#endif
1206+ zip x y = mapMaybe justThese $ align x y
1207+#endif
4131208
414−{-# NOINLINE push #-} --TODO: If this is helpful, we can get rid of the unsafeNewIORef and use unsafePerformIO directly
415−push :: (a -> EventM (Maybe b)) -> Event a -> Event b
416−push f e = EventPush $ Push
417− { pushCompute = f
418− , pushParent = e
419− , pushSubscribed = unsafeNewIORef (f, e) Nothing --TODO: Does the use of the tuple here create unnecessary overhead?
420− }
421−{-# RULES "push/push" forall f g e. push f (push g e) = push (maybe (return Nothing) f <=< g) e #-}
1209+data DynType x p = UnsafeDyn !(BehaviorM x (PatchTarget p), Event x p)
1210+ | BuildDyn !(EventM x (PatchTarget p), Event x p)
1211+ | HoldDyn !(Hold x p)
1212+
1213+newtype Dyn (x :: Type) p = Dyn { unDyn :: IORef (DynType x p) }
1214+
1215+newMapDyn :: HasSpiderTimeline x => (a -> b) -> DynamicS x (Identity a) -> DynamicS x (Identity b)
1216+newMapDyn f d = dynamicDynIdentity $ unsafeBuildDynamic (fmap f $ readBehaviorTracked $ dynamicCurrent d) (Identity . f . runIdentity <$> dynamicUpdated d)
1217+
1218+--TODO: Avoid the duplication between this and R.zipDynWith
1219+zipDynWith :: HasSpiderTimeline x => (a -> b -> c) -> DynamicS x (Identity a) -> DynamicS x (Identity b) -> DynamicS x (Identity c)
1220+zipDynWith f da db =
1221+ let eab = align (dynamicUpdated da) (dynamicUpdated db)
1222+ ec = flip push eab $ \o -> do
1223+ (a, b) <- case o of
1224+ This (Identity a) -> do
1225+ b <- readBehaviorUntracked $ dynamicCurrent db
1226+ return (a, b)
1227+ That (Identity b) -> do
1228+ a <- readBehaviorUntracked $ dynamicCurrent da
1229+ return (a, b)
1230+ These (Identity a) (Identity b) -> return (a, b)
1231+ return $ Just $ Identity $ f a b
1232+ in dynamicDynIdentity $ unsafeBuildDynamic (f <$> readBehaviorUntracked (dynamicCurrent da) <*> readBehaviorUntracked (dynamicCurrent db)) ec
1233+
1234+buildDynamic :: (Defer (SomeDynInit x) m, Patch p) => EventM x (PatchTarget p) -> Event x p -> m (Dyn x p)
1235+buildDynamic readV0 v' = do
1236+ result <- liftIO $ newIORef $ BuildDyn (readV0, v')
1237+ let !d = Dyn result
1238+ defer $ SomeDynInit d
1239+ return d
1240+
1241+unsafeBuildDynamic :: BehaviorM x (PatchTarget p) -> Event x p -> Dyn x p
1242+unsafeBuildDynamic readV0 v' =
1243+ Dyn $ unsafePerformIO $ newIORef $ UnsafeDyn (readV0, v')
4221244
423−{-# NOINLINE pull #-}
424−pull :: BehaviorM a -> Behavior a
425−pull a = BehaviorPull $ Pull
426− { pullCompute = a
427− , pullValue = unsafeNewIORef a Nothing
428− }
429−{-# RULES "pull/pull" forall a. pull (readBehaviorTracked (pull a)) = pull a #-}
1245+-- ResultM can read behaviors and events
1246+type ResultM = EventM
4301247
431−{-# NOINLINE switch #-}
432−switch :: Behavior (Event a) -> Event a
433−switch a = EventSwitch $ Switch
434− { switchParent = a
435− , switchSubscribed = unsafeNewIORef a Nothing
436− }
437−{-# RULES "switch/constB" forall e. switch (BehaviorConst e) = e #-}
1248+instance HasSpiderTimeline x => Functor (Event x) where
1249+ fmap f = push $ return . Just . f
4381250
439−coincidence :: Event (Event a) -> Event a
440−coincidence a = EventCoincidence $ Coincidence
441− { coincidenceParent = a
442− , coincidenceSubscribed = unsafeNewIORef a Nothing
443− }
1251+instance Functor (Behavior x) where
1252+ fmap f = pull . fmap f . readBehaviorTracked
1253+
1254+{-# INLINE push #-}
1255+push :: HasSpiderTimeline x => (a -> ComputeM x (Maybe b)) -> Event x a -> Event x b
1256+push f e = cacheEvent (pushCheap f e)
4441257
445−newRoot :: IO (Root a)
446−newRoot = do
447− occRef <- newIORef Nothing
448− subscribedRef <- newIORef Nothing
449− return $ Root
450− { rootOccurrence = occRef
451− , rootSubscribed = subscribedRef
452− , rootInit = const $ return $ return ()
1258+{-# INLINABLE pull #-}
1259+pull :: BehaviorM x a -> Behavior x a
1260+pull a = unsafePerformIO $ do
1261+ ref <- newIORef Nothing
1262+#ifdef DEBUG_NODEIDS
1263+ nid <- newNodeId
1264+#endif
1265+ pure $ behaviorPull $ Pull
1266+ { pullCompute = a
1267+ , pullValue = ref
1268+#ifdef DEBUG_NODEIDS
1269+ , pullNodeId = nid
1270+#endif
4531271 }
4541272
455−propagateAndUpdateSubscribersRef subscribersRef a = do
456− subscribers <- liftIO $ readIORef subscribersRef
457− liftIO $ writeIORef subscribersRef []
458− stillAlive <- propagate a subscribers
459− liftIO $ modifyIORef' subscribersRef (++stillAlive)
1273+{-# INLINABLE switch #-}
1274+switch :: HasSpiderTimeline x => Behavior x (Event x a) -> Event x a
1275+switch a = unsafePerformIO $ do
1276+ ref <- newIORef Nothing
1277+ pure $ eventSwitch $ Switch
1278+ { switchParent = a
1279+ , switchSubscribed = ref
1280+ }
1281+
1282+coincidence :: HasSpiderTimeline x => Event x (Event x a) -> Event x a
1283+coincidence a = unsafePerformIO $ do
1284+ ref <- newIORef Nothing
1285+ pure $ eventCoincidence $ Coincidence
1286+ { coincidenceParent = a
1287+ , coincidenceSubscribed = ref
1288+ }
4601289
4611290-- Propagate the given event occurrence; before cleaning up, run the given action, which may read the state of events and behaviors
462−run :: [DSum RootTrigger] -> ResultM b -> IO b
1291+run :: forall x b. HasSpiderTimeline x => [DSum (RootTrigger x) Identity] -> ResultM x b -> SpiderHost x b
4631292run roots after = do
464− when debugPropagate $ putStrLn "Running an event frame"
465− result <- runFrame $ do
466− forM_ roots $ \(RootTrigger (_, occRef) :=> a) -> do
467− liftIO $ writeIORef occRef $ Just a
468− scheduleClear occRef
469− forM_ roots $ \(RootTrigger (subscribersRef, _) :=> a) -> do
470− propagateAndUpdateSubscribersRef subscribersRef a
471− delayedRef <- EventM $ asks eventEnvDelayedMerges
1293+ tracePropagate (Proxy :: Proxy x) $ "Running an event frame with " <> show (length roots) <> " events"
1294+ let t = spiderTimeline :: SpiderTimelineEnv x
1295+ result <- SpiderHost $ withMVar (_spiderTimeline_lock (unSTE t)) $ \_ -> unSpiderHost $ runFrame $ do
1296+ rootsToPropagate <- forM roots $ \r@(RootTrigger (_, occRef, k) :=> a) -> do
1297+ occBefore <- liftIO $ do
1298+ occBefore <- readIORef occRef
1299+ writeIORef occRef $! DMap.insert k a occBefore
1300+ return occBefore
1301+ if DMap.null occBefore
1302+ then do scheduleRootClear occRef
1303+ return $ Just r
1304+ else return Nothing
1305+ forM_ (catMaybes rootsToPropagate) $ \(RootTrigger (subscribersRef, _, _) :=> Identity a) -> do
1306+ propagate a subscribersRef
1307+ delayedRef <- asksEventEnv eventEnvDelayedMerges
4721308 let go = do
4731309 delayed <- liftIO $ readIORef delayedRef
4741310 case IntMap.minViewWithKey delayed of
4751311 Nothing -> return ()
476− Just ((currentHeight, current), future) -> do
477− when debugPropagate $ liftIO $ putStrLn $ "Running height " ++ show currentHeight
478− putCurrentHeight currentHeight
479− liftIO $ writeIORef delayedRef future
480− forM_ current $ \d -> case d of
481− DelayedMerge subscribed -> do
482− height <- liftIO $ readIORef $ mergeSubscribedHeight subscribed
483− case height `compare` currentHeight of
484− LT -> error "Somehow a merge's height has been decreased after it was scheduled"
485− GT -> scheduleMerge height subscribed -- The height has been increased (by a coincidence event; TODO: is this the only way?)
486− EQ -> do
487− m <- liftIO $ readIORef $ mergeSubscribedAccum subscribed
488− liftIO $ writeIORef (mergeSubscribedAccum subscribed) DMap.empty
489− --TODO: Assert that m is not empty
490− liftIO $ writeIORef (mergeSubscribedOccurrence subscribed) $ Just m
491− scheduleClear $ mergeSubscribedOccurrence subscribed
492− propagateAndUpdateSubscribersRef (mergeSubscribedSubscribers subscribed) m
1312+ Just ((currentHeight, cur), future) -> do
1313+ tracePropagate (Proxy :: Proxy x) $ "Running height " ++ show currentHeight
1314+ putCurrentHeight $ Height currentHeight
1315+ liftIO $ writeIORef delayedRef $! future
1316+ sequence_ cur
4931317 go
4941318 go
4951319 putCurrentHeight maxBound
4961320 after
497− when debugPropagate $ putStrLn "Done running an event frame"
1321+ tracePropagate (Proxy :: Proxy x) "Done running an event frame"
4981322 return result
4991323
500−data SomeMaybeIORef = forall a. SomeMaybeIORef (IORef (Maybe a))
1324+scheduleMerge' :: HasSpiderTimeline x => Height -> IORef Height -> EventM x () -> EventM x ()
1325+scheduleMerge' initialHeight heightRef a = scheduleMerge initialHeight $ do
1326+ height <- liftIO $ readIORef heightRef
1327+ currentHeight <- getCurrentHeight
1328+ case height `compare` currentHeight of
1329+ LT -> error "Somehow a merge's height has been decreased after it was scheduled"
1330+ GT -> scheduleMerge' height heightRef a -- The height has been increased (by a coincidence event; TODO: is this the only way?)
1331+ EQ -> a
1332+
1333+newtype Clear a = Clear (IORef (Maybe a))
5011334
502−data SomeAssignment = forall a. SomeAssignment (Hold a) a
1335+newtype IntClear a = IntClear (IORef (IntMap a))
5031336
504−data DelayedMerge = forall k. DelayedMerge (MergeSubscribed k)
1337+newtype RootClear k = RootClear (IORef (DMap k Identity))
1338+
1339+data SomeAssignment x = forall a. SomeAssignment {-# UNPACK #-} !(IORef a) {-# UNPACK #-} !(IORef [Weak (Invalidator x)]) a
5051340
5061341debugFinalize :: Bool
5071342debugFinalize = False
5081343
5091344mkWeakPtrWithDebug :: a -> String -> IO (Weak a)
510−mkWeakPtrWithDebug x debugNote = mkWeakPtr x $
511− if debugFinalize
512− then Just $ putStrLn $ "finalizing: " ++ debugNote
513− else Nothing
1345+mkWeakPtrWithDebug x debugNote = do
1346+ x' <- evaluate x
1347+ mkWeakPtr x' $
1348+ if debugFinalize
1349+ then Just $ debugStrLn $ "finalizing: " ++ debugNote
1350+ else Nothing
5141351
5151352type WeakList a = [Weak a]
5161353
517−--TODO: Is it faster to clean up every time, or to occasionally go through and clean up as needed?
518−traverseAndCleanWeakList_ :: Monad m => (wa -> m (Maybe a)) -> [wa] -> (a -> m ()) -> m [wa]
519−traverseAndCleanWeakList_ deRef ws f = go ws
520− where go [] = return []
521− go (h:t) = do
522− ma <- deRef h
523− case ma of
524− Just a -> do
525− f a
526− t' <- go t
527− return $ h : t'
528− Nothing -> go t
1354+type CanTrace x m = (HasSpiderTimeline x, MonadIO m)
5291355
530−-- | Propagate everything at the current height
531−propagate :: a -> [WeakSubscriber a] -> EventM [WeakSubscriber a]
532−propagate a subscribers = do
533− traverseAndCleanWeakList_ (liftIO . deRefWeakSubscriber) subscribers $ \s -> case s of
534− SubscriberPush compute subscribed -> do
535− when debugPropagate $ liftIO $ putStrLn $ "SubscriberPush" <> showNodeId subscribed
536− occ <- compute a
537− case occ of
538− Nothing -> return () -- No need to write a Nothing back into the Ref
539− Just o -> do
540− liftIO $ writeIORef (pushSubscribedOccurrence subscribed) occ
541− scheduleClear $ pushSubscribedOccurrence subscribed
542− liftIO . writeIORef (pushSubscribedSubscribers subscribed) =<< propagate o =<< liftIO (readIORef (pushSubscribedSubscribers subscribed))
543− SubscriberMerge k subscribed -> do
544− when debugPropagate $ liftIO $ putStrLn $ "SubscriberMerge" <> showNodeId subscribed
545− oldM <- liftIO $ readIORef $ mergeSubscribedAccum subscribed
546− liftIO $ writeIORef (mergeSubscribedAccum subscribed) $ DMap.insertWith (error "Same key fired multiple times for") k a oldM
547− when (DMap.null oldM) $ do -- Only schedule the firing once
548− height <- liftIO $ readIORef $ mergeSubscribedHeight subscribed
549− --TODO: assertions about height
550− currentHeight <- getCurrentHeight
551− when (height <= currentHeight) $ error $ "Height (" ++ show height ++ ") is not greater than current height (" ++ show currentHeight ++ ")"
552− scheduleMerge height subscribed
553− SubscriberFan subscribed -> do
554− subs <- liftIO $ readIORef $ fanSubscribedSubscribers subscribed
555− when debugPropagate $ liftIO $ putStrLn $ "SubscriberFan" <> showNodeId subscribed <> ": " ++ show (DMap.size subs) ++ " keys subscribed, " ++ show (DMap.size a) ++ " keys firing"
556− --TODO: We need a better DMap intersection; here, we are assuming that the number of firing keys is small and the number of subscribers is large
557− forM_ (DMap.toList a) $ \(k :=> v) -> case DMap.lookup (FanSubscriberKey k) subs of
558− Nothing -> do
559− when debugPropagate $ liftIO $ putStrLn "No subscriber for key"
560− return ()
561− Just subsubs -> do
562− _ <- propagate v subsubs --TODO: use the value of this
563− return ()
564− --TODO: The following is way too slow to do all the time
565− subs' <- liftIO $ forM (DMap.toList subs) $ ((\(FanSubscriberKey k :=> subsubs) -> do
566− subsubs' <- traverseAndCleanWeakList_ (liftIO . deRefWeakSubscriber) subsubs (const $ return ())
567− return $ if null subsubs' then Nothing else Just $ FanSubscriberKey k :=> subsubs') :: DSum (FanSubscriberKey k) -> IO (Maybe (DSum (FanSubscriberKey k))))
568− liftIO $ writeIORef (fanSubscribedSubscribers subscribed) $ DMap.fromDistinctAscList $ catMaybes subs'
569− SubscriberHold h -> do
570− invalidators <- liftIO $ readIORef $ holdInvalidators h
571− when debugPropagate $ liftIO $ putStrLn $ "SubscriberHold" <> showNodeId h <> ": " ++ show (length invalidators)
572− toAssignRef <- askToAssignRef
573− liftIO $ modifyIORef' toAssignRef (SomeAssignment h a :)
574− SubscriberSwitch subscribed -> do
575− when debugPropagate $ liftIO $ putStrLn $ "SubscriberSwitch" <> showNodeId subscribed
576− liftIO $ writeIORef (switchSubscribedOccurrence subscribed) $ Just a
577− scheduleClear $ switchSubscribedOccurrence subscribed
578− subs <- liftIO $ readIORef $ switchSubscribedSubscribers subscribed
579− liftIO . writeIORef (switchSubscribedSubscribers subscribed) =<< propagate a subs
580− SubscriberCoincidenceOuter subscribed -> do
581− when debugPropagate $ liftIO $ putStrLn $ "SubscriberCoincidenceOuter" <> showNodeId subscribed
582− outerHeight <- liftIO $ readIORef $ coincidenceSubscribedHeight subscribed
583− when debugPropagate $ liftIO $ putStrLn $ " outerHeight = " <> show outerHeight
584− (occ, innerHeight, innerSubd) <- subscribeCoincidenceInner a outerHeight subscribed
585− when debugPropagate $ liftIO $ putStrLn $ " isJust occ = " <> show (isJust occ)
586− when debugPropagate $ liftIO $ putStrLn $ " innerHeight = " <> show innerHeight
587− liftIO $ writeIORef (coincidenceSubscribedInnerParent subscribed) $ Just innerSubd
588− scheduleClear $ coincidenceSubscribedInnerParent subscribed
589− case occ of
590− Nothing -> do
591− when (innerHeight > outerHeight) $ liftIO $ do -- If the event fires, it will fire at a later height
592− writeIORef (coincidenceSubscribedHeight subscribed) innerHeight
593− mapM_ invalidateSubscriberHeight =<< readIORef (coincidenceSubscribedSubscribers subscribed)
594− mapM_ recalculateSubscriberHeight =<< readIORef (coincidenceSubscribedSubscribers subscribed)
595− Just o -> do -- Since it's already firing, no need to adjust height
596− liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) occ
597− scheduleClear $ coincidenceSubscribedOccurrence subscribed
598− liftIO . writeIORef (coincidenceSubscribedSubscribers subscribed) =<< propagate o =<< liftIO (readIORef (coincidenceSubscribedSubscribers subscribed))
599− SubscriberCoincidenceInner subscribed -> do
600− when debugPropagate $ liftIO $ putStrLn $ "SubscriberCoincidenceInner" <> showNodeId subscribed
601− liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) $ Just a
602− scheduleClear $ coincidenceSubscribedOccurrence subscribed
603− liftIO . writeIORef (coincidenceSubscribedSubscribers subscribed) =<< propagate a =<< liftIO (readIORef (coincidenceSubscribedSubscribers subscribed))
604−
605−data SomeCoincidenceInfo = forall a. SomeCoincidenceInfo (Weak (Subscriber a)) (Subscriber a) (Maybe (CoincidenceSubscribed a)) -- The CoincidenceSubscriber will be present only if heights need to be reset
606−
607−subscribeCoincidenceInner :: Event a -> Int -> CoincidenceSubscribed a -> EventM (Maybe a, Int, EventSubscribed a)
608−subscribeCoincidenceInner o outerHeight subscribedUnsafe = do
609− let !subInner = SubscriberCoincidenceInner subscribedUnsafe
610− wsubInner <- liftIO $ mkWeakPtrWithDebug subInner "SubscriberCoincidenceInner"
611− innerSubd <- {-# SCC "innerSubd" #-} (subscribe o $ WeakSubscriberSimple wsubInner)
612− innerOcc <- liftIO $ getEventSubscribedOcc innerSubd
613− innerHeight <- liftIO $ readIORef $ eventSubscribedHeightRef innerSubd
614− let height = max innerHeight outerHeight
615− emitCoincidenceInfo $ SomeCoincidenceInfo wsubInner subInner $ if height > outerHeight then Just subscribedUnsafe else Nothing
616− return (innerOcc, height, innerSubd)
6171356
618−readBehavior :: Behavior a -> IO a
619−readBehavior b = runBehaviorM (readBehaviorTracked b) Nothing --TODO: Specialize readBehaviorTracked to the Nothing and Just cases
6201357
621−runBehaviorM :: BehaviorM a -> Maybe (Weak Invalidator, IORef [SomeBehaviorSubscribed]) -> IO a
622−runBehaviorM a mwi = runReaderT (unBehaviorM a) mwi
6231358
624−askInvalidator :: BehaviorM (Maybe (Weak Invalidator))
625−askInvalidator = liftM (fmap fst) $ BehaviorM ask
1359+#ifdef DEBUG
6261360
627−askParentsRef :: BehaviorM (Maybe (IORef [SomeBehaviorSubscribed]))
628−askParentsRef = liftM (fmap snd) $ BehaviorM ask
1361+debugSubscriber :: forall x a. HasSpiderTimeline x => String -> Subscriber x a -> IO (Subscriber x a)
1362+debugSubscriber description = return . debugSubscriber' description
1363+
1364+debugSubscriber' :: forall x a. HasSpiderTimeline x => String -> Subscriber x a -> Subscriber x a
1365+debugSubscriber' description subscribed = Subscriber
1366+ {
1367+ subscriberPropagate = \m -> do
1368+ tracePropagate (Proxy :: Proxy x) ("subscriberPropagate: " <> description)
1369+ subscriberPropagate subscribed m
1370+ , subscriberInvalidateHeight = \old -> do
1371+ traceInvalidateHeight $ "invalidateSubscriberHeight: " <> description <> ", old = " <> show (unHeight old)
1372+ subscriberInvalidateHeight subscribed old
1373+ traceInvalidateHeight $ "invalidateSubscriberHeight: " <> description <> ", done"
1374+ , subscriberRecalculateHeight = \new -> do
1375+ traceInvalidateHeight $ "subscriberRecalculateHeight: " <> description <> ", new = " <> show (unHeight new)
1376+ subscriberRecalculateHeight subscribed new
1377+ traceInvalidateHeight $ "subscriberRecalculateHeight: " <> description <> ", done"
1378+ }
6291379
630−readBehaviorTracked :: Behavior a -> BehaviorM a
631−readBehaviorTracked b = case b of
632− BehaviorHold h -> do
633− result <- liftIO $ readIORef $ holdValue h
634− askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (holdInvalidators h) (wi:))
635− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedHold h) :))
636− liftIO $ touch $ holdSubscriber h
637− return result
638− BehaviorConst a -> return a
639− BehaviorPull p -> do
640− val <- liftIO $ readIORef $ pullValue p
641− case val of
642− Just subscribed -> do
643− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
644− askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (pullSubscribedInvalidators subscribed) (wi:))
645− liftIO $ touch $ pullSubscribedOwnInvalidator subscribed
646− return $ pullSubscribedValue subscribed
647− Nothing -> do
648− let !i = InvalidatorPull p
649− wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorPull"
650− parentsRef <- liftIO $ newIORef []
651− a <- liftIO $ runReaderT (unBehaviorM $ pullCompute p) $ Just (wi, parentsRef)
652− invsRef <- liftIO . newIORef . maybeToList =<< askInvalidator
653− parents <- liftIO $ readIORef parentsRef
654− let subscribed = PullSubscribed
655− { pullSubscribedValue = a
656− , pullSubscribedInvalidators = invsRef
657− , pullSubscribedOwnInvalidator = i
658− , pullSubscribedParents = parents
659− }
660− liftIO $ writeIORef (pullValue p) $ Just subscribed
661− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
662− return a
6631380
664−readEvent :: Event a -> ResultM (Maybe a)
665−readEvent e = case e of
666− EventRoot r -> liftIO $ readIORef $ rootOccurrence r
667− EventNever -> return Nothing
668− EventPush p -> do
669− subscribed <- getPushSubscribed p
670− liftIO $ do
671− result <- readIORef $ pushSubscribedOccurrence subscribed -- Since ResultM is always called after the final height is reached, this will always be valid
672− touch $ pushSubscribedSelf subscribed
673− return result
674− EventMerge m -> do
675− subscribed <- getMergeSubscribed m
676− liftIO $ do
677− result <- readIORef $ mergeSubscribedOccurrence subscribed
678− touch $ mergeSubscribedSelf subscribed
679− return result
680− EventFan k f -> do
681− parentOcc <- readEvent $ fanParent f
682− return $ DMap.lookup k =<< parentOcc
683− EventSwitch s -> do
684− subscribed <- getSwitchSubscribed s
685− liftIO $ do
686− result <- readIORef $ switchSubscribedOccurrence subscribed
687− touch $ switchSubscribedSelf subscribed
688− touch $ switchSubscribedOwnInvalidator subscribed
689− return result
690− EventCoincidence c -> do
691− subscribed <- getCoincidenceSubscribed c
692− liftIO $ do
693− result <- readIORef $ coincidenceSubscribedOccurrence subscribed
694− touch $ coincidenceSubscribedOuter subscribed
695− --TODO: do we need to touch the inner subscriber?
696− return result
1381+{-# INLINE withIncreasedDepth #-}
1382+withIncreasedDepth :: forall proxy x m a. CanTrace x m => proxy x -> m a -> m a
1383+withIncreasedDepth _ a = do
1384+ liftIO $ modifyIORef' (_spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)) succ
1385+ result <- a
1386+ liftIO $ modifyIORef' (_spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)) pred
1387+ return result
1388+
1389+{-# INLINE tracePropagate #-}
1390+tracePropagate :: (CanTrace x m) => proxy x -> String -> m ()
1391+tracePropagate p = when debugPropagate . trace p
1392+
1393+{-# INLINE traceInvalidate #-}
1394+traceInvalidate :: String -> IO ()
1395+traceInvalidate = when debugInvalidate . liftIO . debugStrLn
1396+
1397+{-# INLINE traceInvalidateHeight #-}
1398+traceInvalidateHeight :: String -> IO ()
1399+traceInvalidateHeight = when debugInvalidateHeight . liftIO . debugStrLn
1400+
1401+{-# INLINE trace #-}
1402+trace :: (CanTrace x m) => proxy x -> String -> m ()
1403+trace p message = traceM p $ return message
1404+
1405+{-# INLINE traceM #-}
1406+traceM :: forall x proxy m. (CanTrace x m) => proxy x -> m String -> m ()
1407+traceM _ getMessage = do
1408+ message <- getMessage
1409+ d <- liftIO $ readIORef $ _spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)
1410+ liftIO $ debugStrLn $ replicate d ' ' <> message
1411+
1412+#else
1413+
1414+{-# INLINE withIncreasedDepth #-}
1415+withIncreasedDepth :: proxy x -> m a -> m a
1416+withIncreasedDepth _ = id
1417+
1418+{-# INLINE tracePropagate #-}
1419+tracePropagate :: (CanTrace x m) => proxy x -> String -> m ()
1420+tracePropagate _ _ = return ()
1421+
1422+{-# INLINE traceInvalidate #-}
1423+traceInvalidate :: String -> IO ()
1424+traceInvalidate _ = return ()
1425+
1426+{-# INLINE traceInvalidateHeight #-}
1427+traceInvalidateHeight :: String -> IO ()
1428+traceInvalidateHeight _ = return ()
1429+
1430+{-# INLINE debugSubscriber #-}
1431+debugSubscriber :: String -> Subscriber x a -> IO (Subscriber x a)
1432+debugSubscriber _ = return
1433+
1434+{-# INLINE debugSubscriber' #-}
1435+debugSubscriber' :: String -> Subscriber x a -> Subscriber x a
1436+debugSubscriber' _ = id
1437+
1438+
1439+
1440+{-# INLINE trace #-}
1441+trace :: (CanTrace x m) => proxy x -> String -> m ()
1442+trace _ _ = return ()
1443+
1444+{-# INLINE traceM #-}
1445+traceM :: (CanTrace x m) => proxy x -> m String -> m ()
1446+traceM _ _ = return ()
1447+
1448+#endif
1449+
1450+whoCreatedIORef :: IORef a -> IO [String]
1451+whoCreatedIORef (IORef a) = whoCreated $! a
1452+
1453+groupByHead :: Eq a => [NonEmpty a] -> [(a, NonEmpty [a])]
1454+groupByHead = \case
1455+ [] -> []
1456+ (x :| xs) : t -> case groupByHead t of
1457+ [] -> [(x, xs :| [])]
1458+ l@((y, yss) : t')
1459+ | x == y -> (x, xs `NonEmpty.cons` yss) : t'
1460+ | otherwise -> (x, xs :| []) : l
1461+
1462+listsToForest :: Eq a => [[a]] -> Forest a
1463+listsToForest lists = buildForest <$> groupByHead (mapMaybe nonEmpty lists)
1464+ where buildForest (a, lists') = Node a $ listsToForest $ toList lists'
1465+
1466+showStacks :: [[String]] -> String
1467+showStacks = drawForest . listsToForest . fmap (filterStack "Reflex.Spider.Internal")
1468+
1469+filterStack :: String -> [String] -> [String]
1470+#ifdef DEBUG_HIDE_INTERNALS
1471+filterStack prefix = filter (not . (prefix `isPrefixOf`))
1472+#else
1473+filterStack prefix = id
1474+#endif
1475+
1476+#ifdef DEBUG_CYCLES
1477+
1478+data EventLoopException = EventLoopException [[String]]
1479+instance Exception EventLoopException
1480+
1481+instance Show EventLoopException where
1482+ show (EventLoopException stacks) = "causality loop detected:\n" <> if null stacks
1483+ then "no location information, compile with profiling enabled for stack tree"
1484+ else showStacks stacks
1485+
1486+#else
1487+
1488+data EventLoopException = EventLoopException
1489+instance Exception EventLoopException
1490+
1491+instance Show EventLoopException where
1492+ show EventLoopException = "causality loop detected: \n" <>
1493+ "compile reflex with flag 'debug-cycles' and compile with profiling enabled for stack tree"
1494+
1495+#endif
1496+
1497+
1498+{-# INLINE propagateSubscriberHold #-}
1499+propagateSubscriberHold :: forall x p. (HasSpiderTimeline x, Patch p) => Hold x p -> p -> EventM x ()
1500+propagateSubscriberHold h a = do
1501+ {-# SCC "trace" #-} when debugPropagate $ traceM (Proxy :: Proxy x) $ liftIO $ do
1502+ invalidators <- liftIO $ readIORef $ holdInvalidators h
1503+ return $ "SubscriberHold" <> showNodeId h <> ": " ++ show (length invalidators)
1504+
1505+ v <- {-# SCC "read" #-} liftIO $ readIORef $ holdValue h
1506+ case {-# SCC "apply" #-} apply a v of
1507+ Nothing -> return ()
1508+ Just v' -> do
1509+ {-# SCC "trace2" #-} withIncreasedDepth (Proxy :: Proxy x) $
1510+ tracePropagate (Proxy :: Proxy x) ("propagateSubscriberHold: assigning Hold" <> showNodeId h)
1511+ vRef <- {-# SCC "vRef" #-} liftIO $ evaluate $ holdValue h
1512+ iRef <- {-# SCC "iRef" #-} liftIO $ evaluate $ holdInvalidators h
1513+ defer $ {-# SCC "assignment" #-} SomeAssignment vRef iRef v'
1514+
1515+data SomeResetCoincidence x = forall a. SomeResetCoincidence !(EventSubscription x) !(Maybe (CoincidenceSubscribed x a)) -- The CoincidenceSubscriber will be present only if heights need to be reset
1516+
1517+runBehaviorM :: BehaviorM x a -> Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]) -> IORef [SomeHoldInit x] -> IO a
1518+runBehaviorM a mwi holdInits = runReaderIO (unBehaviorM a) (mwi, holdInits)
1519+
1520+askInvalidator :: BehaviorM x (Maybe (Weak (Invalidator x)))
1521+askInvalidator = do
1522+ (!m, _) <- ask
1523+ case m of
1524+ Nothing -> return Nothing
1525+ Just (!wi, _) -> return $ Just wi
1526+
1527+askParentsRef :: BehaviorM x (Maybe (IORef [SomeBehaviorSubscribed x]))
1528+askParentsRef = do
1529+ (!m, _) <- ask
1530+ case m of
1531+ Nothing -> return Nothing
1532+ Just (_, !p) -> return $ Just p
1533+
1534+askBehaviorHoldInits :: BehaviorM x (IORef [SomeHoldInit x])
1535+askBehaviorHoldInits = do
1536+ (_, !his) <- ask
1537+ return his
1538+
1539+{-# INLINE getDynHold #-}
1540+getDynHold :: (Defer (SomeHoldInit x) m, Patch p) => Dyn x p -> m (Hold x p)
1541+getDynHold d = do
1542+ mh <- liftIO $ readIORef $ unDyn d
1543+ case mh of
1544+ HoldDyn h -> return h
1545+ UnsafeDyn (readV0, v') -> do
1546+ holdInits <- getDeferralQueue
1547+ v0 <- liftIO $ runBehaviorM readV0 Nothing holdInits
1548+ hold' v0 v'
1549+ BuildDyn (readV0, v') -> do
1550+ v0 <- liftIO $ runEventM readV0
1551+ hold' v0 v'
1552+ where
1553+ hold' v0 v' = do
1554+ h <- hold v0 v'
1555+ liftIO $ writeIORef (unDyn d) $ HoldDyn h
1556+ return h
1557+
6971558
6981559-- Always refers to 0
6991560{-# NOINLINE zeroRef #-}
700−zeroRef :: IORef Int
701−zeroRef = unsafePerformIO $ newIORef 0
702−
703−getEventSubscribed :: Event a -> EventM (EventSubscribed a)
704−getEventSubscribed e = case e of
705− EventRoot r -> liftM EventSubscribedRoot $ getRootSubscribed r
706− EventNever -> return EventSubscribedNever
707− EventPush p -> liftM EventSubscribedPush $ getPushSubscribed p
708− EventFan k f -> liftM (EventSubscribedFan k) $ getFanSubscribed f
709− EventMerge m -> liftM EventSubscribedMerge $ getMergeSubscribed m
710− EventSwitch s -> liftM EventSubscribedSwitch $ getSwitchSubscribed s
711− EventCoincidence c -> liftM EventSubscribedCoincidence $ getCoincidenceSubscribed c
712−
713−debugSubscribe :: Bool
714−debugSubscribe = False
715−
716−subscribeEventSubscribed :: EventSubscribed a -> WeakSubscriber a -> IO ()
717−subscribeEventSubscribed es ws = case es of
718− EventSubscribedRoot r -> do
719− when debugSubscribe $ liftIO $ putStrLn $ "subscribeEventSubscribed Root"
720− modifyIORef' (rootSubscribedSubscribers r) (ws:)
721− EventSubscribedNever -> do
722− when debugSubscribe $ liftIO $ putStrLn $ "subscribeEventSubscribed Never"
723− return ()
724− EventSubscribedPush subscribed -> do
725− when debugSubscribe $ liftIO $ putStrLn $ "subscribeEventSubscribed Push"
726− modifyIORef' (pushSubscribedSubscribers subscribed) (ws:)
727− EventSubscribedFan k subscribed -> do
728− when debugSubscribe $ liftIO $ putStrLn $ "subscribeEventSubscribed Fan"
729− modifyIORef' (fanSubscribedSubscribers subscribed) $ DMap.insertWith (++) (FanSubscriberKey k) [ws]
730− EventSubscribedMerge subscribed -> do
731− when debugSubscribe $ liftIO $ putStrLn $ "subscribeEventSubscribed Merge"
732− modifyIORef' (mergeSubscribedSubscribers subscribed) (ws:)
733− EventSubscribedSwitch subscribed -> do
734− when debugSubscribe $ liftIO $ putStrLn $ "subscribeEventSubscribed Switch"
735− modifyIORef' (switchSubscribedSubscribers subscribed) (ws:)
736− EventSubscribedCoincidence subscribed -> do
737− when debugSubscribe $ liftIO $ putStrLn $ "subscribeEventSubscribed Coincidence"
738− modifyIORef' (coincidenceSubscribedSubscribers subscribed) (ws:)
739−
740−getEventSubscribedOcc :: EventSubscribed a -> IO (Maybe a)
741−getEventSubscribedOcc es = case es of
742− EventSubscribedRoot r -> readIORef $ rootSubscribedOccurrence r
743− EventSubscribedNever -> return Nothing
744− EventSubscribedPush subscribed -> readIORef $ pushSubscribedOccurrence subscribed
745− EventSubscribedFan k subscribed -> do
746− parentOcc <- getEventSubscribedOcc $ fanSubscribedParent subscribed
747− let occ = DMap.lookup k =<< parentOcc
748− return occ
749− EventSubscribedMerge subscribed -> readIORef $ mergeSubscribedOccurrence subscribed
750− EventSubscribedSwitch subscribed -> readIORef $ switchSubscribedOccurrence subscribed
751− EventSubscribedCoincidence subscribed -> readIORef $ coincidenceSubscribedOccurrence subscribed
752−
753−eventSubscribedHeightRef :: EventSubscribed a -> IORef Int
754−eventSubscribedHeightRef es = case es of
755− EventSubscribedRoot _ -> zeroRef
756− EventSubscribedNever -> zeroRef
757− EventSubscribedPush subscribed -> pushSubscribedHeight subscribed
758− EventSubscribedFan _ subscribed -> eventSubscribedHeightRef $ fanSubscribedParent subscribed
759− EventSubscribedMerge subscribed -> mergeSubscribedHeight subscribed
760− EventSubscribedSwitch subscribed -> switchSubscribedHeight subscribed
761− EventSubscribedCoincidence subscribed -> coincidenceSubscribedHeight subscribed
762−
763−subscribe :: Event a -> WeakSubscriber a -> EventM (EventSubscribed a)
764−subscribe e ws = do
765− subd <- getEventSubscribed e
766− liftIO $ subscribeEventSubscribed subd ws
767− return subd
768−
769−getRootSubscribed :: Root a -> EventM (RootSubscribed a)
770−getRootSubscribed r = do
771− mSubscribed <- liftIO $ readIORef $ rootSubscribed r
772− case mSubscribed of
773− Just subscribed -> return subscribed
774− Nothing -> liftIO $ do
775− subscribersRef <- newIORef []
1561+zeroRef :: IORef Height
1562+zeroRef = unsafePerformIO $ newIORef zeroHeight
1563+
1564+getRootSubscribed :: forall k x a. (GCompare k, HasSpiderTimeline x) => k a -> Root x k -> Subscriber x a -> IO (WeakBagTicket, RootSubscribed x a, Maybe a)
1565+getRootSubscribed k r sub = do
1566+ mSubscribed <- readIORef $ rootSubscribed r
1567+ let getOcc = fmap (coerce . DMap.lookup k) $ readIORef $ rootOccurrence r
1568+ case DMap.lookup k mSubscribed of
1569+ Just subscribed -> {-# SCC "hitRoot" #-} do
1570+ sln <- subscribeRootSubscribed subscribed sub
1571+ occ <- getOcc
1572+ return (sln, subscribed, occ)
1573+ Nothing -> {-# SCC "missRoot" #-} do
1574+ weakSelf <- newIORef $ error "getRootSubscribed: weakSelfRef not initialized"
1575+ let !cached = rootSubscribed r
1576+ uninitRef <- newIORef $ error "getRootsubscribed: uninitRef not initialized"
1577+ (subs, sln) <- WeakBag.singleton sub weakSelf cleanupRootSubscribed
1578+
1579+ tracePropagate (Proxy::Proxy x) $ "getRootSubscribed: calling rootInit"
1580+
1581+ uninit <- rootInit r k $ RootTrigger (subs, rootOccurrence r, k)
1582+ writeIORef uninitRef $! uninit
1583+#ifdef DEBUG_NODEIDS
1584+ nid <- newNodeId
1585+#endif
7761586 let !subscribed = RootSubscribed
777− { rootSubscribedOccurrence = rootOccurrence r
778− , rootSubscribedSubscribers = subscribersRef
779− }
780− -- Strangely, init needs the same stuff as a RootSubscribed has, but it must not be the same as the one that everyone's subscribing to, or it'll leak memory
781− uninit <- rootInit r $ RootTrigger (subscribersRef, rootOccurrence r)
782− addFinalizer subscribed $ do
783−-- putStrLn "Uninit root"
784− uninit
785− liftIO $ writeIORef (rootSubscribed r) $ Just subscribed
786− return subscribed
787−
788−-- When getPushSubscribed returns, the PushSubscribed returned will have a fully filled-in
789−getPushSubscribed :: Push a b -> EventM (PushSubscribed a b)
790−getPushSubscribed p = do
791− mSubscribed <- liftIO $ readIORef $ pushSubscribed p
792− case mSubscribed of
793− Just subscribed -> return subscribed
794− Nothing -> do -- Not yet subscribed
795− subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ liftM fromJust $ readIORef $ pushSubscribed p
796− let !s = SubscriberPush (pushCompute p) subscribedUnsafe
797− ws <- liftIO $ mkWeakPtrWithDebug s "SubscriberPush"
798− subd <- subscribe (pushParent p) $ WeakSubscriberSimple ws
799− parentOcc <- liftIO $ getEventSubscribedOcc subd
800− occ <- liftM join $ mapM (pushCompute p) parentOcc
801− occRef <- liftIO $ newIORef occ
802− when (isJust occ) $ scheduleClear occRef
803− subscribersRef <- liftIO $ newIORef []
804− let subscribed = PushSubscribed
805− { pushSubscribedOccurrence = occRef
806− , pushSubscribedHeight = eventSubscribedHeightRef subd -- Since pushes have the same height as their parents, share the ref
807− , pushSubscribedSubscribers = subscribersRef
808− , pushSubscribedSelf = unsafeCoerce s
809− , pushSubscribedParent = subd
1587+ { rootSubscribedKey = k
1588+ , rootSubscribedCachedSubscribed = cached
1589+ , rootSubscribedOccurrence = getOcc
1590+ , rootSubscribedSubscribers = subs
1591+ , rootSubscribedUninit = uninit
1592+ , rootSubscribedWeakSelf = weakSelf
8101593#ifdef DEBUG_NODEIDS
811− , pushSubscribedNodeId = unsafeNodeId p
1594+ , rootSubscribedNodeId = nid
8121595#endif
8131596 }
814− liftIO $ writeIORef (pushSubscribed p) $ Just subscribed
815− return subscribed
1597+ -- If we die at the same moment that all our children die, they will
1598+ -- try to clean us up but will fail because their Weak reference to us
1599+ -- will also be dead. So, if we are dying, check if there are any
1600+ -- children; since children don't bother cleaning themselves up if
1601+ -- their parents are already dead, I don't think there's a race
1602+ -- condition here. However, if there are any children, then we can
1603+ -- infer that we need to clean ourselves up, so we do.
1604+ finalCleanup = do
1605+ cs <- readIORef $ _weakBag_children subs
1606+ when (not $ IntMap.null cs) (cleanupRootSubscribed subscribed)
1607+ writeIORef weakSelf =<< evaluate =<< mkWeakPtr subscribed (Just finalCleanup)
1608+ modifyIORef' (rootSubscribed r) $ DMap.insertWith (error $ "getRootSubscribed: duplicate key inserted into Root") k subscribed --TODO: I think we can just write back mSubscribed rather than re-reading it
1609+ occ <- getOcc
1610+ return (sln, subscribed, occ)
1611+
1612+#ifdef USE_TEMPLATE_HASKELL
1613+{-# ANN cleanupRootSubscribed "HLint: ignore Redundant bracket" #-}
1614+#endif
1615+cleanupRootSubscribed :: RootSubscribed x a -> IO ()
1616+cleanupRootSubscribed self@RootSubscribed { rootSubscribedKey = k, rootSubscribedCachedSubscribed = cached } = do
1617+ rootSubscribedUninit self
1618+ modifyIORef' cached $ DMap.delete k
8161619
817−getMergeSubscribed :: forall k. GCompare k => Merge k -> EventM (MergeSubscribed k)
818−getMergeSubscribed m = {-# SCC "getMergeSubscribed.entire" #-} do
819− mSubscribed <- liftIO $ readIORef $ mergeSubscribed m
820− case mSubscribed of
821− Just subscribed -> return subscribed
822− Nothing -> if DMap.null $ mergeParents m then emptyMergeSubscribed else do
823− subscribedRef <- liftIO $ newIORef $ error "getMergeSubscribed: subscribedRef not yet initialized"
824− subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
825− let !s = Box subscribedUnsafe
826− ws <- liftIO $ mkWeakPtrWithDebug s "SubscriberMerge"
827− subscribers :: [(Any, Maybe (DSum k), Int, DSum (WrapArg EventSubscribed k))] <- forM (DMap.toList $ mergeParents m) $ {-# SCC "getMergeSubscribed.a" #-} \(WrapArg k :=> e) -> {-# SCC "getMergeSubscribed.a1" #-} do
828− parentSubd <- {-# SCC "getMergeSubscribed.a.parentSubd" #-} subscribe e $ WeakSubscriberMerge k ws
829− parentOcc <- {-# SCC "getMergeSubscribed.a.parentOcc" #-} liftIO $ getEventSubscribedOcc parentSubd
830− height <- {-# SCC "getMergeSubscribed.a.height" #-} liftIO $ readIORef $ eventSubscribedHeightRef parentSubd
831− return $ {-# SCC "getMergeSubscribed.a.returnVal" #-} (unsafeCoerce s :: Any, fmap (k :=>) parentOcc, height, WrapArg k :=> parentSubd)
832− let dm = DMap.fromDistinctAscList $ catMaybes $ map (^._2) subscribers
833− subscriberHeights = map (^._3) subscribers
834− myHeight =
835− if any (==invalidHeight) subscriberHeights --TODO: Replace 'any' with invalidHeight-preserving 'maximum'
836− then invalidHeight
837− else succ $ Prelude.maximum subscriberHeights -- This is safe because the DMap will never be empty here
838− currentHeight <- getCurrentHeight
839− let (occ, accum) = if currentHeight >= myHeight -- If we should have fired by now
840− then (if DMap.null dm then Nothing else Just dm, DMap.empty)
841− else (Nothing, dm)
842− when (not $ DMap.null accum) $ do
843− scheduleMerge myHeight subscribedUnsafe
844− occRef <- liftIO $ newIORef occ
845− when (isJust occ) $ scheduleClear occRef
846− accumRef <- liftIO $ newIORef accum
847− heightRef <- liftIO $ newIORef myHeight
848− subsRef <- liftIO $ newIORef []
849− let subscribed = MergeSubscribed
850− { mergeSubscribedOccurrence = occRef
851− , mergeSubscribedAccum = accumRef
852− , mergeSubscribedHeight = heightRef
853− , mergeSubscribedSubscribers = subsRef
854− , mergeSubscribedSelf = unsafeCoerce $ map (\(x, _, _, _) -> x) subscribers --TODO: Does lack of strictness make this leak?
855− , mergeSubscribedParents = DMap.fromDistinctAscList $ map (^._4) subscribers
1620+{-# INLINE subscribeRootSubscribed #-}
1621+subscribeRootSubscribed :: RootSubscribed x a -> Subscriber x a -> IO WeakBagTicket
1622+subscribeRootSubscribed subscribed sub = WeakBag.insert sub (rootSubscribedSubscribers subscribed) (rootSubscribedWeakSelf subscribed) cleanupRootSubscribed
1623+
1624+newtype EventSelectorInt x a = EventSelectorInt { selectInt :: Int -> Event x a }
1625+
1626+data FanInt x a = FanInt
1627+ { _fanInt_subscribers :: {-# UNPACK #-} !(FastMutableIntMap (FastWeakBag (Subscriber x a))) --TODO: Clean up the keys in here when their child weak bags get empty --TODO: Remove our own subscription when the subscribers list is completely empty
1628+ , _fanInt_subscriptionRef :: {-# UNPACK #-} !(IORef (EventSubscription x)) -- This should have a valid subscription iff subscribers is non-empty
1629+ , _fanInt_occRef :: {-# UNPACK #-} !(IORef (IntMap a))
8561630#ifdef DEBUG_NODEIDS
857− , mergeSubscribedNodeId = unsafeNodeId m
1631+ , _fanInt_nodeId :: {-# UNPACK #-} !Int
8581632#endif
859− }
860− liftIO $ writeIORef subscribedRef subscribed
861− return subscribed
862− where emptyMergeSubscribed = do --TODO: This should never happen
863− occRef <- liftIO $ newIORef Nothing
864− accumRef <- liftIO $ newIORef DMap.empty
865− subsRef <- liftIO $ newIORef []
866− return $ MergeSubscribed
867− { mergeSubscribedOccurrence = occRef
868− , mergeSubscribedAccum = accumRef
869− , mergeSubscribedHeight = zeroRef
870− , mergeSubscribedSubscribers = subsRef --TODO: This will definitely leak
871− , mergeSubscribedSelf = unsafeCoerce ()
872− , mergeSubscribedParents = DMap.empty
1633+ }
1634+
1635+newFanInt :: IO (FanInt x a)
1636+newFanInt = do
1637+ subscribers <- FastMutableIntMap.newEmpty --TODO: Clean up the keys in here when their child weak bags get empty --TODO: Remove our own subscription when the subscribers list is completely empty
1638+ subscriptionRef <- newIORef $ error "fanInt: no subscription"
1639+ occRef <- newIORef $ error "fanInt: no occurrence"
8731640#ifdef DEBUG_NODEIDS
874− , mergeSubscribedNodeId = -1
1641+ nodeId <- newNodeId
8751642#endif
876− }
1643+ return $ FanInt
1644+ { _fanInt_subscribers = subscribers
1645+ , _fanInt_subscriptionRef = subscriptionRef
1646+ , _fanInt_occRef = occRef
1647+#ifdef DEBUG_NODEIDS
1648+ , _fanInt_nodeId = nodeId
1649+#endif
1650+ }
1651+
1652+fanInt :: HasSpiderTimeline x => Event x (IntMap a) -> EventSelectorInt x a
1653+fanInt p = unsafePerformIO $ do
1654+ self <- newFanInt
1655+ pure $ EventSelectorInt $ \k -> Event $ \sub -> do
1656+ isEmpty <- liftIO $ FastMutableIntMap.isEmpty (_fanInt_subscribers self)
1657+ when isEmpty $ do -- This is the first subscriber, so we need to subscribe to our input
1658+ let desc = "fanInt" <> showNodeId self <> ", k = " <> show k
1659+ (subscription, parentOcc) <- subscribeAndRead p $ debugSubscriber' desc $ Subscriber
1660+ { subscriberPropagate = \m -> do
1661+ liftIO $ writeIORef (_fanInt_occRef self) m
1662+ scheduleIntClear $ _fanInt_occRef self
1663+ FastMutableIntMap.forIntersectionWithImmutable_ (_fanInt_subscribers self) m $ \b v -> --TODO: Do we need to know that no subscribers are being added as we traverse?
1664+ FastWeakBag.traverse_ b $ \s ->
1665+ subscriberPropagate s v
1666+ , subscriberInvalidateHeight = \old ->
1667+ FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b ->
1668+ FastWeakBag.traverse_ b $ \s ->
1669+ subscriberInvalidateHeight s old
1670+ , subscriberRecalculateHeight = \new ->
1671+ FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b ->
1672+ FastWeakBag.traverse_ b $ \s ->
1673+ subscriberRecalculateHeight s new
1674+ }
1675+ liftIO $ do
1676+ writeIORef (_fanInt_subscriptionRef self) subscription
1677+ writeIORef (_fanInt_occRef self) $ fromMaybe IntMap.empty parentOcc
1678+ scheduleIntClear $ _fanInt_occRef self
1679+ liftIO $ do
1680+ b <- FastMutableIntMap.lookup (_fanInt_subscribers self) k >>= \case
1681+ Nothing -> do
1682+ b <- FastWeakBag.empty
1683+ FastMutableIntMap.insert (_fanInt_subscribers self) k b
1684+ return b
1685+ Just b -> return b
1686+ ticket <- liftIO $ FastWeakBag.insert sub b
1687+ currentOcc <- readIORef (_fanInt_occRef self)
1688+
1689+ subscribed <- fanIntSubscribed ticket self
1690+ return (EventSubscription (FastWeakBag.remove ticket) subscribed, IntMap.lookup k currentOcc)
1691+
1692+fanIntSubscribed :: FastWeakBagTicket k -> FanInt x a -> IO (EventSubscribed x)
1693+fanIntSubscribed ticket self = do
1694+ subscribedParent <- _eventSubscription_subscribed <$> readIORef (_fanInt_subscriptionRef self)
1695+ return $ EventSubscribed
1696+ { eventSubscribedHeightRef = eventSubscribedHeightRef subscribedParent
1697+ , eventSubscribedRetained = toAny (_fanInt_subscriptionRef self, ticket)
1698+#ifdef DEBUG_CYCLES
1699+ , eventSubscribedGetParents = return [subscribedParent]
1700+ , eventSubscribedHasOwnHeightRef = False
1701+ , eventSubscribedWhoCreated = whoCreatedIORef $ _fanInt_subscriptionRef self
1702+#endif
1703+ }
8771704
878−getFanSubscribed :: GCompare k => Fan k -> EventM (FanSubscribed k)
879−getFanSubscribed f = do
1705+
1706+{-# INLINABLE getFanSubscribed #-}
1707+getFanSubscribed :: (HasSpiderTimeline x, GCompare k) => k a -> Fan x k v -> Subscriber x (v a) -> EventM x (WeakBagTicket, FanSubscribed x k v, Maybe (v a))
1708+getFanSubscribed k f sub = do
8801709 mSubscribed <- liftIO $ readIORef $ fanSubscribed f
8811710 case mSubscribed of
882− Just subscribed -> return subscribed
883− Nothing -> do
884− subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ liftM fromJust $ readIORef $ fanSubscribed f
885− let !sub = SubscriberFan subscribedUnsafe
886− wsub <- liftIO $ mkWeakPtrWithDebug sub "SubscriberFan"
887− subd <- subscribe (fanParent f) $ WeakSubscriberSimple wsub
888− subscribersRef <- liftIO $ newIORef DMap.empty
1711+ Just subscribed -> {-# SCC "hitFan" #-} liftIO $ do
1712+ sln <- subscribeFanSubscribed k subscribed sub
1713+ occ <- readIORef $ fanSubscribedOccurrence subscribed
1714+ return (sln, subscribed, coerce $ DMap.lookup k =<< occ)
1715+ Nothing -> {-# SCC "missFan" #-} do
1716+ subscribedRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribedRef not yet initialized"
1717+ subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1718+ s <- liftIO $ newSubscriberFan subscribedUnsafe
1719+ (subscription, parentOcc) <- subscribeAndRead (fanParent f) s
1720+ weakSelf <- liftIO $ newIORef $ error "getFanSubscribed: weakSelf not yet initialized"
1721+ (subsForK, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupFanSubscribed
1722+ subscribersRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribersRef not yet initialized"
1723+ occRef <- liftIO $ newIORef parentOcc
1724+ when (isJust parentOcc) $ scheduleClear occRef
1725+#ifdef DEBUG_NODEIDS
1726+ nid <- liftIO newNodeId
1727+#endif
8891728 let subscribed = FanSubscribed
890− { fanSubscribedParent = subd
1729+ { fanSubscribedCachedSubscribed = fanSubscribed f
1730+ , fanSubscribedOccurrence = occRef
1731+ , fanSubscribedParent = subscription
8911732 , fanSubscribedSubscribers = subscribersRef
892− , fanSubscribedSelf = sub
8931733#ifdef DEBUG_NODEIDS
894− , fanSubscribedNodeId = unsafeNodeId f
1734+ , fanSubscribedNodeId = nid
8951735#endif
8961736 }
1737+ let !self = (k, subscribed)
1738+ liftIO $ writeIORef subscribersRef $! DMap.singleton k $ FanSubscribedChildren subsForK self weakSelf
1739+ liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug self "FanSubscribed"
1740+ liftIO $ writeIORef subscribedRef $! subscribed
8971741 liftIO $ writeIORef (fanSubscribed f) $ Just subscribed
898− return subscribed
899−
900−getSwitchSubscribed :: Switch a -> EventM (SwitchSubscribed a)
901−getSwitchSubscribed s = do
1742+ return (slnForSub, subscribed, coerce $ DMap.lookup k =<< parentOcc)
1743+
1744+cleanupFanSubscribed :: GCompare k => (k a, FanSubscribed x k v) -> IO ()
1745+cleanupFanSubscribed (k, subscribed) = do
1746+ subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1747+ let reducedSubscribers = DMap.delete k subscribers
1748+ if DMap.null reducedSubscribers
1749+ then do
1750+ unsubscribe $ fanSubscribedParent subscribed
1751+ -- Not necessary in this case, because this whole FanSubscribed is dead: writeIORef (fanSubscribedSubscribers subscribed) reducedSubscribers
1752+ writeIORef (fanSubscribedCachedSubscribed subscribed) Nothing
1753+ else writeIORef (fanSubscribedSubscribers subscribed) $! reducedSubscribers
1754+
1755+{-# INLINE subscribeFanSubscribed #-}
1756+subscribeFanSubscribed :: GCompare k => k a -> FanSubscribed x k v -> Subscriber x (v a) -> IO WeakBagTicket
1757+subscribeFanSubscribed k subscribed sub = do
1758+ subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1759+ case DMap.lookup k subscribers of
1760+ Nothing -> {-# SCC "missSubscribeFanSubscribed" #-} do
1761+ let !self = (k, subscribed)
1762+ weakSelf <- newIORef =<< mkWeakPtrWithDebug self "FanSubscribed"
1763+ (list, sln) <- WeakBag.singleton sub weakSelf cleanupFanSubscribed
1764+ writeIORef (fanSubscribedSubscribers subscribed) $! DMap.insertWith (error "subscribeFanSubscribed: key that we just failed to find is present - should be impossible") k (FanSubscribedChildren list self weakSelf) subscribers
1765+ return sln
1766+ Just (FanSubscribedChildren list _ weakSelf) -> {-# SCC "hitSubscribeFanSubscribed" #-} WeakBag.insert sub list weakSelf cleanupFanSubscribed
1767+
1768+{-# INLINABLE getSwitchSubscribed #-}
1769+getSwitchSubscribed :: HasSpiderTimeline x => Switch x a -> Subscriber x a -> EventM x (WeakBagTicket, SwitchSubscribed x a, Maybe a)
1770+getSwitchSubscribed s sub = do
9021771 mSubscribed <- liftIO $ readIORef $ switchSubscribed s
9031772 case mSubscribed of
904− Just subscribed -> return subscribed
905− Nothing -> do
1773+ Just subscribed -> {-# SCC "hitSwitch" #-} liftIO $ do
1774+ sln <- subscribeSwitchSubscribed subscribed sub
1775+ occ <- readIORef $ switchSubscribedOccurrence subscribed
1776+ return (sln, subscribed, occ)
1777+ Nothing -> {-# SCC "missSwitch" #-} do
9061778 subscribedRef <- liftIO $ newIORef $ error "getSwitchSubscribed: subscribed has not yet been created"
9071779 subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
908− let !i = InvalidatorSwitch subscribedUnsafe
909− !sub = SubscriberSwitch subscribedUnsafe
1780+ i <- liftIO $ newInvalidatorSwitch subscribedUnsafe
1781+ mySub <- liftIO $ newSubscriberSwitch subscribedUnsafe
9101782 wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorSwitch"
9111783 wiRef <- liftIO $ newIORef wi
912− wsub <- liftIO $ mkWeakPtrWithDebug sub "SubscriberSwitch"
913− selfWeakRef <- liftIO $ newIORef wsub
9141784 parentsRef <- liftIO $ newIORef [] --TODO: This should be unnecessary, because it will always be filled with just the single parent behavior
915− e <- liftIO $ runBehaviorM (readBehaviorTracked (switchParent s)) $ Just (wi, parentsRef)
916− subd <- subscribe e $ WeakSubscriberSimple wsub
917− subdRef <- liftIO $ newIORef subd
918− parentOcc <- liftIO $ getEventSubscribedOcc subd
1785+ holdInits <- getDeferralQueue
1786+ e <- liftIO $ runBehaviorM (readBehaviorTracked (switchParent s)) (Just (wi, parentsRef)) holdInits
1787+ (subscription@(EventSubscription _ subd), parentOcc) <- subscribeAndRead e mySub
1788+ heightRef <- liftIO $ newIORef =<< getEventSubscribedHeight subd
1789+ subscriptionRef <- liftIO $ newIORef subscription
9191790 occRef <- liftIO $ newIORef parentOcc
9201791 when (isJust parentOcc) $ scheduleClear occRef
921− heightRef <- liftIO $ newIORef =<< readIORef (eventSubscribedHeightRef subd)
922− subscribersRef <- liftIO $ newIORef []
923− let subscribed = SwitchSubscribed
924− { switchSubscribedOccurrence = occRef
1792+ weakSelf <- liftIO $ newIORef $ error "getSwitchSubscribed: weakSelf not yet initialized"
1793+ (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupSwitchSubscribed
1794+#ifdef DEBUG_NODEIDS
1795+ nid <- liftIO newNodeId
1796+#endif
1797+ let !subscribed = SwitchSubscribed
1798+ { switchSubscribedCachedSubscribed = switchSubscribed s
1799+ , switchSubscribedOccurrence = occRef
9251800 , switchSubscribedHeight = heightRef
926− , switchSubscribedSubscribers = subscribersRef
927− , switchSubscribedSelf = sub
928− , switchSubscribedSelfWeak = selfWeakRef
1801+ , switchSubscribedSubscribers = subs
9291802 , switchSubscribedOwnInvalidator = i
9301803 , switchSubscribedOwnWeakInvalidator = wiRef
9311804 , switchSubscribedBehaviorParents = parentsRef
9321805 , switchSubscribedParent = switchParent s
933− , switchSubscribedCurrentParent = subdRef
1806+ , switchSubscribedCurrentParent = subscriptionRef
1807+ , switchSubscribedWeakSelf = weakSelf
9341808#ifdef DEBUG_NODEIDS
935− , switchSubscribedNodeId = unsafeNodeId s
1809+ , switchSubscribedNodeId = nid
9361810#endif
9371811 }
938− liftIO $ writeIORef subscribedRef subscribed
1812+ liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "switchSubscribedWeakSelf"
1813+ liftIO $ writeIORef subscribedRef $! subscribed
9391814 liftIO $ writeIORef (switchSubscribed s) $ Just subscribed
940− return subscribed
1815+ return (slnForSub, subscribed, parentOcc)
1816+
1817+cleanupSwitchSubscribed :: SwitchSubscribed x a -> IO ()
1818+cleanupSwitchSubscribed subscribed = do
1819+ unsubscribe =<< readIORef (switchSubscribedCurrentParent subscribed)
1820+ finalize =<< readIORef (switchSubscribedOwnWeakInvalidator subscribed) -- We don't need to get invalidated if we're dead
1821+ writeIORef (switchSubscribedCachedSubscribed subscribed) Nothing
9411822
942−getCoincidenceSubscribed :: forall a. Coincidence a -> EventM (CoincidenceSubscribed a)
943−getCoincidenceSubscribed c = do
1823+{-# INLINE subscribeSwitchSubscribed #-}
1824+subscribeSwitchSubscribed :: SwitchSubscribed x a -> Subscriber x a -> IO WeakBagTicket
1825+subscribeSwitchSubscribed subscribed sub = WeakBag.insert sub (switchSubscribedSubscribers subscribed) (switchSubscribedWeakSelf subscribed) cleanupSwitchSubscribed
1826+
1827+{-# INLINABLE getCoincidenceSubscribed #-}
1828+getCoincidenceSubscribed :: forall x a. HasSpiderTimeline x => Coincidence x a -> Subscriber x a -> EventM x (WeakBagTicket, CoincidenceSubscribed x a, Maybe a)
1829+getCoincidenceSubscribed c sub = do
9441830 mSubscribed <- liftIO $ readIORef $ coincidenceSubscribed c
9451831 case mSubscribed of
946− Just subscribed -> return subscribed
947− Nothing -> do
1832+ Just subscribed -> {-# SCC "hitCoincidence" #-} liftIO $ do
1833+ sln <- subscribeCoincidenceSubscribed subscribed sub
1834+ occ <- readIORef $ coincidenceSubscribedOccurrence subscribed
1835+ return (sln, subscribed, occ)
1836+ Nothing -> {-# SCC "missCoincidence" #-} do
9481837 subscribedRef <- liftIO $ newIORef $ error "getCoincidenceSubscribed: subscribed has not yet been created"
9491838 subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
950− let !subOuter = SubscriberCoincidenceOuter subscribedUnsafe
951− wsubOuter <- liftIO $ mkWeakPtrWithDebug subOuter "subOuter"
952− outerSubd <- subscribe (coincidenceParent c) $ WeakSubscriberSimple wsubOuter
953− outerOcc <- liftIO $ getEventSubscribedOcc outerSubd
954− outerHeight <- liftIO $ readIORef $ eventSubscribedHeightRef outerSubd
1839+ subOuter <- liftIO $ newSubscriberCoincidenceOuter subscribedUnsafe
1840+ (outerSubscription@(EventSubscription _ outerSubd), outerOcc) <- subscribeAndRead (coincidenceParent c) subOuter
1841+ outerHeight <- liftIO $ getEventSubscribedHeight outerSubd
9551842 (occ, height, mInnerSubd) <- case outerOcc of
9561843 Nothing -> return (Nothing, outerHeight, Nothing)
9571844 Just o -> do
@@ -962,267 +1849,647 @@ getCoincidenceSubscribed c = do
9621849 heightRef <- liftIO $ newIORef height
9631850 innerSubdRef <- liftIO $ newIORef mInnerSubd
9641851 scheduleClear innerSubdRef
965− subscribersRef <- liftIO $ newIORef []
1852+ weakSelf <- liftIO $ newIORef $ error "getCoincidenceSubscribed: weakSelf not yet implemented"
1853+ (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupCoincidenceSubscribed
1854+#ifdef DEBUG_NODEIDS
1855+ nid <- liftIO newNodeId
1856+#endif
9661857 let subscribed = CoincidenceSubscribed
967− { coincidenceSubscribedOccurrence = occRef
1858+ { coincidenceSubscribedCachedSubscribed = coincidenceSubscribed c
1859+ , coincidenceSubscribedOccurrence = occRef
9681860 , coincidenceSubscribedHeight = heightRef
969− , coincidenceSubscribedSubscribers = subscribersRef
1861+ , coincidenceSubscribedSubscribers = subs
9701862 , coincidenceSubscribedOuter = subOuter
971− , coincidenceSubscribedOuterParent = outerSubd
1863+ , coincidenceSubscribedOuterParent = outerSubscription
9721864 , coincidenceSubscribedInnerParent = innerSubdRef
1865+ , coincidenceSubscribedWeakSelf = weakSelf
9731866#ifdef DEBUG_NODEIDS
974− , coincidenceSubscribedNodeId = unsafeNodeId c
1867+ , coincidenceSubscribedNodeId = nid
9751868#endif
9761869 }
977− liftIO $ writeIORef subscribedRef subscribed
1870+ liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "CoincidenceSubscribed"
1871+ liftIO $ writeIORef subscribedRef $! subscribed
9781872 liftIO $ writeIORef (coincidenceSubscribed c) $ Just subscribed
979− return subscribed
1873+ return (slnForSub, subscribed, occ)
1874+
1875+cleanupCoincidenceSubscribed :: CoincidenceSubscribed x a -> IO ()
1876+cleanupCoincidenceSubscribed subscribed = do
1877+ unsubscribe $ coincidenceSubscribedOuterParent subscribed
1878+ writeIORef (coincidenceSubscribedCachedSubscribed subscribed) Nothing
1879+
1880+{-# INLINE subscribeCoincidenceSubscribed #-}
1881+subscribeCoincidenceSubscribed :: CoincidenceSubscribed x a -> Subscriber x a -> IO WeakBagTicket
1882+subscribeCoincidenceSubscribed subscribed sub = WeakBag.insert sub (coincidenceSubscribedSubscribers subscribed) (coincidenceSubscribedWeakSelf subscribed) cleanupCoincidenceSubscribed
1883+
1884+{-# INLINE mergeG #-}
1885+mergeG :: forall k q x v. (HasSpiderTimeline x, GCompare k)
1886+ => (forall a. q a -> Event x (v a))
1887+ -> DynamicS x (PatchDMap k q) -> Event x (DMap k v)
1888+mergeG nt d = cacheEvent (mergeCheap nt d)
1889+
1890+{-# INLINE mergeWithMove #-}
1891+mergeWithMove :: forall k v q x. (HasSpiderTimeline x, GCompare k)
1892+ => (forall a. q a -> Event x (v a))
1893+ -> DynamicS x (PatchDMapWithMove k q) -> Event x (DMap k v)
1894+mergeWithMove nt d = cacheEvent (mergeCheapWithMove nt d)
1895+
1896+{-# INLINE [1] mergeCheap #-}
1897+mergeCheap
1898+ :: forall k x q v. (HasSpiderTimeline x, GCompare k)
1899+ => (forall a. q a -> Event x (v a))
1900+ -> DynamicS x (PatchDMap k q)
1901+ -> Event x (DMap k v)
1902+mergeCheap nt = mergeGCheap' unMergeSubscribedParent getInitialSubscribers updateMe destroy
1903+ where
1904+ updateMe :: MergeUpdateFunc k v x (PatchDMap k q) (MergeSubscribedParent x)
1905+ updateMe subscriber heightBagRef oldParents (PatchDMap p) = do
1906+ let f (subscriptionsToKill, ps) (k :=> ComposeMaybe me) = do
1907+ (mOldSubd, newPs) <- case me of
1908+ Nothing -> return $ DMap.updateLookupWithKey (\_ _ -> Nothing) k ps
1909+ Just e -> do
1910+ let s = subscriber $ return k
1911+ subscription@(EventSubscription _ subd) <- subscribe (nt e) s
1912+ newParentHeight <- liftIO $ getEventSubscribedHeight subd
1913+ let newParent = MergeSubscribedParent subscription
1914+ liftIO $ modifyIORef' heightBagRef $ heightBagAdd newParentHeight
1915+ return $ DMap.insertLookupWithKey' (\_ new _ -> new) k newParent ps
1916+ forM_ mOldSubd $ \oldSubd -> do
1917+ oldHeight <- liftIO $ getEventSubscribedHeight $
1918+ _eventSubscription_subscribed $ unMergeSubscribedParent oldSubd
1919+
1920+ liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
1921+ return (maybeToList (unMergeSubscribedParent <$> mOldSubd) ++ subscriptionsToKill, newPs)
1922+ foldM f ([], oldParents) $ DMap.toList p
1923+
1924+ getInitialSubscribers :: MergeInitFunc k v q x (MergeSubscribedParent x)
1925+ getInitialSubscribers initialParents subscriber = do
1926+ subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
1927+ let s = subscriber $ return k
1928+ (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead (nt e) s
1929+ height <- liftIO $ getEventSubscribedHeight parentSubd
1930+ return (fmap (k :=>) parentOcc, height, k :=> MergeSubscribedParent subscription)
1931+ return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
1932+ , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
1933+ , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
1934+ )
1935+
1936+ destroy :: MergeDestroyFunc k (MergeSubscribedParent x)
1937+ destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParent sub) -> unsubscribe sub
1938+
1939+{-# INLINE [1] mergeCheapWithMove #-}
1940+mergeCheapWithMove :: forall k x v q. (HasSpiderTimeline x, GCompare k)
1941+ => (forall a. q a -> Event x (v a))
1942+ -> DynamicS x (PatchDMapWithMove k q)
1943+ -> Event x (DMap k v)
1944+mergeCheapWithMove nt = mergeGCheap' _mergeSubscribedParentWithMove_subscription getInitialSubscribers updateMe destroy
1945+ where
1946+ updateMe :: MergeUpdateFunc k v x (PatchDMapWithMove k q) (MergeSubscribedParentWithMove x k)
1947+ updateMe subscriber heightBagRef oldParents p = do
1948+ -- Prepare new parents for insertion
1949+ let subscribeParent :: forall a. k a -> Event x (v a) -> EventM x (MergeSubscribedParentWithMove x k a)
1950+ subscribeParent k e = do
1951+ keyRef <- liftIO $ newIORef k
1952+ let s = subscriber $ liftIO $ readIORef keyRef
1953+ subscription@(EventSubscription _ subd) <- subscribe e s
1954+ liftIO $ do
1955+ newParentHeight <- getEventSubscribedHeight subd
1956+ modifyIORef' heightBagRef $ heightBagAdd newParentHeight
1957+ return $ MergeSubscribedParentWithMove subscription keyRef
1958+ p' <- PatchDMapWithMove.traversePatchDMapWithMoveWithKey (\k q -> subscribeParent k (nt q)) p
1959+ -- Collect old parents for deletion and update the keys of moved parents
1960+ let moveOrDelete :: forall a. k a -> PatchDMapWithMove.NodeInfo k q a -> MergeSubscribedParentWithMove x k a -> Constant (EventM x (Maybe (EventSubscription x))) a
1961+ moveOrDelete _ ni parent = Constant $ case getComposeMaybe $ PatchDMapWithMove._nodeInfo_to ni of
1962+ Nothing -> do
1963+ oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $
1964+ _mergeSubscribedParentWithMove_subscription parent
1965+
1966+ liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
1967+ return $ Just $ _mergeSubscribedParentWithMove_subscription parent
1968+ Just toKey -> do
1969+ liftIO $ writeIORef (_mergeSubscribedParentWithMove_key parent) $! toKey
1970+ return Nothing
1971+ toDelete <- fmap catMaybes $ mapM (\(_ :=> v) -> getConstant v) $ DMap.toList $
1972+ DMap.intersectionWithKey moveOrDelete (unPatchDMapWithMove p) oldParents
1973+
1974+ return (toDelete, applyAlways p' oldParents)
1975+ getInitialSubscribers :: MergeInitFunc k v q x (MergeSubscribedParentWithMove x k)
1976+ getInitialSubscribers initialParents subscriber = do
1977+ subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
1978+ keyRef <- liftIO $ newIORef k
1979+ let s = subscriber $ liftIO $ readIORef keyRef
1980+ (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead (nt e) s
1981+ height <- liftIO $ getEventSubscribedHeight parentSubd
1982+ return (fmap (k :=>) parentOcc, height, k :=> MergeSubscribedParentWithMove subscription keyRef)
1983+ return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
1984+ , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
1985+ , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
1986+ )
1987+
1988+ destroy :: MergeDestroyFunc k (MergeSubscribedParentWithMove x k)
1989+ destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParentWithMove sub _) -> unsubscribe sub
1990+
1991+type MergeUpdateFunc k v x p s
1992+ = (forall a. EventM x (k a) -> Subscriber x (v a))
1993+ -> IORef HeightBag
1994+ -> DMap k s
1995+ -> p
1996+ -> EventM x ([EventSubscription x], DMap k s)
1997+
1998+type MergeGetSubscription x s = forall a. s a -> EventSubscription x
1999+
2000+type MergeInitFunc k v q x s
2001+ = DMap k q
2002+ -> (forall a. EventM x (k a) -> Subscriber x (v a))
2003+ -> EventM x (DMap k v, [Height], DMap k s)
2004+
2005+type MergeDestroyFunc k s
2006+ = DMap k s
2007+ -> IO ()
2008+
2009+data Merge x k v s = Merge
2010+ { _merge_parentsRef :: {-# UNPACK #-} !(IORef (DMap k s))
2011+ , _merge_heightBagRef :: {-# UNPACK #-} !(IORef HeightBag)
2012+ , _merge_heightRef :: {-# UNPACK #-} !(IORef Height)
2013+ , _merge_sub :: {-# UNPACK #-} !(Subscriber x (DMap k v))
2014+ , _merge_accumRef :: {-# UNPACK #-} !(IORef (DMap k v))
2015+ }
2016+
2017+invalidateMergeHeight :: Merge x k v s -> IO ()
2018+invalidateMergeHeight m = invalidateMergeHeight' (_merge_heightRef m) (_merge_sub m)
2019+
2020+invalidateMergeHeight' :: IORef Height -> Subscriber x a -> IO ()
2021+invalidateMergeHeight' heightRef sub = do
2022+ oldHeight <- readIORef heightRef
2023+ -- If the height used to be valid, it must be invalid now; we should never have *more* heights than we have parents
2024+ when (oldHeight /= invalidHeight) $ do
2025+ writeIORef heightRef $! invalidHeight
2026+ subscriberInvalidateHeight sub oldHeight
2027+
2028+revalidateMergeHeight :: Merge x k v s -> IO ()
2029+revalidateMergeHeight m = do
2030+ currentHeight <- readIORef $ _merge_heightRef m
2031+
2032+ -- revalidateMergeHeight may be called multiple times; perhaps the's a way to finesse it to avoid this check
2033+ when (currentHeight == invalidHeight) $ do
2034+ heights <- readIORef $ _merge_heightBagRef m
2035+ parents <- readIORef $ _merge_parentsRef m
2036+ -- When the number of heights in the bag reaches the number of parents, we should have a valid height
2037+ case heightBagSize heights `compare` DMap.size parents of
2038+ LT -> return ()
2039+ EQ -> do
2040+ let height = succHeight $ heightBagMax heights
2041+ traceInvalidateHeight $ "recalculateSubscriberHeight: height: " <> show height
2042+ writeIORef (_merge_heightRef m) $! height
2043+ subscriberRecalculateHeight (_merge_sub m) height
2044+ GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show (DMap.size parents) <> ") for Merge"
2045+
2046+scheduleMergeSelf :: HasSpiderTimeline x => Merge x k v s -> Height -> EventM x ()
2047+scheduleMergeSelf m height = scheduleMerge' height (_merge_heightRef m) $ do
2048+ vals <- liftIO $ readIORef $ _merge_accumRef m
2049+ -- Once we're done with this, we can clear it immediately, because if there's a cacheEvent in front of us,
2050+ -- it'll handle subsequent subscribers, and if not, we won't get subsequent subscribers
2051+ liftIO $ writeIORef (_merge_accumRef m) $! DMap.empty
2052+ --TODO: Assert that m is not empty
2053+ subscriberPropagate (_merge_sub m) vals
2054+
2055+checkCycle :: HasSpiderTimeline x => EventSubscribed x -> EventM x ()
2056+checkCycle subscribed = liftIO $ do
2057+ height <- readIORef (eventSubscribedHeightRef subscribed)
2058+
2059+ -- currentHeight <- getCurrentHeight
2060+ -- when (height <= currentHeight) $ if height /= invalidHeight
2061+ -- then do
2062+ -- myStack <- liftIO $ whoCreatedIORef undefined --TODO
2063+ -- error $ "Height (" ++ show height ++ ") is not greater than current height (" ++ show currentHeight ++ ")\n" ++ unlines (reverse myStack)
2064+ -- else liftIO $
2065+ when (height == invalidHeight) $
2066+#ifdef DEBUG_CYCLES
2067+ do
2068+ nodesInvolvedInCycle <- walkInvalidHeightParents subscribed
2069+ stacks <- forM nodesInvolvedInCycle whoCreatedEventSubscribed
2070+ throwIO (EventLoopException stacks)
2071+#else
2072+ throwIO EventLoopException
2073+#endif
2074+
9802075
981−merge :: GCompare k => DMap (WrapArg Event k) -> Event (DMap k)
982−merge m = EventMerge $ Merge
983− { mergeParents = m
984− , mergeSubscribed = unsafeNewIORef m Nothing
2076+mergeSubscriber :: forall x k v s a. (HasSpiderTimeline x, GCompare k) => EventSubscribed x -> Merge x k v s -> EventM x (k a) -> Subscriber x (v a)
2077+mergeSubscriber subscribed m getKey = Subscriber
2078+ { subscriberPropagate = \a -> do
2079+ oldM <- liftIO $ readIORef $ _merge_accumRef m
2080+ k <- getKey
2081+ let newM = DMap.insertWith (error "Same key fired multiple times for Merge") k a oldM
2082+ tracePropagate (Proxy :: Proxy x) $ " DMap.size oldM = " <> show (DMap.size oldM) <> "; DMap.size newM = " <> show (DMap.size newM)
2083+ liftIO $ writeIORef (_merge_accumRef m) $! newM
2084+ when (DMap.null oldM) $ do -- Only schedule the firing once
2085+ height <- liftIO $ readIORef $ _merge_heightRef m
2086+ checkCycle subscribed
2087+
2088+ scheduleMergeSelf m height
2089+ , subscriberInvalidateHeight = \old -> do --TODO: When removing a parent doesn't actually change the height, maybe we can avoid invalidating
2090+ modifyIORef' (_merge_heightBagRef m) $ heightBagRemove old
2091+ invalidateMergeHeight m
2092+ , subscriberRecalculateHeight = \new -> do
2093+ modifyIORef' (_merge_heightBagRef m) $ heightBagAdd new
2094+ revalidateMergeHeight m
9852095 }
9862096
987−newtype EventSelector k = EventSelector { select :: forall a. k a -> Event a }
2097+--TODO: Be able to run as much of this as possible promptly
2098+updateMerge :: (HasSpiderTimeline x, GCompare k) => EventSubscribed x -> Merge x k v s -> MergeUpdateFunc k v x p s -> p -> SomeMergeUpdate x
2099+updateMerge subscribed m updateFunc p = SomeMergeUpdate updateMe (invalidateMergeHeight m) (revalidateMergeHeight m)
2100+ where updateMe = do
2101+ oldParents <- liftIO $ readIORef $ _merge_parentsRef m
2102+ (subscriptionsToKill, newParents) <- updateFunc (mergeSubscriber subscribed m) (_merge_heightBagRef m) oldParents p
2103+ liftIO $ writeIORef (_merge_parentsRef m) $! newParents
2104+ return subscriptionsToKill
2105+
2106+{-# INLINE mergeGCheap' #-}
2107+mergeGCheap' :: forall k v x p s q. (HasSpiderTimeline x, GCompare k, PatchTarget p ~ DMap k q)
2108+ => MergeGetSubscription x s -> MergeInitFunc k v q x s -> MergeUpdateFunc k v x p s -> MergeDestroyFunc k s -> DynamicS x p -> Event x (DMap k v)
2109+mergeGCheap' getParent getInitialSubscribers updateFunc destroy d = Event $ \sub -> do
2110+ initialParents <- readBehaviorUntracked $ dynamicCurrent d
2111+ accumRef <- liftIO $ newIORef $ error "merge: accumRef not yet initialized"
2112+ heightRef <- liftIO $ newIORef $ error "merge: heightRef not yet initialized"
2113+ heightBagRef <- liftIO $ newIORef $ error "merge: heightBagRef not yet initialized"
2114+ parentsRef :: IORef (DMap k s) <- liftIO $ newIORef $ error "merge: parentsRef not yet initialized"
2115+ changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
2116+
2117+ let subscribed = EventSubscribed
2118+ { eventSubscribedHeightRef = heightRef
2119+ , eventSubscribedRetained = toAny (parentsRef, changeSubdRef)
2120+#ifdef DEBUG_CYCLES
2121+ , eventSubscribedGetParents = do
2122+ let getParent' (_ :=> v) = _eventSubscription_subscribed (getParent v)
2123+ fmap getParent' . DMap.toList <$> readIORef parentsRef
2124+ , eventSubscribedHasOwnHeightRef = False
2125+ , eventSubscribedWhoCreated = whoCreatedIORef heightRef
2126+#endif
2127+ }
2128+
2129+ m = Merge
2130+ { _merge_parentsRef = parentsRef
2131+ , _merge_heightBagRef = heightBagRef
2132+ , _merge_heightRef = heightRef
2133+ , _merge_sub = sub
2134+ , _merge_accumRef = accumRef
2135+ }
2136+ (dm, heights, initialParentState) <- getInitialSubscribers initialParents $ mergeSubscriber subscribed m
2137+ let myHeightBag = heightBagFromList $ filter (/= invalidHeight) heights
2138+ myHeight = if invalidHeight `elem` heights
2139+ then invalidHeight
2140+ else succHeight $ heightBagMax myHeightBag
2141+ currentHeight <- getCurrentHeight
2142+ let (occ, accum) = if currentHeight >= myHeight -- If we should have fired by now
2143+ then (if DMap.null dm then Nothing else Just dm, DMap.empty)
2144+ else (Nothing, dm)
2145+ unless (DMap.null accum) $ scheduleMergeSelf m myHeight
2146+ liftIO $ writeIORef accumRef $! accum
2147+ liftIO $ writeIORef heightRef $! myHeight
2148+ liftIO $ writeIORef heightBagRef $! myHeightBag
2149+ liftIO $ writeIORef parentsRef $! initialParentState
2150+ defer $ SomeMergeInit $ do
2151+ let changeSubscriber = Subscriber
2152+ { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
2153+ tracePropagate (Proxy :: Proxy x) "SubscriberMerge/Change"
2154+ defer $ updateMerge subscribed m updateFunc a
2155+ , subscriberInvalidateHeight = \_ -> return ()
2156+ , subscriberRecalculateHeight = \_ -> return ()
2157+ }
2158+ (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) changeSubscriber
2159+ forM_ change $ \c -> defer $ updateMerge subscribed m updateFunc c
2160+ -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
2161+ -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
2162+ -- its subscription.
2163+ liftIO $ writeIORef changeSubdRef (changeSubscriber, changeSubscription)
2164+ let unsubscribeAll = destroy =<< readIORef parentsRef
2165+
2166+ return (EventSubscription unsubscribeAll subscribed, occ)
2167+
2168+
2169+mergeInt :: forall x a. (HasSpiderTimeline x) => DynamicS x (PatchIntMap (Event x a)) -> Event x (IntMap a)
2170+mergeInt = cacheEvent . mergeIntCheap
2171+
2172+{-# INLINABLE mergeIntCheap #-}
2173+mergeIntCheap :: forall x a. (HasSpiderTimeline x) => DynamicS x (PatchIntMap (Event x a)) -> Event x (IntMap a)
2174+mergeIntCheap d = Event $ \sub -> do
2175+ initialParents <- readBehaviorUntracked $ dynamicCurrent d
2176+ accum <- liftIO $ FastMutableIntMap.newEmpty
2177+ heightRef <- liftIO $ newIORef zeroHeight
2178+ heightBagRef <- liftIO $ newIORef heightBagEmpty
2179+ parents <- liftIO $ FastMutableIntMap.newEmpty
2180+ changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
2181+ let subscribed = EventSubscribed
2182+ { eventSubscribedHeightRef = heightRef
2183+ , eventSubscribedRetained = toAny (parents, changeSubdRef)
2184+#ifdef DEBUG_CYCLES
2185+ , eventSubscribedGetParents = fmap (_eventSubscription_subscribed . snd) <$> FastMutableIntMap.toList parents
2186+ , eventSubscribedHasOwnHeightRef = False
2187+ , eventSubscribedWhoCreated = whoCreatedIORef heightRef
2188+#endif
2189+ }
2190+ let scheduleSelf = do
2191+ height <- liftIO $ readIORef $ heightRef
2192+ scheduleMerge' height heightRef $ do
2193+ vals <- liftIO $ FastMutableIntMap.getFrozenAndClear accum
2194+ subscriberPropagate sub vals
2195+ invalidateMyHeight = invalidateMergeHeight' heightRef sub
2196+ recalculateMyHeight = do
2197+ currentHeight <- readIORef heightRef
2198+ when (currentHeight == invalidHeight) $ do --TODO: This will almost always be true; can we get rid of this check and just proceed to the next one always?
2199+ heights <- readIORef heightBagRef
2200+ numParents <- FastMutableIntMap.size parents
2201+ case heightBagSize heights `compare` numParents of
2202+ LT -> return ()
2203+ EQ -> do
2204+ let height = succHeight $ heightBagMax heights
2205+ traceInvalidateHeight $ "recalculateSubscriberHeight: height: " <> show height
2206+ writeIORef heightRef $! height
2207+ subscriberRecalculateHeight sub height
2208+ GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show numParents <> ") for Merge"
2209+ mySubscriber k = Subscriber
2210+ { subscriberPropagate = \a -> do
2211+ checkCycle subscribed
2212+
2213+ wasEmpty <- liftIO $ FastMutableIntMap.isEmpty accum
2214+ liftIO $ FastMutableIntMap.insert accum k a
2215+ when wasEmpty scheduleSelf
2216+ , subscriberInvalidateHeight = \old -> do
2217+ modifyIORef' heightBagRef $ heightBagRemove old
2218+ invalidateMyHeight
2219+ , subscriberRecalculateHeight = \new -> do
2220+ modifyIORef' heightBagRef $ heightBagAdd new
2221+ recalculateMyHeight
2222+ }
2223+ forM_ (IntMap.toList initialParents) $ \(k, p) -> do
2224+ (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead p $ mySubscriber k
2225+ liftIO $ do
2226+ forM_ parentOcc $ FastMutableIntMap.insert accum k
2227+ FastMutableIntMap.insert parents k subscription
2228+ height <- getEventSubscribedHeight parentSubd
2229+ if height == invalidHeight
2230+ then writeIORef heightRef invalidHeight
2231+ else do
2232+ modifyIORef' heightBagRef $ heightBagAdd height
2233+ modifyIORef' heightRef $ \oldHeight ->
2234+ if oldHeight == invalidHeight
2235+ then invalidHeight
2236+ else max (succHeight height) oldHeight
2237+ myHeight <- liftIO $ readIORef heightRef
2238+ currentHeight <- getCurrentHeight
2239+ isEmpty <- liftIO $ FastMutableIntMap.isEmpty accum
2240+ occ <- if currentHeight >= myHeight -- If we should have fired by now
2241+ then if isEmpty
2242+ then return Nothing
2243+ else liftIO $ Just <$> FastMutableIntMap.getFrozenAndClear accum
2244+ else do when (not isEmpty) scheduleSelf -- We have things accumulated, but we shouldn't have fired them yet
2245+ return Nothing
2246+ defer $ SomeMergeInit $ do
2247+ let updateMe a = SomeMergeUpdate u invalidateMyHeight recalculateMyHeight
2248+ where
2249+ u = do
2250+ let f k newParent = do
2251+ subscription@(EventSubscription _ subd) <- subscribe newParent $ mySubscriber k
2252+ newParentHeight <- liftIO $ getEventSubscribedHeight subd
2253+ liftIO $ modifyIORef' heightBagRef $ heightBagAdd newParentHeight
2254+ return subscription
2255+ newSubscriptions <- FastMutableIntMap.traverseIntMapPatchWithKey f a
2256+ oldParents <- liftIO $ FastMutableIntMap.applyPatch parents newSubscriptions
2257+ liftIO $ for_ oldParents $ \oldParent -> do
2258+ oldParentHeight <- getEventSubscribedHeight $ _eventSubscription_subscribed oldParent
2259+
2260+ print ("updateMe", oldParentHeight)
2261+ modifyIORef' heightBagRef $ heightBagRemove oldParentHeight
2262+ return $ IntMap.elems oldParents
2263+ let changeSubscriber = Subscriber
2264+ { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
2265+ tracePropagate (Proxy :: Proxy x) $ "SubscriberMergeInt/Change"
2266+ defer $ updateMe a
2267+ , subscriberInvalidateHeight = \_ -> return ()
2268+ , subscriberRecalculateHeight = \_ -> return ()
2269+ }
2270+ (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) changeSubscriber
2271+ forM_ change $ \c -> defer $ updateMe c
2272+ -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
2273+ -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
2274+ -- its subscription.
2275+ liftIO $ writeIORef changeSubdRef (changeSubscriber, changeSubscription)
2276+ let unsubscribeAll = traverse_ unsubscribe =<< FastMutableIntMap.getFrozenAndClear parents
2277+
2278+
2279+ return (EventSubscription unsubscribeAll subscribed, occ)
9882280
989−fan :: GCompare k => Event (DMap k) -> EventSelector k
990−fan e =
2281+newtype EventSelector x k = EventSelector { select :: forall a. k a -> Event x a }
2282+newtype EventSelectorG x k v = EventSelectorG { selectG :: forall a. k a -> Event x (v a) }
2283+
2284+fanG :: (HasSpiderTimeline x, GCompare k) => Event x (DMap k v) -> EventSelectorG x k v
2285+fanG e = unsafePerformIO $ do
2286+ ref <- newIORef Nothing
9912287 let f = Fan
9922288 { fanParent = e
993− , fanSubscribed = unsafeNewIORef e Nothing
2289+ , fanSubscribed = ref
9942290 }
995− in EventSelector $ \k -> EventFan k f
996−
997−-- | Run an event action outside of a frame
998−runFrame :: EventM a -> IO a
999−runFrame a = do
2291+ pure $ EventSelectorG $ \k -> eventFan k f
2292+
2293+runHoldInits :: HasSpiderTimeline x => IORef [SomeHoldInit x] -> IORef [SomeDynInit x] -> IORef [SomeMergeInit x] -> EventM x ()
2294+runHoldInits holdInitRef dynInitRef mergeInitRef = do
2295+ holdInits <- liftIO $ readIORef holdInitRef
2296+ dynInits <- liftIO $ readIORef dynInitRef
2297+ mergeInits <- liftIO $ readIORef mergeInitRef
2298+ unless (null holdInits && null dynInits && null mergeInits) $ do
2299+ liftIO $ writeIORef holdInitRef []
2300+ liftIO $ writeIORef dynInitRef []
2301+ liftIO $ writeIORef mergeInitRef []
2302+ mapM_ initHold holdInits
2303+ mapM_ initDyn dynInits
2304+ mapM_ unSomeMergeInit mergeInits
2305+ runHoldInits holdInitRef dynInitRef mergeInitRef
2306+
2307+initHold :: HasSpiderTimeline x => SomeHoldInit x -> EventM x ()
2308+initHold (SomeHoldInit h) = void $ getHoldEventSubscription h
2309+
2310+initDyn :: HasSpiderTimeline x => SomeDynInit x -> EventM x ()
2311+initDyn (SomeDynInit d) = void $ getDynHold d
2312+
2313+newEventEnv :: IO (EventEnv x)
2314+newEventEnv = do
10002315 toAssignRef <- newIORef [] -- This should only actually get used when events are firing
10012316 holdInitRef <- newIORef []
1002− heightRef <- newIORef 0
2317+ dynInitRef <- newIORef []
2318+ mergeUpdateRef <- newIORef []
2319+ mergeInitRef <- newIORef []
2320+ heightRef <- newIORef zeroHeight
10032321 toClearRef <- newIORef []
2322+ toClearIntRef <- newIORef []
2323+ toClearRootRef <- newIORef []
10042324 coincidenceInfosRef <- newIORef []
1005− delayedRef <- liftIO $ newIORef IntMap.empty
1006− result <- flip runEventM (EventEnv toAssignRef holdInitRef toClearRef heightRef coincidenceInfosRef delayedRef) $ do
1007− result <- a
1008− let runHoldInits = do
1009− holdInits <- liftIO $ readIORef holdInitRef
1010− if null holdInits then return () else do
1011− liftIO $ writeIORef holdInitRef []
1012− forM_ holdInits $ \(SomeHoldInit e h) -> subscribeHold e h
1013− runHoldInits
1014− runHoldInits -- This must happen before doing the assignments, in case subscribing a Hold causes existing Holds to be read by the newly-propagated events
1015− return result
1016− toClear <- readIORef toClearRef
1017− forM_ toClear $ \(SomeMaybeIORef ref) -> writeIORef ref Nothing
1018− toAssign <- readIORef toAssignRef
2325+ delayedRef <- newIORef IntMap.empty
2326+ return $ EventEnv toAssignRef holdInitRef dynInitRef mergeUpdateRef mergeInitRef toClearRef toClearIntRef toClearRootRef heightRef coincidenceInfosRef delayedRef
2327+
2328+clearEventEnv :: EventEnv x -> IO ()
2329+clearEventEnv (EventEnv toAssignRef holdInitRef dynInitRef mergeUpdateRef mergeInitRef toClearRef toClearIntRef toClearRootRef heightRef coincidenceInfosRef delayedRef) = do
2330+ writeIORef toAssignRef []
2331+ writeIORef holdInitRef []
2332+ writeIORef dynInitRef []
2333+ writeIORef mergeUpdateRef []
2334+ writeIORef mergeInitRef []
2335+ writeIORef heightRef zeroHeight
2336+ writeIORef toClearRef []
2337+ writeIORef toClearIntRef []
2338+ writeIORef toClearRootRef []
2339+ writeIORef coincidenceInfosRef []
2340+ writeIORef delayedRef IntMap.empty
2341+
2342+-- | Run an event action outside of a frame
2343+runFrame :: forall x a. HasSpiderTimeline x => EventM x a -> SpiderHost x a --TODO: This function also needs to hold the mutex
2344+runFrame a = SpiderHost $ do
2345+ let env = _spiderTimeline_eventEnv $ unSTE (spiderTimeline :: SpiderTimelineEnv x)
2346+ let go = do
2347+ result <- a
2348+ runHoldInits (eventEnvHoldInits env) (eventEnvDynInits env) (eventEnvMergeInits env) -- This must happen before doing the assignments, in case subscribing a Hold causes existing Holds to be read by the newly-propagated events
2349+ return result
2350+ result <- runEventM go
2351+ toClear <- readIORef $ eventEnvClears env
2352+ forM_ toClear $ \(Some (Clear ref)) -> {-# SCC "clear" #-} writeIORef ref Nothing
2353+ toClearInt <- readIORef $ eventEnvIntClears env
2354+ forM_ toClearInt $ \(Some (IntClear ref)) -> {-# SCC "intClear" #-} writeIORef ref $! IntMap.empty
2355+ toClearRoot <- readIORef $ eventEnvRootClears env
2356+ forM_ toClearRoot $ \(Some (RootClear ref)) -> {-# SCC "rootClear" #-} writeIORef ref $! DMap.empty
2357+ toAssign <- readIORef $ eventEnvAssignments env
10192358 toReconnectRef <- newIORef []
1020− forM_ toAssign $ \(SomeAssignment h v) -> do
1021− writeIORef (holdValue h) v
1022− writeIORef (holdInvalidators h) =<< invalidate toReconnectRef =<< readIORef (holdInvalidators h)
1023− coincidenceInfos <- readIORef coincidenceInfosRef
1024− forM_ coincidenceInfos $ \(SomeCoincidenceInfo wsubInner subInner mcs) -> do
1025− touch subInner
1026− finalize wsubInner
1027− mapM_ invalidateCoincidenceHeight mcs
2359+ coincidenceInfos <- readIORef $ eventEnvResetCoincidences env
2360+ forM_ toAssign $ \(SomeAssignment vRef iRef v) -> {-# SCC "assignment" #-} do
2361+ writeIORef vRef v
2362+ traceInvalidate $ "Invalidating Hold"
2363+ writeIORef iRef =<< evaluate =<< invalidate toReconnectRef =<< readIORef iRef
2364+ mergeUpdates <- readIORef $ eventEnvMergeUpdates env
2365+ writeIORef (eventEnvMergeUpdates env) []
2366+ tracePropagate (Proxy::Proxy x) $ "Updating merges"
2367+ mergeSubscriptionsToKill <- runEventM $ concat <$> mapM _someMergeUpdate_update mergeUpdates
2368+ tracePropagate (Proxy::Proxy x) $ "Updating merges done"
10282369 toReconnect <- readIORef toReconnectRef
1029− forM_ toReconnect $ \(SomeSwitchSubscribed subscribed) -> do
1030− wsub <- readIORef $ switchSubscribedSelfWeak subscribed
1031− finalize wsub
2370+ clearEventEnv env
2371+ switchSubscriptionsToKill <- forM toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
2372+ oldSubscription <- readIORef $ switchSubscribedCurrentParent subscribed
10322373 wi <- readIORef $ switchSubscribedOwnWeakInvalidator subscribed
2374+ traceInvalidate $ "Finalizing invalidator for Switch" <> showNodeId subscribed
10332375 finalize wi
1034− let !i = switchSubscribedOwnInvalidator subscribed
2376+ i <- evaluate $ switchSubscribedOwnInvalidator subscribed
10352377 wi' <- mkWeakPtrWithDebug i "wi'"
2378+ writeIORef (switchSubscribedOwnWeakInvalidator subscribed) $! wi'
10362379 writeIORef (switchSubscribedBehaviorParents subscribed) []
1037− e <- runBehaviorM (readBehaviorTracked (switchSubscribedParent subscribed)) (Just (wi', switchSubscribedBehaviorParents subscribed))
2380+ writeIORef (eventEnvHoldInits env) [] --TODO: Should we reuse this?
2381+ e <- runBehaviorM (readBehaviorTracked (switchSubscribedParent subscribed)) (Just (wi', switchSubscribedBehaviorParents subscribed)) $ eventEnvHoldInits env
2382+ runEventM $ runHoldInits (eventEnvHoldInits env) (eventEnvDynInits env) (eventEnvMergeInits env) --TODO: Is this actually OK? It seems like it should be, since we know that no events are firing at this point, but it still seems inelegant
10382383 --TODO: Make sure we touch the pieces of the SwitchSubscribed at the appropriate times
1039− let !sub = switchSubscribedSelf subscribed -- Must be done strictly, or the weak pointer will refer to a useless thunk
1040− wsub' <- mkWeakPtrWithDebug sub "wsub'"
1041− writeIORef (switchSubscribedSelfWeak subscribed) wsub'
1042− subd' <- runFrame $ subscribe e $ WeakSubscriberSimple wsub' --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
2384+ sub <- newSubscriberSwitch subscribed
2385+ 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
10432386 {-
1044− stackTrace <- liftIO $ liftM renderStack $ ccsToStrings =<< (getCCSOf $! switchSubscribedParent subscribed)
1045− liftIO $ putStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
2387+ stackTrace <- liftIO $ fmap renderStack $ ccsToStrings =<< (getCCSOf $! switchSubscribedParent subscribed)
2388+ liftIO $ debugStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
10462389 EventRoot _ -> "EventRoot"
10472390 EventNever -> "EventNever"
10482391 _ -> "something else"
10492392 -}
1050− writeIORef (switchSubscribedCurrentParent subscribed) subd'
1051− parentHeight <- readIORef $ eventSubscribedHeightRef subd'
2393+ writeIORef (switchSubscribedCurrentParent subscribed) $! subscription
2394+ return oldSubscription
2395+ liftIO $ mapM_ unsubscribe mergeSubscriptionsToKill
2396+ liftIO $ mapM_ unsubscribe switchSubscriptionsToKill
2397+ forM_ toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
2398+ EventSubscription _ subd' <- readIORef $ switchSubscribedCurrentParent subscribed
2399+ parentHeight <- getEventSubscribedHeight subd'
10522400 myHeight <- readIORef $ switchSubscribedHeight subscribed
1053− if parentHeight == myHeight then return () else do
1054− writeIORef (switchSubscribedHeight subscribed) parentHeight
1055− mapM_ invalidateSubscriberHeight =<< readIORef (switchSubscribedSubscribers subscribed)
1056− forM_ coincidenceInfos $ \(SomeCoincidenceInfo _ _ mcs) -> mapM_ recalculateCoincidenceHeight mcs
2401+ when (parentHeight /= myHeight) $ do
2402+ writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
2403+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight myHeight
2404+ mapM_ _someMergeUpdate_invalidateHeight mergeUpdates --TODO: In addition to when the patch is completely empty, we should also not run this if it has some Nothing values, but none of them have actually had any effect; potentially, we could even check for Just values with no effect (e.g. by comparing their IORefs and ignoring them if they are unchanged); actually, we could just check if the new height is different
2405+ forM_ coincidenceInfos $ \(SomeResetCoincidence subscription mcs) -> do
2406+ unsubscribe subscription
2407+ mapM_ invalidateCoincidenceHeight mcs
2408+ forM_ coincidenceInfos $ \(SomeResetCoincidence _ mcs) -> mapM_ recalculateCoincidenceHeight mcs
2409+ mapM_ _someMergeUpdate_recalculateHeight mergeUpdates
10572410 forM_ toReconnect $ \(SomeSwitchSubscribed subscribed) -> do
1058− mapM_ recalculateSubscriberHeight =<< readIORef (switchSubscribedSubscribers subscribed)
2411+ height <- calculateSwitchHeight subscribed
2412+ updateSwitchHeight height subscribed
10592413 return result
10602414
1061−invalidHeight :: Int
1062−invalidHeight = -1000
1063−
1064−invalidateSubscriberHeight :: WeakSubscriber a -> IO ()
1065−invalidateSubscriberHeight ws = do
1066− ms <- deRefWeakSubscriber ws
1067− case ms of
1068− Nothing -> return () --TODO: cleanup?
1069− Just s -> case s of
1070− SubscriberPush _ subscribed -> do
1071− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberPush" <> showNodeId subscribed
1072− mapM_ invalidateSubscriberHeight =<< readIORef (pushSubscribedSubscribers subscribed)
1073− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberPush" <> showNodeId subscribed <> " done"
1074− SubscriberMerge _ subscribed -> do
1075− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed
1076− oldHeight <- readIORef $ mergeSubscribedHeight subscribed
1077− when (oldHeight /= invalidHeight) $ do
1078− writeIORef (mergeSubscribedHeight subscribed) $ invalidHeight
1079− mapM_ invalidateSubscriberHeight =<< readIORef (mergeSubscribedSubscribers subscribed)
1080− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed <> " done"
1081− SubscriberFan subscribed -> do
1082− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
1083− subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1084− forM_ (DMap.toList subscribers) $ ((\(FanSubscriberKey _ :=> v) -> mapM_ invalidateSubscriberHeight v) :: DSum (FanSubscriberKey k) -> IO ())
1085− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
1086− SubscriberHold _ -> return ()
1087− SubscriberSwitch subscribed -> do
1088− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
1089− oldHeight <- readIORef $ switchSubscribedHeight subscribed
1090− when (oldHeight /= invalidHeight) $ do
1091− writeIORef (switchSubscribedHeight subscribed) $ invalidHeight
1092− mapM_ invalidateSubscriberHeight =<< readIORef (switchSubscribedSubscribers subscribed)
1093− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
1094− SubscriberCoincidenceOuter subscribed -> do
1095− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
1096− invalidateCoincidenceHeight subscribed
1097− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
1098− SubscriberCoincidenceInner subscribed -> do
1099− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
1100− invalidateCoincidenceHeight subscribed
1101− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
1102−
1103−invalidateCoincidenceHeight :: CoincidenceSubscribed a -> IO ()
2415+newtype Height = Height { unHeight :: Int } deriving (Show, Read, Eq, Ord, Bounded)
2416+
2417+{-# INLINE zeroHeight #-}
2418+zeroHeight :: Height
2419+zeroHeight = Height 0
2420+
2421+{-# INLINE invalidHeight #-}
2422+invalidHeight :: Height
2423+invalidHeight = Height (-1000)
2424+
2425+#ifdef DEBUG_CYCLES
2426+-- | An invalid height that is currently being traversed, e.g. by walkInvalidHeightParents
2427+{-# INLINE invalidHeightBeingTraversed #-}
2428+invalidHeightBeingTraversed :: Height
2429+invalidHeightBeingTraversed = Height (-1001)
2430+#endif
2431+
2432+{-# INLINE succHeight #-}
2433+succHeight :: Height -> Height
2434+succHeight h@(Height a) =
2435+ if h == invalidHeight
2436+ then invalidHeight
2437+ else Height $ succ a
2438+
2439+invalidateCoincidenceHeight :: CoincidenceSubscribed x a -> IO ()
11042440invalidateCoincidenceHeight subscribed = do
11052441 oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
11062442 when (oldHeight /= invalidHeight) $ do
1107− writeIORef (coincidenceSubscribedHeight subscribed) $ invalidHeight
1108− mapM_ invalidateSubscriberHeight =<< readIORef (coincidenceSubscribedSubscribers subscribed)
1109−
1110−--TODO: The recalculation algorithm seems a bit funky; make sure it doesn't miss stuff or hit stuff twice; also, it should probably be lazy
1111−
1112−recalculateSubscriberHeight :: WeakSubscriber a -> IO ()
1113−recalculateSubscriberHeight ws = do
1114− ms <- deRefWeakSubscriber ws
1115− case ms of
1116− Nothing -> return () --TODO: cleanup?
1117− Just s -> case s of
1118− SubscriberPush _ subscribed -> do
1119− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberPush" <> showNodeId subscribed
1120− mapM_ recalculateSubscriberHeight =<< readIORef (pushSubscribedSubscribers subscribed)
1121− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberPush" <> showNodeId subscribed <> " done"
1122− SubscriberMerge _ subscribed -> do
1123− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed
1124− oldHeight <- readIORef $ mergeSubscribedHeight subscribed
1125− when (oldHeight == invalidHeight) $ do
1126− height <- calculateMergeHeight subscribed
1127− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
1128− when (height /= invalidHeight) $ do -- If height == invalidHeight, that means some of the prereqs have not yet been recomputed; when they do recompute, they'll catch this node again --TODO: this is O(n*m), where n is the number of children of this noe and m is the number that have been invalidated
1129− writeIORef (mergeSubscribedHeight subscribed) height
1130− mapM_ recalculateSubscriberHeight =<< readIORef (mergeSubscribedSubscribers subscribed)
1131− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed <> " done"
1132− SubscriberFan subscribed -> do
1133− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
1134− subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1135− forM_ (DMap.toList subscribers) $ ((\(FanSubscriberKey _ :=> v) -> mapM_ recalculateSubscriberHeight v) :: DSum (FanSubscriberKey k) -> IO ())
1136− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
1137− SubscriberHold _ -> return ()
1138− SubscriberSwitch subscribed -> do
1139− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
1140− oldHeight <- readIORef $ switchSubscribedHeight subscribed
1141− when (oldHeight == invalidHeight) $ do
1142− height <- calculateSwitchHeight subscribed
1143− when (height /= invalidHeight) $ do
1144− writeIORef (switchSubscribedHeight subscribed) height
1145− mapM_ recalculateSubscriberHeight =<< readIORef (switchSubscribedSubscribers subscribed)
1146− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
1147− SubscriberCoincidenceOuter subscribed -> do
1148− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
1149− void $ recalculateCoincidenceHeight subscribed
1150− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
1151− SubscriberCoincidenceInner subscribed -> do
1152− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
1153− void $ recalculateCoincidenceHeight subscribed
1154− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
1155−
1156−recalculateCoincidenceHeight :: CoincidenceSubscribed a -> IO ()
2443+ writeIORef (coincidenceSubscribedHeight subscribed) $! invalidHeight
2444+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
2445+
2446+updateSwitchHeight :: Height -> SwitchSubscribed x a -> IO ()
2447+updateSwitchHeight new subscribed = do
2448+ oldHeight <- readIORef $ switchSubscribedHeight subscribed
2449+ when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
2450+ when (new /= invalidHeight) $ do --TODO: This 'when' should probably be an assertion
2451+ writeIORef (switchSubscribedHeight subscribed) $! new
2452+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
2453+
2454+recalculateCoincidenceHeight :: CoincidenceSubscribed x a -> IO ()
11572455recalculateCoincidenceHeight subscribed = do
11582456 oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
1159− when (oldHeight == invalidHeight) $ do
2457+ when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
11602458 height <- calculateCoincidenceHeight subscribed
11612459 when (height /= invalidHeight) $ do
1162− writeIORef (coincidenceSubscribedHeight subscribed) height
1163− mapM_ recalculateSubscriberHeight =<< readIORef (coincidenceSubscribedSubscribers subscribed) --TODO: This should probably be mandatory, just like with the merge and switch ones
1164−
1165−calculateMergeHeight :: MergeSubscribed k -> IO Int
1166−calculateMergeHeight subscribed = if DMap.null (mergeSubscribedParents subscribed) then return 0 else do
1167− heights <- forM (DMap.toList $ mergeSubscribedParents subscribed) $ \(WrapArg _ :=> es) -> do
1168− readIORef $ eventSubscribedHeightRef es
1169− return $ if any (== invalidHeight) heights then invalidHeight else succ $ Prelude.maximum heights --TODO: Replace 'any' with invalidHeight-preserving 'maximum'
2460+ writeIORef (coincidenceSubscribedHeight subscribed) $! height
2461+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
11702462
1171−calculateSwitchHeight :: SwitchSubscribed a -> IO Int
1172−calculateSwitchHeight subscribed = readIORef . eventSubscribedHeightRef =<< readIORef (switchSubscribedCurrentParent subscribed)
2463+calculateSwitchHeight :: SwitchSubscribed x a -> IO Height
2464+calculateSwitchHeight subscribed = getEventSubscribedHeight . _eventSubscription_subscribed =<< readIORef (switchSubscribedCurrentParent subscribed)
11732465
1174−calculateCoincidenceHeight :: CoincidenceSubscribed a -> IO Int
2466+calculateCoincidenceHeight :: CoincidenceSubscribed x a -> IO Height
11752467calculateCoincidenceHeight subscribed = do
1176− outerHeight <- readIORef $ eventSubscribedHeightRef $ coincidenceSubscribedOuterParent subscribed
1177− innerHeight <- maybe (return 0) (readIORef . eventSubscribedHeightRef) =<< readIORef (coincidenceSubscribedInnerParent subscribed)
2468+ outerHeight <- getEventSubscribedHeight $ _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
2469+ innerHeight <- maybe (return zeroHeight) getEventSubscribedHeight =<< readIORef (coincidenceSubscribedInnerParent subscribed)
11782470 return $ if outerHeight == invalidHeight || innerHeight == invalidHeight then invalidHeight else max outerHeight innerHeight
11792471
1180−{-
1181−recalculateEventSubscribedHeight :: EventSubscribed a -> IO Int
1182−recalculateEventSubscribedHeight es = case es of
1183− EventSubscribedRoot _ -> return 0
1184− EventSubscribedNever -> return 0
1185− EventSubscribedPush subscribed -> recalculateEventSubscribedHeight $ pushSubscribedParent subscribed
1186− EventSubscribedMerge subscribed -> do
1187− oldHeight <- readIORef $ mergeSubscribedHeight subscribed
1188− if oldHeight /= invalidHeight then return oldHeight else do
1189− height <- calculateMergeHeight subscribed
1190− writeIORef (mergeSubscribedHeight subscribed) height
1191− return height
1192− EventSubscribedFan _ subscribed -> recalculateEventSubscribedHeight $ fanSubscribedParent subscribed
1193− EventSubscribedSwitch subscribed -> do
1194− oldHeight <- readIORef $ switchSubscribedHeight subscribed
1195− if oldHeight /= invalidHeight then return oldHeight else do
1196− height <- calculateSwitchHeight subscribed
1197− writeIORef (switchSubscribedHeight subscribed) height
1198− return height
1199− EventSubscribedCoincidence subscribed -> recalculateCoincidenceHeight subscribed
1200−-}
1201−
1202−data SomeSwitchSubscribed = forall a. SomeSwitchSubscribed (SwitchSubscribed a)
1203−
1204−debugInvalidate :: Bool
1205−debugInvalidate = False
2472+data SomeSwitchSubscribed x = forall a. SomeSwitchSubscribed {-# NOUNPACK #-} (SwitchSubscribed x a)
12062473
1207−invalidate :: IORef [SomeSwitchSubscribed] -> WeakList Invalidator -> IO (WeakList Invalidator)
2474+invalidate :: IORef [SomeSwitchSubscribed x] -> WeakList (Invalidator x) -> IO (WeakList (Invalidator x))
12082475invalidate toReconnectRef wis = do
12092476 forM_ wis $ \wi -> do
12102477 mi <- deRefWeak wi
12112478 case mi of
12122479 Nothing -> do
1213− when debugInvalidate $ liftIO $ putStrLn "invalidate Dead"
2480+ traceInvalidate "invalidate Dead"
12142481 return () --TODO: Should we clean this up here?
12152482 Just i -> do
12162483 finalize wi -- Once something's invalidated, it doesn't need to hang around; this will change when some things are strict
12172484 case i of
12182485 InvalidatorPull p -> do
1219− when debugInvalidate $ liftIO $ putStrLn "invalidate Pull"
2486+ traceInvalidate $ "invalidate: Pull" <> showNodeId p
12202487 mVal <- readIORef $ pullValue p
12212488 forM_ mVal $ \val -> do
12222489 writeIORef (pullValue p) Nothing
1223− writeIORef (pullSubscribedInvalidators val) =<< invalidate toReconnectRef =<< readIORef (pullSubscribedInvalidators val)
2490+ writeIORef (pullSubscribedInvalidators val) =<< evaluate =<< invalidate toReconnectRef =<< readIORef (pullSubscribedInvalidators val)
12242491 InvalidatorSwitch subscribed -> do
1225− when debugInvalidate $ liftIO $ putStrLn "invalidate Switch"
2492+ traceInvalidate $ "invalidate: Switch" <> showNodeId subscribed
12262493 modifyIORef' toReconnectRef (SomeSwitchSubscribed subscribed :)
12272494 return [] -- Since we always finalize everything, always return an empty list --TODO: There are some things that will need to be re-subscribed every time; we should try to avoid finalizing them
12282495
@@ -1230,117 +2497,434 @@ invalidate toReconnectRef wis = do
12302497-- Reflex integration
12312498--------------------------------------------------------------------------------
12322499
1233−data Spider
1234−
1235−instance R.Reflex Spider where
1236− newtype Behavior Spider a = SpiderBehavior { unSpiderBehavior :: Behavior a }
1237− newtype Event Spider a = SpiderEvent { unSpiderEvent :: Event a }
1238− type PullM Spider = BehaviorM
1239− type PushM Spider = EventM
1240− {-# INLINE never #-}
1241− {-# INLINE constant #-}
1242− never = SpiderEvent EventNever
1243− constant = SpiderBehavior . BehaviorConst
1244− push f = SpiderEvent. push f . unSpiderEvent
1245− pull = SpiderBehavior . pull
1246− merge = SpiderEvent . merge . (unsafeCoerce :: DMap (WrapArg (R.Event Spider) k) -> DMap (WrapArg Event k))
1247− fan e = R.EventSelector $ SpiderEvent . select (fan (unSpiderEvent e))
1248− switch = SpiderEvent . switch . (unsafeCoerce :: Behavior (R.Event Spider a) -> Behavior (Event a)) . unSpiderBehavior
1249− coincidence = SpiderEvent . coincidence . (unsafeCoerce :: Event (R.Event Spider a) -> Event (Event a)) . unSpiderEvent
1250−
1251−instance R.MonadSample Spider SpiderHost where
1252− {-# INLINE sample #-}
1253− sample = SpiderHost . readBehavior . unSpiderBehavior
1254−
1255−instance R.MonadHold Spider SpiderHost where
1256− hold v0 = SpiderHost . liftM SpiderBehavior . runFrame . hold v0 . unSpiderEvent
1257−
1258−instance R.MonadSample Spider BehaviorM where
1259− {-# INLINE sample #-}
1260− sample = readBehaviorTracked . unSpiderBehavior
1261−
1262−instance R.MonadSample Spider EventM where
1263− {-# INLINE sample #-}
1264− sample = liftIO . readBehavior . unSpiderBehavior
1265−
1266−instance R.MonadHold Spider EventM where
1267− {-# INLINE hold #-}
1268− hold v0 e = SpiderBehavior <$> hold v0 (unSpiderEvent e)
1269−
1270−newtype RootTrigger a = RootTrigger (IORef [WeakSubscriber a], IORef (Maybe a))
1271−
1272−instance R.ReflexHost Spider where
1273− type EventTrigger Spider = RootTrigger
1274− type EventHandle Spider = R.Event Spider
1275− type HostFrame Spider = SpiderHostFrame
1276−
1277−instance R.MonadReadEvent Spider ResultM where
1278− {-# INLINE readEvent #-}
1279− readEvent = liftM (fmap return) . readEvent . unSpiderEvent
1280−
1281−--TODO: Can probably get rid of this now that we're not using it for performEvent
1282−instance MonadTypedId EventM where
1283− type TypedId EventM = TypedId IO
1284− {-# INLINE getTypedId #-}
1285− getTypedId = do
1286− liftIO getTypedId
1287−
1288−instance MonadRef EventM where
1289− type Ref EventM = Ref IO
1290− {-# INLINE newRef #-}
1291− {-# INLINE readRef #-}
1292− {-# INLINE writeRef #-}
1293− {-# INLINE atomicModifyRef #-}
2500+-- | Designates the default, global Spider timeline
2501+data SpiderTimeline x
2502+type role SpiderTimeline nominal
2503+
2504+-- | The default, global Spider environment
2505+type Spider = SpiderTimeline Global
2506+
2507+instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (EventM x) where
2508+ {-# INLINABLE sample #-}
2509+ sample (SpiderBehavior b) = readBehaviorUntracked b
2510+
2511+instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (EventM x) where
2512+ {-# INLINABLE hold #-}
2513+ hold = holdSpiderEventM
2514+ {-# INLINABLE holdDyn #-}
2515+ holdDyn = holdDynSpiderEventM
2516+ {-# INLINABLE holdIncremental #-}
2517+ holdIncremental = holdIncrementalSpiderEventM
2518+ {-# INLINABLE buildDynamic #-}
2519+ buildDynamic = buildDynamicSpiderEventM
2520+ {-# INLINABLE headE #-}
2521+ headE = R.slowHeadE
2522+-- headE (SpiderEvent e) = SpiderEvent <$> Reflex.Spider.Internal.headE e
2523+ {-# INLINABLE now #-}
2524+ now = nowSpiderEventM
2525+
2526+instance Reflex.Class.MonadSample (SpiderTimeline x) (SpiderPullM x) where
2527+ {-# INLINABLE sample #-}
2528+ sample = coerce . readBehaviorTracked . unSpiderBehavior
2529+
2530+instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderPushM x) where
2531+ {-# INLINABLE sample #-}
2532+ sample (SpiderBehavior b) = SpiderPushM $ readBehaviorUntracked b
2533+
2534+instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderPushM x) where
2535+ {-# INLINABLE hold #-}
2536+ hold v0 e = Reflex.Class.current <$> Reflex.Class.holdDyn v0 e
2537+ {-# INLINABLE holdDyn #-}
2538+ holdDyn v0 (SpiderEvent e) = SpiderPushM $ fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce e
2539+ {-# INLINABLE holdIncremental #-}
2540+ holdIncremental v0 (SpiderEvent e) = SpiderPushM $ SpiderIncremental . dynamicHold <$> Reflex.Spider.Internal.hold v0 e
2541+ {-# INLINABLE buildDynamic #-}
2542+ buildDynamic getV0 (SpiderEvent e) = SpiderPushM $ fmap (SpiderDynamic . dynamicDynIdentity) $ Reflex.Spider.Internal.buildDynamic (coerce getV0) $ coerce e
2543+ {-# INLINABLE headE #-}
2544+ headE = R.slowHeadE
2545+-- headE (SpiderEvent e) = SpiderPushM $ SpiderEvent <$> Reflex.Spider.Internal.headE e
2546+ {-# INLINABLE now #-}
2547+ now = SpiderPushM nowSpiderEventM
2548+
2549+
2550+instance HasSpiderTimeline x => Monad (Reflex.Class.Dynamic (SpiderTimeline x)) where
2551+ {-# INLINE return #-}
2552+ return = pure
2553+ {-# INLINE (>>=) #-}
2554+ x >>= f = SpiderDynamic $ dynamicDynIdentity $ newJoinDyn $ newMapDyn (unSpiderDynamic . f) $ unSpiderDynamic x
2555+ {-# INLINE (>>) #-}
2556+ (>>) = (*>)
2557+#if !MIN_VERSION_base(4,13,0)
2558+ {-# INLINE fail #-}
2559+ fail _ = error "Dynamic does not support 'fail'"
2560+#endif
2561+
2562+{-# INLINABLE newJoinDyn #-}
2563+newJoinDyn :: HasSpiderTimeline x => DynamicS x (Identity (DynamicS x (Identity a))) -> Reflex.Spider.Internal.Dyn x (Identity a)
2564+newJoinDyn d =
2565+ let readV0 = readBehaviorTracked . dynamicCurrent =<< readBehaviorTracked (dynamicCurrent d)
2566+ eOuter = Reflex.Spider.Internal.push (fmap (Just . Identity) . readBehaviorUntracked . dynamicCurrent . runIdentity) $ dynamicUpdated d
2567+ eInner = Reflex.Spider.Internal.switch $ dynamicUpdated <$> dynamicCurrent d
2568+ eBoth = Reflex.Spider.Internal.coincidence $ dynamicUpdated . runIdentity <$> dynamicUpdated d
2569+ v' = unSpiderEvent $ Reflex.Class.leftmost $ map SpiderEvent [eBoth, eOuter, eInner]
2570+ in Reflex.Spider.Internal.unsafeBuildDynamic readV0 v'
2571+
2572+instance HasSpiderTimeline x => Functor (Reflex.Class.Dynamic (SpiderTimeline x)) where
2573+ fmap = mapDynamicSpider
2574+ x <$ d = R.unsafeBuildDynamic (return x) $ x <$ R.updated d
2575+
2576+mapDynamicSpider :: HasSpiderTimeline x => (a -> b) -> Reflex.Class.Dynamic (SpiderTimeline x) a -> Reflex.Class.Dynamic (SpiderTimeline x) b
2577+mapDynamicSpider f = SpiderDynamic . newMapDyn f . unSpiderDynamic
2578+{-# INLINE [1] mapDynamicSpider #-}
2579+
2580+instance HasSpiderTimeline x => Applicative (Reflex.Class.Dynamic (SpiderTimeline x)) where
2581+ pure = SpiderDynamic . dynamicConst
2582+#if MIN_VERSION_base(4,10,0)
2583+ liftA2 f a b = SpiderDynamic $ Reflex.Spider.Internal.zipDynWith f (unSpiderDynamic a) (unSpiderDynamic b)
2584+#endif
2585+ SpiderDynamic a <*> SpiderDynamic b = SpiderDynamic $ Reflex.Spider.Internal.zipDynWith ($) a b
2586+ a *> b = R.unsafeBuildDynamic (R.sample $ R.current b) $ R.leftmost [R.updated b, R.tag (R.current b) $ R.updated a]
2587+ (<*) = flip (*>) -- There are no effects, so order doesn't matter
2588+
2589+holdSpiderEventM :: HasSpiderTimeline x => a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Behavior (SpiderTimeline x) a)
2590+holdSpiderEventM v0 e = fmap (SpiderBehavior . behaviorHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
2591+
2592+holdDynSpiderEventM :: HasSpiderTimeline x => a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Dynamic (SpiderTimeline x) a)
2593+holdDynSpiderEventM v0 e = fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
2594+
2595+holdIncrementalSpiderEventM :: (HasSpiderTimeline x, Patch p) => PatchTarget p -> Reflex.Class.Event (SpiderTimeline x) p -> EventM x (Reflex.Class.Incremental (SpiderTimeline x) p)
2596+holdIncrementalSpiderEventM v0 e = fmap (SpiderIncremental . dynamicHold) $ Reflex.Spider.Internal.hold v0 $ unSpiderEvent e
2597+
2598+buildDynamicSpiderEventM :: HasSpiderTimeline x => SpiderPushM x a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Dynamic (SpiderTimeline x) a)
2599+buildDynamicSpiderEventM getV0 e = fmap (SpiderDynamic . dynamicDynIdentity) $ Reflex.Spider.Internal.buildDynamic (coerce getV0) $ coerce $ unSpiderEvent e
2600+
2601+instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderHost x) where
2602+ {-# INLINABLE hold #-}
2603+ hold v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.hold v0 e
2604+ {-# INLINABLE holdDyn #-}
2605+ holdDyn v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.holdDyn v0 e
2606+ {-# INLINABLE holdIncremental #-}
2607+ holdIncremental v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.holdIncremental v0 e
2608+ {-# INLINABLE buildDynamic #-}
2609+ buildDynamic getV0 e = runFrame . runSpiderHostFrame $ Reflex.Class.buildDynamic getV0 e
2610+ {-# INLINABLE headE #-}
2611+ headE e = runFrame . runSpiderHostFrame $ Reflex.Class.headE e
2612+ {-# INLINABLE now #-}
2613+ now = runFrame . runSpiderHostFrame $ Reflex.Class.now
2614+
2615+
2616+instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHostFrame x) where
2617+ sample = SpiderHostFrame . readBehaviorUntracked . unSpiderBehavior --TODO: This can cause problems with laziness, so we should get rid of it if we can
2618+
2619+instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderHostFrame x) where
2620+ {-# INLINABLE hold #-}
2621+ hold v0 e = SpiderHostFrame $ fmap (SpiderBehavior . behaviorHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
2622+ {-# INLINABLE holdDyn #-}
2623+ holdDyn v0 e = SpiderHostFrame $ fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
2624+ {-# INLINABLE holdIncremental #-}
2625+ holdIncremental v0 e = SpiderHostFrame $ fmap (SpiderIncremental . dynamicHold) $ Reflex.Spider.Internal.hold v0 $ unSpiderEvent e
2626+ {-# INLINABLE buildDynamic #-}
2627+ buildDynamic getV0 e = SpiderHostFrame $ fmap (SpiderDynamic . dynamicDynIdentity) $ Reflex.Spider.Internal.buildDynamic (coerce getV0) $ coerce $ unSpiderEvent e
2628+ {-# INLINABLE headE #-}
2629+ headE = R.slowHeadE
2630+-- headE (SpiderEvent e) = SpiderHostFrame $ SpiderEvent <$> Reflex.Spider.Internal.headE e
2631+ {-# INLINABLE now #-}
2632+ now = SpiderHostFrame Reflex.Class.now
2633+
2634+instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHost x) where
2635+ {-# INLINABLE sample #-}
2636+ sample = runFrame . readBehaviorUntracked . unSpiderBehavior
2637+
2638+instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (Reflex.Spider.Internal.ReadPhase x) where
2639+ {-# INLINABLE sample #-}
2640+ sample = Reflex.Spider.Internal.ReadPhase . Reflex.Class.sample
2641+
2642+instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Reflex.Spider.Internal.ReadPhase x) where
2643+ {-# INLINABLE hold #-}
2644+ hold v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.hold v0 e
2645+ {-# INLINABLE holdDyn #-}
2646+ holdDyn v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.holdDyn v0 e
2647+ {-# INLINABLE holdIncremental #-}
2648+ holdIncremental v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.holdIncremental v0 e
2649+ {-# INLINABLE buildDynamic #-}
2650+ buildDynamic getV0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.buildDynamic getV0 e
2651+ {-# INLINABLE headE #-}
2652+ headE e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.headE e
2653+ {-# INLINABLE now #-}
2654+ now = Reflex.Spider.Internal.ReadPhase Reflex.Class.now
2655+
2656+--------------------------------------------------------------------------------
2657+-- Deprecated items
2658+--------------------------------------------------------------------------------
2659+
2660+-- | 'SpiderEnv' is the old name for 'SpiderTimeline'
2661+{-# DEPRECATED SpiderEnv "Use 'SpiderTimelineEnv' instead" #-}
2662+type SpiderEnv = SpiderTimeline
2663+instance HasSpiderTimeline x => Reflex.Host.Class.MonadSubscribeEvent (SpiderTimeline x) (SpiderHostFrame x) where
2664+ {-# INLINABLE subscribeEvent #-}
2665+ subscribeEvent e = SpiderHostFrame $ do
2666+ --TODO: Unsubscribe eventually (manually and/or with weak ref)
2667+ val <- liftIO $ newIORef Nothing
2668+ subscription <- subscribe (unSpiderEvent e) $ Subscriber
2669+ { subscriberPropagate = \a -> do
2670+ liftIO $ writeIORef val $ Just a
2671+ scheduleClear val
2672+ , subscriberInvalidateHeight = \_ -> return ()
2673+ , subscriberRecalculateHeight = \_ -> return ()
2674+ }
2675+ return $ SpiderEventHandle
2676+ { spiderEventHandleSubscription = subscription
2677+ , spiderEventHandleValue = val
2678+ }
2679+
2680+instance HasSpiderTimeline x => Reflex.Host.Class.ReflexHost (SpiderTimeline x) where
2681+ type EventTrigger (SpiderTimeline x) = RootTrigger x
2682+ type EventHandle (SpiderTimeline x) = SpiderEventHandle x
2683+ type HostFrame (SpiderTimeline x) = SpiderHostFrame x
2684+
2685+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReadEvent (SpiderTimeline x) (Reflex.Spider.Internal.ReadPhase x) where
2686+ {-# NOINLINE readEvent #-}
2687+ readEvent h = Reflex.Spider.Internal.ReadPhase $ fmap (fmap return) $ liftIO $ do
2688+ result <- readIORef $ spiderEventHandleValue h
2689+ touch h
2690+ return result
2691+
2692+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHost x) where
2693+ newEventWithTrigger = SpiderHost . fmap SpiderEvent . newEventWithTriggerIO
2694+ newFanEventWithTrigger f = SpiderHost $ do
2695+ es <- newFanEventWithTriggerIO f
2696+ return $ Reflex.Class.EventSelector $ SpiderEvent . Reflex.Spider.Internal.select es
2697+
2698+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHostFrame x) where
2699+ newEventWithTrigger = SpiderHostFrame . EventM . liftIO . fmap SpiderEvent . newEventWithTriggerIO
2700+ newFanEventWithTrigger f = SpiderHostFrame $ EventM $ liftIO $ do
2701+ es <- newFanEventWithTriggerIO f
2702+ return $ Reflex.Class.EventSelector $ SpiderEvent . Reflex.Spider.Internal.select es
2703+
2704+instance HasSpiderTimeline x => Reflex.Host.Class.MonadSubscribeEvent (SpiderTimeline x) (SpiderHost x) where
2705+ {-# INLINABLE subscribeEvent #-}
2706+ subscribeEvent = runFrame . runSpiderHostFrame . Reflex.Host.Class.subscribeEvent
2707+
2708+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexHost (SpiderTimeline x) (SpiderHost x) where
2709+ type ReadPhase (SpiderHost x) = Reflex.Spider.Internal.ReadPhase x
2710+ fireEventsAndRead es (Reflex.Spider.Internal.ReadPhase a) = run es a
2711+ runHostFrame = runFrame . runSpiderHostFrame
2712+
2713+unsafeNewSpiderTimelineEnv :: forall x. IO (SpiderTimelineEnv x)
2714+unsafeNewSpiderTimelineEnv = do
2715+ lock <- newMVar ()
2716+ env <- newEventEnv
2717+#ifdef DEBUG
2718+ depthRef <- newIORef 0
2719+#endif
2720+ return $ STE $ SpiderTimelineEnv
2721+ { _spiderTimeline_lock = lock
2722+ , _spiderTimeline_eventEnv = env
2723+#ifdef DEBUG
2724+ , _spiderTimeline_depth = depthRef
2725+#endif
2726+ }
2727+
2728+-- | Create a new SpiderTimelineEnv
2729+newSpiderTimeline :: IO (Some SpiderTimelineEnv)
2730+newSpiderTimeline = withSpiderTimeline (pure . Some)
2731+
2732+data LocalSpiderTimeline (x :: Type) s
2733+
2734+instance Reifies s (SpiderTimelineEnv x) =>
2735+ HasSpiderTimeline (LocalSpiderTimeline x s) where
2736+ spiderTimeline = localSpiderTimeline Proxy $ reflect (Proxy :: Proxy s)
2737+
2738+localSpiderTimeline
2739+ :: proxy s
2740+ -> SpiderTimelineEnv x
2741+ -> SpiderTimelineEnv (LocalSpiderTimeline x s)
2742+localSpiderTimeline _ = coerce
2743+
2744+-- | Pass a new timeline to the given function.
2745+withSpiderTimeline :: (forall x. HasSpiderTimeline x => SpiderTimelineEnv x -> IO r) -> IO r
2746+withSpiderTimeline k = do
2747+ env <- unsafeNewSpiderTimelineEnv
2748+ reify env $ \s -> k $ localSpiderTimeline s env
2749+
2750+newtype SpiderPullM (x :: Type) a = SpiderPullM (BehaviorM x a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
2751+
2752+type ComputeM = EventM
2753+
2754+newtype SpiderPushM (x :: Type) a = SpiderPushM (ComputeM x a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
2755+
2756+instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
2757+ {-# SPECIALIZE instance R.Reflex (SpiderTimeline Global) #-}
2758+ newtype Behavior (SpiderTimeline x) a = SpiderBehavior { unSpiderBehavior :: Behavior x a }
2759+ newtype Event (SpiderTimeline x) a = SpiderEvent { unSpiderEvent :: Event x a }
2760+ newtype Dynamic (SpiderTimeline x) a = SpiderDynamic { unSpiderDynamic :: DynamicS x (Identity a) } -- deriving (Functor, Applicative, Monad)
2761+ newtype Incremental (SpiderTimeline x) p = SpiderIncremental { unSpiderIncremental :: DynamicS x p }
2762+ type PullM (SpiderTimeline x) = SpiderPullM x
2763+ type PushM (SpiderTimeline x) = SpiderPushM x
2764+ {-# INLINABLE never #-}
2765+ never = SpiderEvent eventNever
2766+ {-# INLINABLE constant #-}
2767+ constant = SpiderBehavior . behaviorConst
2768+ {-# INLINE push #-}
2769+ push f = SpiderEvent . push (coerce f) . unSpiderEvent
2770+ {-# INLINE pushCheap #-}
2771+ pushCheap f = SpiderEvent . pushCheap (coerce f) . unSpiderEvent
2772+ {-# INLINABLE pull #-}
2773+ pull = SpiderBehavior . pull . coerce
2774+ {-# INLINABLE fanG #-}
2775+ fanG e = R.EventSelectorG $ SpiderEvent . selectG (fanG (unSpiderEvent e))
2776+ {-# INLINABLE mergeG #-}
2777+ mergeG
2778+ :: forall k2 (k :: k2 -> *) q (v :: k2 -> *). GCompare k
2779+ => (forall a. q a -> R.Event (SpiderTimeline x) (v a))
2780+ -> DMap k q
2781+ -> R.Event (SpiderTimeline x) (DMap k v)
2782+ mergeG nt = SpiderEvent . mergeG (unSpiderEvent #. nt) . dynamicConst
2783+ {-# INLINABLE switch #-}
2784+ switch = SpiderEvent . switch . (coerce :: Behavior x (R.Event (SpiderTimeline x) a) -> Behavior x (Event x a)) . unSpiderBehavior
2785+ {-# INLINABLE coincidence #-}
2786+ coincidence = SpiderEvent . coincidence . (coerce :: Event x (R.Event (SpiderTimeline x) a) -> Event x (Event x a)) . unSpiderEvent
2787+ {-# INLINABLE current #-}
2788+ current = SpiderBehavior . dynamicCurrent . unSpiderDynamic
2789+ {-# INLINABLE updated #-}
2790+ updated = SpiderEvent #. dynamicUpdated .# fmap coerce . unSpiderDynamic
2791+ {-# INLINABLE unsafeBuildDynamic #-}
2792+ unsafeBuildDynamic readV0 v' = SpiderDynamic $ dynamicDynIdentity $ unsafeBuildDynamic (coerce readV0) $ coerce $ unSpiderEvent v'
2793+ {-# INLINABLE unsafeBuildIncremental #-}
2794+ unsafeBuildIncremental readV0 dv = SpiderIncremental $ dynamicDyn $ unsafeBuildDynamic (coerce readV0) $ unSpiderEvent dv
2795+ {-# INLINABLE mergeIncrementalG #-}
2796+ mergeIncrementalG nt = SpiderEvent #. mergeG (coerce #. nt) .# unSpiderIncremental
2797+ {-# INLINABLE mergeIncrementalWithMoveG #-}
2798+ mergeIncrementalWithMoveG nt = SpiderEvent #. mergeWithMove (coerce #. nt) .# unSpiderIncremental
2799+ {-# INLINABLE currentIncremental #-}
2800+ currentIncremental = SpiderBehavior . dynamicCurrent . unSpiderIncremental
2801+ {-# INLINABLE updatedIncremental #-}
2802+ updatedIncremental = SpiderEvent . dynamicUpdated . unSpiderIncremental
2803+ {-# INLINABLE incrementalToDynamic #-}
2804+ incrementalToDynamic (SpiderIncremental i) = SpiderDynamic $ dynamicDynIdentity $ unsafeBuildDynamic (readBehaviorUntracked $ dynamicCurrent i) $ flip push (dynamicUpdated i) $ \p -> do
2805+ c <- readBehaviorUntracked $ dynamicCurrent i
2806+ return $ Identity <$> apply p c --TODO: Avoid the redundant 'apply'
2807+ eventCoercion Coercion = Coercion
2808+ behaviorCoercion Coercion = Coercion
2809+ dynamicCoercion Coercion = Coercion
2810+ incrementalCoercion Coercion Coercion = Coercion
2811+ {-# INLINABLE mergeIntIncremental #-}
2812+ mergeIntIncremental = SpiderEvent . mergeInt . coerce
2813+ {-# INLINABLE fanInt #-}
2814+ fanInt e = R.EventSelectorInt $ SpiderEvent . selectInt (fanInt (unSpiderEvent e))
2815+
2816+data RootTrigger x a = forall k. GCompare k => RootTrigger (WeakBag (Subscriber x a), IORef (DMap k Identity), k a)
2817+
2818+data SpiderEventHandle x a = SpiderEventHandle
2819+ { spiderEventHandleSubscription :: EventSubscription x
2820+ , spiderEventHandleValue :: IORef (Maybe a)
2821+ }
2822+
2823+instance MonadRef (EventM x) where
2824+ type Ref (EventM x) = Ref IO
2825+ {-# INLINABLE newRef #-}
2826+ {-# INLINABLE readRef #-}
2827+ {-# INLINABLE writeRef #-}
12942828 newRef = liftIO . newRef
12952829 readRef = liftIO . readRef
12962830 writeRef r a = liftIO $ writeRef r a
2831+
2832+instance MonadAtomicRef (EventM x) where
2833+ {-# INLINABLE atomicModifyRef #-}
12972834 atomicModifyRef r f = liftIO $ atomicModifyRef r f
12982835
1299−newtype SpiderHost a = SpiderHost { runSpiderHost :: IO a } deriving (Functor, Applicative, Monad, MonadFix, MonadIO)
2836+-- | The monad for actions that manipulate a Spider timeline identified by @x@
2837+newtype SpiderHost (x :: Type) a = SpiderHost { unSpiderHost :: IO a } deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2838+
2839+instance Monad (SpiderHost x) where
2840+ {-# INLINABLE (>>=) #-}
2841+ SpiderHost x >>= f = SpiderHost $ x >>= unSpiderHost . f
2842+ {-# INLINABLE (>>) #-}
2843+ SpiderHost x >> SpiderHost y = SpiderHost $ x >> y
2844+ {-# INLINABLE return #-}
2845+ return x = SpiderHost $ return x
2846+#if !MIN_VERSION_base(4,13,0)
2847+ {-# INLINABLE fail #-}
2848+ fail = MonadFail.fail
2849+#endif
2850+
2851+instance MonadFail (SpiderHost x) where
2852+ {-# INLINABLE fail #-}
2853+ fail s = SpiderHost $ MonadFail.fail s
2854+
2855+-- | Run an action affecting the global Spider timeline; this will be guarded by
2856+-- a mutex for that timeline
2857+runSpiderHost :: SpiderHost Global a -> IO a
2858+runSpiderHost (SpiderHost a) = a
2859+
2860+-- | Run an action affecting a given Spider timeline; this will be guarded by a
2861+-- mutex for that timeline
2862+runSpiderHostForTimeline :: SpiderHost x a -> SpiderTimelineEnv x -> IO a
2863+runSpiderHostForTimeline (SpiderHost a) _ = a
2864+
2865+newtype SpiderHostFrame (x :: Type) a = SpiderHostFrame { runSpiderHostFrame :: EventM x a }
2866+ deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2867+
2868+instance Monad (SpiderHostFrame x) where
2869+ {-# INLINABLE (>>=) #-}
2870+ SpiderHostFrame x >>= f = SpiderHostFrame $ x >>= runSpiderHostFrame . f
2871+ {-# INLINABLE (>>) #-}
2872+ SpiderHostFrame x >> SpiderHostFrame y = SpiderHostFrame $ x >> y
2873+ {-# INLINABLE return #-}
2874+ return x = SpiderHostFrame $ return x
2875+#if !MIN_VERSION_base(4,13,0)
2876+ {-# INLINABLE fail #-}
2877+ fail s = SpiderHostFrame $ fail s
2878+#endif
13002879
1301−newtype SpiderHostFrame a = SpiderHostFrame { runSpiderHostFrame :: EventM a } deriving (Functor, Applicative, Monad, MonadFix, MonadIO)
2880+instance NotReady (SpiderTimeline x) (SpiderHostFrame x) where
2881+ notReadyUntil _ = pure ()
2882+ notReady = pure ()
13022883
1303−instance R.MonadSample Spider SpiderHostFrame where
1304− sample = SpiderHostFrame . R.sample --TODO: This can cause problems with laziness, so we should get rid of it if we can
1305−
1306−instance R.MonadHold Spider SpiderHostFrame where
1307− {-# INLINE hold #-}
1308− hold v0 e = SpiderHostFrame $ R.hold v0 e
2884+newEventWithTriggerIO :: forall x a. HasSpiderTimeline x => (RootTrigger x a -> IO (IO ())) -> IO (Event x a)
2885+newEventWithTriggerIO f = do
2886+ es <- newFanEventWithTriggerIO $ \Refl -> f
2887+ return $ select es Refl
13092888
1310−newEventWithTriggerIO f= do
1311− occRef <- newIORef Nothing
1312− subscribedRef <- newIORef Nothing
2889+newFanEventWithTriggerIO :: (HasSpiderTimeline x, GCompare k) => (forall a. k a -> RootTrigger x a -> IO (IO ())) -> IO (EventSelector x k)
2890+newFanEventWithTriggerIO f = do
2891+ occRef <- newIORef DMap.empty
2892+ subscribedRef <- newIORef DMap.empty
13132893 let !r = Root
13142894 { rootOccurrence = occRef
13152895 , rootSubscribed = subscribedRef
13162896 , rootInit = f
13172897 }
1318− return $ SpiderEvent $ EventRoot r
2898+ return $ EventSelector $ \k -> eventRoot k r
13192899
1320−instance R.MonadReflexCreateTrigger Spider SpiderHost where
1321− newEventWithTrigger = SpiderHost . newEventWithTriggerIO
2900+newtype ReadPhase x a = ReadPhase (ResultM x a) deriving (Functor, Applicative, Monad, MonadFix)
13222901
1323−instance R.MonadReflexCreateTrigger Spider SpiderHostFrame where
1324− newEventWithTrigger = SpiderHostFrame . EventM . liftIO . newEventWithTriggerIO
1325−
1326−instance R.MonadReflexHost Spider SpiderHost where
1327− fireEventsAndRead es a = SpiderHost $ run es a
1328− subscribeEvent e = SpiderHost $ do
1329− _ <- runFrame $ getEventSubscribed $ unSpiderEvent e --TODO: The result of this should actually be used
1330− return e
1331− runFrame = SpiderHost . runFrame
1332− runHostFrame = SpiderHost . runFrame . runSpiderHostFrame
1333−
1334−instance MonadRef SpiderHost where
1335− type Ref SpiderHost = Ref IO
2902+instance MonadRef (SpiderHost x) where
2903+ type Ref (SpiderHost x) = Ref IO
13362904 newRef = SpiderHost . newRef
13372905 readRef = SpiderHost . readRef
13382906 writeRef r = SpiderHost . writeRef r
2907+
2908+instance MonadAtomicRef (SpiderHost x) where
13392909 atomicModifyRef r = SpiderHost . atomicModifyRef r
13402910
1341−instance MonadRef SpiderHostFrame where
1342− type Ref SpiderHostFrame = Ref IO
2911+instance MonadRef (SpiderHostFrame x) where
2912+ type Ref (SpiderHostFrame x) = Ref IO
13432913 newRef = SpiderHostFrame . newRef
13442914 readRef = SpiderHostFrame . readRef
13452915 writeRef r = SpiderHostFrame . writeRef r
2916+
2917+instance MonadAtomicRef (SpiderHostFrame x) where
13462918 atomicModifyRef r = SpiderHostFrame . atomicModifyRef r
2919+
2920+instance PrimMonad (SpiderHostFrame x) where
2921+ type PrimState (SpiderHostFrame x) = PrimState IO
2922+ primitive = SpiderHostFrame . EventM . primitive
2923+
2924+instance NotReady (SpiderTimeline x) (SpiderHost x) where
2925+ notReadyUntil _ = return ()
2926+ notReady = return ()
2927+
2928+instance HasSpiderTimeline x => NotReady (SpiderTimeline x) (PerformEventT (SpiderTimeline x) (SpiderHost x)) where
2929+ notReadyUntil _ = return ()
2930+ notReady = return ()