@@ -1,2465 +0,0 @@
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 MagicHash #-}
13−{-# LANGUAGE MultiParamTypeClasses #-}
14−{-# LANGUAGE MultiWayIf #-}
15−{-# LANGUAGE RankNTypes #-}
16−{-# LANGUAGE RoleAnnotations #-}
17−{-# LANGUAGE ScopedTypeVariables #-}
18−{-# LANGUAGE TypeFamilies #-}
19−{-# LANGUAGE TypeOperators #-}
20−{-# LANGUAGE UndecidableInstances #-}
21−#ifdef USE_REFLEX_OPTIMIZER
22−{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
23−#endif
24−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
25−{-# OPTIONS_GHC -fno-warn-orphans #-}
26−#endif
27−-- | This module is the implementation of the 'Spider' 'Reflex' engine. It uses
28−-- a graph traversal algorithm to propagate 'Event's and 'Behavior's.
29−module Reflex.Spider.Internal (module Reflex.Spider.Internal) where
30−
31−import Control.Applicative
32−import Control.Concurrent
33−import Control.Exception
34−import Control.Monad hiding (forM, forM_, mapM, mapM_, sequence)
35−import Control.Monad.Exception
36−import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence)
37−import Control.Monad.Primitive
38−import Control.Monad.Reader hiding (forM, forM_, mapM, mapM_, sequence)
39−import Control.Monad.Ref
40−import Data.Align
41−import Data.Coerce
42−import Data.Dependent.Map (DMap, DSum (..))
43−import qualified Data.Dependent.Map as DMap
44−import Data.Foldable hiding (concat, elem, sequence_)
45−import Data.Function
46−import Data.Functor.Constant
47−import Data.Functor.Misc
48−import Data.Functor.Product
49−import Data.GADT.Compare
50−import Data.IntMap.Strict (IntMap)
51−import qualified Data.IntMap.Strict as IntMap
52−import Data.IORef
53−import Data.List hiding (foldl')
54−import Data.Maybe
55−import Data.Monoid ((<>))
56−import Data.Proxy
57−import Data.These
58−import Data.Traversable
59−import Data.Word
60−import Data.FastMutableIntMap (FastMutableIntMap, PatchIntMap (..))
61−import qualified Data.FastMutableIntMap as FastMutableIntMap
62−import GHC.Exts
63−import GHC.IORef (IORef (..))
64−import GHC.Stack
65−import Reflex.FastWeak
66−import Reflex.FunctorMaybe
67−import System.IO.Unsafe
68−import System.Mem.Weak
69−import Unsafe.Coerce
70−
71−#ifdef DEBUG_CYCLES
72−import Control.Monad.State hiding (forM, forM_, mapM, mapM_, sequence)
73−import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
74−import qualified Data.List.NonEmpty as NonEmpty
75−import Data.Monoid (mempty)
76−import Data.Tree (Forest, Tree (..), drawForest)
77−#endif
78−
79−import Data.FastWeakBag (FastWeakBag)
80−import qualified Data.FastWeakBag as FastWeakBag
81−import Data.WeakBag (WeakBag, WeakBagTicket, _weakBag_children)
82−import qualified Data.WeakBag as WeakBag
83−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
84−import Data.Reflection
85−import Data.Some (Some)
86−import qualified Data.Some as Some
87−import Data.Type.Coercion
88−import qualified Reflex.Class
89−import qualified Reflex.Class as R
90−import qualified Reflex.Host.Class
91−#endif
92−import Reflex.NotReady.Class
93−import Reflex.Patch
94−import qualified Reflex.Patch.DMapWithMove as PatchDMapWithMove
95−
96−-- Note: must come last to silence warnings due to AMP on GHC < 7.10
97−import Prelude hiding (any, concat, mapM, mapM_, sequence)
98−
99−#ifdef DEBUG_TRACE_EVENTS
100−import System.IO (stderr)
101−import qualified Data.ByteString.Char8 as BS8
102−#endif
103−
104−#ifdef DEBUG_TRACE_EVENTS
105−
106−withStackOneLine :: (BS8.ByteString -> a) -> a
107−withStackOneLine expr = unsafePerformIO $ do
108− stack <- currentCallStack
109− return (expr (BS8.pack (unwords (reverse stack))))
110−
111−#endif
112−
113−debugPropagate :: Bool
114−
115−debugInvalidateHeight :: Bool
116−
117−debugInvalidate :: Bool
118−
119−#ifdef DEBUG
120−
121−#define DEBUG_NODEIDS
122−
123−debugPropagate = True
124−
125−debugInvalidateHeight = False
126−
127−debugInvalidate = True
128−
129−class HasNodeId a where
130− getNodeId :: a -> Int
131−
132−instance HasNodeId (Hold x p a) where
133− getNodeId = holdNodeId
134−
135−instance HasNodeId (PushSubscribed x a b) where
136− getNodeId = pushSubscribedNodeId
137−
138−instance HasNodeId (SwitchSubscribed x a) where
139− getNodeId = switchSubscribedNodeId
140−
141−instance HasNodeId (FanSubscribed x a) where
142− getNodeId = fanSubscribedNodeId
143−
144−instance HasNodeId (CoincidenceSubscribed x a) where
145− getNodeId = coincidenceSubscribedNodeId
146−
147−instance HasNodeId (RootSubscribed x a) where
148− getNodeId = rootSubscribedNodeId
149−
150−instance HasNodeId (Pull x a) where
151− getNodeId = pullNodeId
152−
153−{-# INLINE showNodeId #-}
154−showNodeId :: HasNodeId a => a -> String
155−showNodeId = ("#"<>) . show . getNodeId
156−
157−showSubscriberType :: Subscriber x a -> String
158−showSubscriberType = \case
159− SubscriberPush _ _ -> "SubscriberPush"
160− SubscriberMerge _ _ -> "SubscriberMerge"
161− SubscriberFan _ -> "SubscriberFan"
162− SubscriberMergeChange _ -> "SubscriberMergeChange"
163− SubscriberHold _ -> "SubscriberHold"
164− SubscriberHoldIdentity _ -> "SubscriberHoldIdentity"
165− SubscriberSwitch _ -> "SubscriberSwitch"
166− SubscriberCoincidenceOuter _ -> "SubscriberCoincidenceOuter"
167− SubscriberCoincidenceInner _ -> "SubscriberCoincidenceInner"
168− SubscriberHandle -> "SubscriberHandle"
169−
170−showEventType :: Event x a -> String
171−showEventType = \case
172− EventRoot _ _ -> "EventRoot"
173− EventNever -> "EventNever"
174− EventPush _ -> "EventPush"
175− EventMerge _ -> "EventMerge"
176− EventFan _ _ -> "EventFan"
177− EventSwitch _ -> "EventSwitch"
178− EventCoincidence _ -> "EventCoincidence"
179− EventHold _ -> "EventHold"
180− EventDyn _ -> "EventDyn"
181− EventHoldIdentity _ -> "EventHoldIdentity"
182− EventDynIdentity _ -> "EventDynIdentity"
183−
184−#else
185−
186−debugPropagate = False
187−
188−debugInvalidateHeight = False
189−
190−debugInvalidate = False
191−
192−-- This must be inline, or error messages will cause memory leaks due to retaining the node in question
193−{-# INLINE showNodeId #-}
194−showNodeId :: a -> String
195−showNodeId _ = ""
196−
197−#endif
198−
199−#ifdef DEBUG_NODEIDS
200−{-# NOINLINE nextNodeIdRef #-}
201−nextNodeIdRef :: IORef Int
202−nextNodeIdRef = unsafePerformIO $ newIORef 1
203−
204−newNodeId :: IO Int
205−newNodeId = atomicModifyIORef' nextNodeIdRef $ \n -> (succ n, n)
206−
207−{-# NOINLINE unsafeNodeId #-}
208−unsafeNodeId :: a -> Int
209−unsafeNodeId a = unsafePerformIO $ do
210− touch a
211− newNodeId
212−#endif
213−
214−--------------------------------------------------------------------------------
215−-- EventSubscription
216−--------------------------------------------------------------------------------
217−
218−--NB: Once you subscribe to an Event, you must always hold on the the WHOLE EventSubscription you get back
219−-- If you do not retain the subscription, you may be prematurely unsubscribed from the parent event.
220−data EventSubscription x = EventSubscription
221− { _eventSubscription_unsubscribe :: !(IO ())
222− , _eventSubscription_subscribed :: {-# UNPACK #-} !(EventSubscribed x)
223− }
224−
225−unsubscribe :: EventSubscription x -> IO ()
226−unsubscribe (EventSubscription u _) = u
227−
228−--------------------------------------------------------------------------------
229−-- Event
230−--------------------------------------------------------------------------------
231−
232−newtype Event x a = Event { unEvent :: Subscriber x a -> EventM x (EventSubscription x, Maybe a) }
233−
234−{-# INLINE subscribeAndRead #-}
235−subscribeAndRead :: Event x a -> Subscriber x a -> EventM x (EventSubscription x, Maybe a)
236−subscribeAndRead = unEvent
237−
238−{-# RULES
239−"cacheEvent/cacheEvent" forall e. cacheEvent (cacheEvent e) = cacheEvent e
240−"cacheEvent/pushCheap" forall f e. pushCheap f (cacheEvent e) = cacheEvent (pushCheap f e)
241−"hold/cacheEvent" forall f e. hold f (cacheEvent e) = hold f e
242− #-}
243−
244−-- | Construct an 'Event' equivalent to that constructed by 'push', but with no
245−-- caching; if the computation function is very cheap, this is (much) more
246−-- efficient than 'push'
247−{-# INLINE [1] pushCheap #-}
248−pushCheap :: HasSpiderTimeline x => (a -> ComputeM x (Maybe b)) -> Event x a -> Event x b
249−pushCheap !f e = Event $ \sub -> do
250− (subscription, occ) <- subscribeAndRead e $ sub
251− { subscriberPropagate = \a -> do
252− mb <- f a
253− mapM_ (subscriberPropagate sub) mb
254− }
255− occ' <- join <$> mapM f occ
256− return (subscription, occ')
257−
258−-- | A subscriber that never triggers other 'Event's
259−{-# INLINE terminalSubscriber #-}
260−terminalSubscriber :: (a -> EventM x ()) -> Subscriber x a
261−terminalSubscriber p = Subscriber
262− { subscriberPropagate = p
263− , subscriberInvalidateHeight = \_ -> return ()
264− , subscriberRecalculateHeight = \_ -> return ()
265− }
266−
267−-- | Subscribe to an Event only for the duration of one occurrence
268−{-# INLINE subscribeAndReadHead #-}
269−subscribeAndReadHead :: Event x a -> Subscriber x a -> EventM x (EventSubscription x, Maybe a)
270−subscribeAndReadHead e sub = do
271− subscriptionRef <- liftIO $ newIORef $ error "subscribeAndReadHead: not initialized"
272− (subscription, occ) <- subscribeAndRead e $ sub
273− { subscriberPropagate = \a -> do
274− liftIO $ unsubscribe =<< readIORef subscriptionRef
275− subscriberPropagate sub a
276− }
277− liftIO $ case occ of
278− Nothing -> writeIORef subscriptionRef $! subscription
279− Just _ -> unsubscribe subscription
280− return (subscription, occ)
281−
282−--TODO: Make this lazy in its input event
283−headE :: (MonadIO m, Defer (SomeMergeInit x) m) => Event x a -> m (Event x a)
284−headE originalE = do
285− parent <- liftIO $ newIORef $ Just originalE
286− defer $ SomeMergeInit $ do --TODO: Rename SomeMergeInit appropriately
287− let clearParent = liftIO $ writeIORef parent Nothing
288− (_, occ) <- subscribeAndReadHead originalE $ terminalSubscriber $ \_ -> clearParent
289− when (isJust occ) clearParent
290− return $ Event $ \sub -> do
291− liftIO (readIORef parent) >>= \case
292− Nothing -> return (EventSubscription (return ()) $ EventSubscribed zeroRef $ toAny (), Nothing)
293− Just e -> subscribeAndReadHead e sub
294−
295−data CacheSubscribed x a
296− = CacheSubscribed { _cacheSubscribed_subscribers :: {-# UNPACK #-} !(FastWeakBag (Subscriber x a))
297− , _cacheSubscribed_parent :: {-# UNPACK #-} !(EventSubscription x)
298− , _cacheSubscribed_occurrence :: {-# UNPACK #-} !(IORef (Maybe a))
299− }
300−
301−-- | Construct an 'Event' whose value is guaranteed not to be recomputed
302−-- repeatedly
303−--
304−--TODO: Try a caching strategy where we subscribe directly to the parent when
305−--there's only one subscriber, and then build our own FastWeakBag only when a second
306−--subscriber joins
307−{-# NOINLINE [0] cacheEvent #-}
308−cacheEvent :: forall x a. HasSpiderTimeline x => Event x a -> Event x a
309−cacheEvent e =
310−#ifdef DEBUG_TRACE_EVENTS
311− withStackOneLine $ \callSite -> Event $
312−#else
313− Event $
314−#endif
315− let mSubscribedRef :: IORef (FastWeak (CacheSubscribed x a))
316− !mSubscribedRef = unsafeNewIORef e emptyFastWeak
317− in \sub -> {-# SCC "cacheEvent" #-} do
318−#ifdef DEBUG_TRACE_EVENTS
319− unless (BS8.null callSite) $ liftIO $ BS8.hPutStrLn stderr callSite
320−#endif
321− subscribedTicket <- liftIO (readIORef mSubscribedRef >>= getFastWeakTicket) >>= \case
322− Just subscribedTicket -> return subscribedTicket
323− Nothing -> do
324− subscribers <- liftIO FastWeakBag.empty
325− occRef <- liftIO $ newIORef Nothing -- This should never be read prior to being set below
326− (parentSub, occ) <- subscribeAndRead e $ Subscriber
327− { subscriberPropagate = \a -> do
328− liftIO $ writeIORef occRef $ Just a
329− scheduleClear occRef
330− propagateFast a subscribers
331− , subscriberInvalidateHeight = \old -> do
332− FastWeakBag.traverse subscribers $ invalidateSubscriberHeight old
333− , subscriberRecalculateHeight = \new -> do
334− FastWeakBag.traverse subscribers $ recalculateSubscriberHeight new
335− }
336− when (isJust occ) $ do
337− liftIO $ writeIORef occRef occ -- Set the initial value of occRef; we don't need to do this if occ is Nothing
338− scheduleClear occRef
339− let !subscribed = CacheSubscribed
340− { _cacheSubscribed_subscribers = subscribers
341− , _cacheSubscribed_parent = parentSub
342− , _cacheSubscribed_occurrence = occRef
343− }
344− subscribedTicket <- liftIO $ mkFastWeakTicket subscribed
345− liftIO $ writeIORef mSubscribedRef =<< getFastWeakTicketWeak subscribedTicket
346− return subscribedTicket
347− liftIO $ do
348− subscribed <- getFastWeakTicketValue subscribedTicket
349− ticket <- FastWeakBag.insert sub $ _cacheSubscribed_subscribers subscribed
350− occ <- readIORef $ _cacheSubscribed_occurrence subscribed
351− let es = EventSubscription
352− { _eventSubscription_unsubscribe = do
353− FastWeakBag.remove ticket
354− isEmpty <- FastWeakBag.isEmpty $ _cacheSubscribed_subscribers subscribed
355− when isEmpty $ do
356− writeIORef mSubscribedRef emptyFastWeak
357− unsubscribe $ _cacheSubscribed_parent subscribed
358− touch ticket
359− touch subscribedTicket
360− , _eventSubscription_subscribed = EventSubscribed
361− { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ _cacheSubscribed_parent subscribed
362− , eventSubscribedRetained = toAny subscribedTicket
363− }
364− }
365− return (es, occ)
366−
367−subscribe :: Event x a -> Subscriber x a -> EventM x (EventSubscription x)
368−subscribe e s = fst <$> subscribeAndRead e s
369−
370−{-# INLINE wrap #-}
371−wrap :: MonadIO m => (t -> EventSubscribed x) -> (Subscriber x a -> m (WeakBagTicket, t, Maybe a)) -> Subscriber x a -> m (EventSubscription x, Maybe a)
372−wrap tag getSpecificSubscribed sub = do
373− (sln, subd, occ) <- getSpecificSubscribed sub
374− let es = tag subd
375− return (EventSubscription (WeakBag.remove sln >> touch sln) es, occ)
376−
377−eventRoot :: GCompare k => k a -> Root x k -> Event x a
378−eventRoot !k !r = Event $ wrap eventSubscribedRoot $ liftIO . getRootSubscribed k r
379−
380−eventNever :: Event x a
381−eventNever = Event $ \_ -> return (EventSubscription (return ()) eventSubscribedNever, Nothing)
382−
383−eventFan :: (GCompare k, HasSpiderTimeline x) => k a -> Fan x k -> Event x a
384−eventFan !k !f = Event $ wrap eventSubscribedFan $ getFanSubscribed k f
385−
386−eventSwitch :: HasSpiderTimeline x => Switch x a -> Event x a
387−eventSwitch !s = Event $ wrap eventSubscribedSwitch $ getSwitchSubscribed s
388−
389−eventCoincidence :: HasSpiderTimeline x => Coincidence x a -> Event x a
390−eventCoincidence !c = Event $ wrap eventSubscribedCoincidence $ getCoincidenceSubscribed c
391−
392−eventHold :: HasSpiderTimeline x => Hold x p -> Event x p
393−eventHold !h = Event $ subscribeHoldEvent h
394−
395−eventDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> Event x p
396−eventDyn !j = Event $ \sub -> getDynHold j >>= \h -> subscribeHoldEvent h sub
397−
398−{-# INLINE subscribeCoincidenceInner #-}
399−subscribeCoincidenceInner :: HasSpiderTimeline x => Event x a -> Height -> CoincidenceSubscribed x a -> EventM x (Maybe a, Height, EventSubscribed x)
400−subscribeCoincidenceInner inner outerHeight subscribedUnsafe = do
401− subInner <- liftIO $ newSubscriberCoincidenceInner subscribedUnsafe
402− (subscription@(EventSubscription _ innerSubd), innerOcc) <- subscribeAndRead inner subInner
403− innerHeight <- liftIO $ getEventSubscribedHeight innerSubd
404− let height = max innerHeight outerHeight
405− defer $ SomeResetCoincidence subscription $ if height > outerHeight then Just subscribedUnsafe else Nothing
406− return (innerOcc, height, innerSubd)
407−
408−--------------------------------------------------------------------------------
409−-- Subscriber
410−--------------------------------------------------------------------------------
411−
412−data Subscriber x a = Subscriber
413− { subscriberPropagate :: !(a -> EventM x ())
414− , subscriberInvalidateHeight :: !(Height -> IO ())
415− , subscriberRecalculateHeight :: !(Height -> IO ())
416− }
417−
418−--TODO: Move this comment to WeakBag
419−-- These function are constructor functions that are marked NOINLINE so they are
420−-- opaque to GHC. If we do not do this, then GHC will sometimes fuse the constructor away
421−-- so any weak references that are attached to the constructors will have their
422−-- finalizer run. Using the opaque constructor, does not see the
423−-- constructor application, so it behaves like an IORef and cannot be fused away.
424−--
425−-- The result is also evaluated to WHNF, since forcing a thunk invalidates
426−-- the weak pointer to it in some cases.
427−
428−newSubscriberHold :: (HasSpiderTimeline x, Patch p) => Hold x p -> IO (Subscriber x p)
429−newSubscriberHold h = return $ Subscriber
430− { subscriberPropagate = {-# SCC "traverseHold" #-} propagateSubscriberHold h
431− , subscriberInvalidateHeight = \_ -> return ()
432− , subscriberRecalculateHeight = \_ -> return ()
433− }
434−
435−newSubscriberFan :: forall x k. (HasSpiderTimeline x, GCompare k) => FanSubscribed x k -> IO (Subscriber x (DMap k Identity))
436−newSubscriberFan subscribed = return $ Subscriber
437− { subscriberPropagate = \a -> {-# SCC "traverseFan" #-} do
438− subs <- liftIO $ readIORef $ fanSubscribedSubscribers subscribed
439− tracePropagate (Proxy :: Proxy x) $ "SubscriberFan" <> showNodeId subscribed <> ": " ++ show (DMap.size subs) ++ " keys subscribed, " ++ show (DMap.size a) ++ " keys firing"
440− liftIO $ writeIORef (fanSubscribedOccurrence subscribed) $ Just a
441− scheduleClear $ fanSubscribedOccurrence subscribed
442− let f _ (Pair (Identity v) subsubs) = do
443− propagate v $ _fanSubscribedChildren_list subsubs
444− return $ Constant ()
445− _ <- DMap.traverseWithKey f $ DMap.intersectionWithKey (\_ -> Pair) a subs --TODO: Would be nice to have DMap.traverse_
446− return ()
447− , subscriberInvalidateHeight = \old -> do
448− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
449− subscribers <- readIORef $ fanSubscribedSubscribers subscribed
450− forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ invalidateSubscriberHeight old
451− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
452− , subscriberRecalculateHeight = \new -> do
453− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
454− subscribers <- readIORef $ fanSubscribedSubscribers subscribed
455− forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ recalculateSubscriberHeight new
456− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
457− }
458−
459−newSubscriberSwitch :: forall x a. HasSpiderTimeline x => SwitchSubscribed x a -> IO (Subscriber x a)
460−newSubscriberSwitch subscribed = return $ Subscriber
461− { subscriberPropagate = \a -> {-# SCC "traverseSwitch" #-} do
462− tracePropagate (Proxy :: Proxy x) $ "SubscriberSwitch" <> showNodeId subscribed
463− liftIO $ writeIORef (switchSubscribedOccurrence subscribed) $ Just a
464− scheduleClear $ switchSubscribedOccurrence subscribed
465− propagate a $ switchSubscribedSubscribers subscribed
466− , subscriberInvalidateHeight = \_ -> do
467− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
468− oldHeight <- readIORef $ switchSubscribedHeight subscribed
469− when (oldHeight /= invalidHeight) $ do
470− writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
471− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
472− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
473− , subscriberRecalculateHeight = \new -> do
474− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
475− updateSwitchHeight new subscribed
476− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
477− }
478−
479−newSubscriberCoincidenceOuter :: forall x b. HasSpiderTimeline x => CoincidenceSubscribed x b -> IO (Subscriber x (Event x b))
480−newSubscriberCoincidenceOuter subscribed = return $ Subscriber
481− { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceOuter" #-} do
482− tracePropagate (Proxy :: Proxy x) $ "SubscriberCoincidenceOuter" <> showNodeId subscribed
483− outerHeight <- liftIO $ readIORef $ coincidenceSubscribedHeight subscribed
484− tracePropagate (Proxy :: Proxy x) $ " outerHeight = " <> show outerHeight
485− (occ, innerHeight, innerSubd) <- subscribeCoincidenceInner a outerHeight subscribed
486− tracePropagate (Proxy :: Proxy x) $ " isJust occ = " <> show (isJust occ)
487− tracePropagate (Proxy :: Proxy x) $ " innerHeight = " <> show innerHeight
488− liftIO $ writeIORef (coincidenceSubscribedInnerParent subscribed) $ Just innerSubd
489− scheduleClear $ coincidenceSubscribedInnerParent subscribed
490− case occ of
491− Nothing -> do
492− when (innerHeight > outerHeight) $ liftIO $ do -- If the event fires, it will fire at a later height
493− writeIORef (coincidenceSubscribedHeight subscribed) $! innerHeight
494− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight outerHeight
495− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight innerHeight
496− Just o -> do -- Since it's already firing, no need to adjust height
497− liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) occ
498− scheduleClear $ coincidenceSubscribedOccurrence subscribed
499− propagate o $ coincidenceSubscribedSubscribers subscribed
500− , subscriberInvalidateHeight = \_ -> do
501− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
502− invalidateCoincidenceHeight subscribed
503− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
504− , subscriberRecalculateHeight = \_ -> do
505− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
506− recalculateCoincidenceHeight subscribed
507− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
508− }
509−
510−newSubscriberCoincidenceInner :: forall x a. HasSpiderTimeline x => CoincidenceSubscribed x a -> IO (Subscriber x a)
511−newSubscriberCoincidenceInner subscribed = return $ Subscriber
512− { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceInner" #-} do
513− tracePropagate (Proxy :: Proxy x) $ "SubscriberCoincidenceInner" <> showNodeId subscribed
514− occ <- liftIO $ readIORef $ coincidenceSubscribedOccurrence subscribed
515− case occ of
516− Just _ -> return () -- SubscriberCoincidenceOuter must have already propagated this event
517− Nothing -> do
518− liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) $ Just a
519− scheduleClear $ coincidenceSubscribedOccurrence subscribed
520− propagate a $ coincidenceSubscribedSubscribers subscribed
521− , subscriberInvalidateHeight = \_ -> do
522− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
523− invalidateCoincidenceHeight subscribed
524− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
525− , subscriberRecalculateHeight = \_ -> do
526− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
527− recalculateCoincidenceHeight subscribed
528− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
529− }
530−
531−invalidateSubscriberHeight :: Height -> Subscriber x a -> IO ()
532−invalidateSubscriberHeight = flip subscriberInvalidateHeight
533−
534−recalculateSubscriberHeight :: Height -> Subscriber x a -> IO ()
535−recalculateSubscriberHeight = flip subscriberRecalculateHeight
536−
537−-- | Propagate everything at the current height
538−propagate :: a -> WeakBag (Subscriber x a) -> EventM x ()
539−propagate a subscribers = withIncreasedDepth $ do
540− -- 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
541− --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
542− WeakBag.traverse subscribers $ \s -> subscriberPropagate s a
543−
544−-- | Propagate everything at the current height
545−propagateFast :: a -> FastWeakBag (Subscriber x a) -> EventM x ()
546−propagateFast a subscribers = withIncreasedDepth $ do
547− -- 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
548− --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
549− FastWeakBag.traverse subscribers $ \s -> subscriberPropagate s a
550−
551−--------------------------------------------------------------------------------
552−-- EventSubscribed
553−--------------------------------------------------------------------------------
554−
555−toAny :: a -> Any
556−toAny = unsafeCoerce
557−
558−data EventSubscribed x = EventSubscribed
559− { eventSubscribedHeightRef :: {-# UNPACK #-} !(IORef Height)
560− , eventSubscribedRetained :: {-# NOUNPACK #-} !Any
561−#ifdef DEBUG_CYCLES
562− , eventSubscribedGetParents :: !(IO [Some (EventSubscribed x)]) -- For debugging loops
563− , eventSubscribedHasOwnHeightRef :: !Bool
564− , eventSubscribedWhoCreated :: !(IO [String])
565−#endif
566− }
567−
568−eventSubscribedRoot :: RootSubscribed x a -> EventSubscribed x
569−eventSubscribedRoot !r = EventSubscribed
570− { eventSubscribedHeightRef = zeroRef
571− , eventSubscribedRetained = toAny r
572−#ifdef DEBUG_CYCLES
573− , eventSubscribedGetParents = return []
574− , eventSubscribedHasOwnHeightRef = False
575− , eventSubscribedWhoCreated = return ["root"]
576−#endif
577− }
578−
579−eventSubscribedNever :: EventSubscribed x
580−eventSubscribedNever = EventSubscribed
581− { eventSubscribedHeightRef = zeroRef
582− , eventSubscribedRetained = toAny ()
583−#ifdef DEBUG_CYCLES
584− , eventSubscribedGetParents = return []
585− , eventSubscribedHasOwnHeightRef = False
586− , eventSubscribedWhoCreated = return ["never"]
587−#endif
588− }
589−
590−eventSubscribedFan :: FanSubscribed x k -> EventSubscribed x
591−eventSubscribedFan !subscribed = EventSubscribed
592− { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ fanSubscribedParent subscribed
593− , eventSubscribedRetained = toAny subscribed
594−#ifdef DEBUG_CYCLES
595− , eventSubscribedGetParents = return [Some.This $ _eventSubscription_subscribed $ fanSubscribedParent subscribed]
596− , eventSubscribedHasOwnHeightRef = False
597− , eventSubscribedWhoCreated = whoCreatedIORef $ fanSubscribedCachedSubscribed subscribed
598−#endif
599− }
600−
601−eventSubscribedSwitch :: SwitchSubscribed x a -> EventSubscribed x
602−eventSubscribedSwitch !subscribed = EventSubscribed
603− { eventSubscribedHeightRef = switchSubscribedHeight subscribed
604− , eventSubscribedRetained = toAny subscribed
605−#ifdef DEBUG_CYCLES
606− , eventSubscribedGetParents = do
607− s <- readIORef $ switchSubscribedCurrentParent subscribed
608− return [Some.This $ _eventSubscription_subscribed s]
609− , eventSubscribedHasOwnHeightRef = True
610− , eventSubscribedWhoCreated = whoCreatedIORef $ switchSubscribedCachedSubscribed subscribed
611−#endif
612− }
613−
614−eventSubscribedCoincidence :: CoincidenceSubscribed x a -> EventSubscribed x
615−eventSubscribedCoincidence !subscribed = EventSubscribed
616− { eventSubscribedHeightRef = coincidenceSubscribedHeight subscribed
617− , eventSubscribedRetained = toAny subscribed
618−#ifdef DEBUG_CYCLES
619− , eventSubscribedGetParents = do
620− innerSubscription <- readIORef $ coincidenceSubscribedInnerParent subscribed
621− let outerParent = Some.This $ _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
622− innerParents = maybeToList $ fmap Some.This innerSubscription
623− return $ outerParent : innerParents
624− , eventSubscribedHasOwnHeightRef = True
625− , eventSubscribedWhoCreated = whoCreatedIORef $ coincidenceSubscribedCachedSubscribed subscribed
626−#endif
627− }
628−
629−getEventSubscribedHeight :: EventSubscribed x -> IO Height
630−getEventSubscribedHeight es = readIORef $ eventSubscribedHeightRef es
631−
632−#ifdef DEBUG_CYCLES
633−whoCreatedEventSubscribed :: EventSubscribed x -> IO [String]
634−whoCreatedEventSubscribed = eventSubscribedWhoCreated
635−
636−walkInvalidHeightParents :: EventSubscribed x -> IO [Some (EventSubscribed x)]
637−walkInvalidHeightParents s0 = do
638− subscribers <- flip execStateT mempty $ ($ Some.This s0) $ fix $ \loop (Some.This s) -> do
639− h <- liftIO $ readIORef $ eventSubscribedHeightRef s
640− when (h == invalidHeight) $ do
641− when (eventSubscribedHasOwnHeightRef s) $ liftIO $ writeIORef (eventSubscribedHeightRef s) $! invalidHeightBeingTraversed
642− modify (Some.This s :)
643− mapM_ loop =<< liftIO (eventSubscribedGetParents s)
644− forM_ subscribers $ \(Some.This s) -> writeIORef (eventSubscribedHeightRef s) $! invalidHeight
645− return subscribers
646−#endif
647−
648−{-# INLINE subscribeHoldEvent #-}
649−subscribeHoldEvent :: HasSpiderTimeline x => Hold x p -> Subscriber x p -> EventM x (EventSubscription x, Maybe p)
650−subscribeHoldEvent = subscribeAndRead . holdEvent
651−
652−--------------------------------------------------------------------------------
653−-- Behavior
654−--------------------------------------------------------------------------------
655−
656−newtype Behavior x a = Behavior { readBehaviorTracked :: BehaviorM x a }
657−
658−behaviorHold :: Hold x p -> Behavior x (PatchTarget p)
659−behaviorHold !h = Behavior $ readHoldTracked h
660−
661−behaviorHoldIdentity :: Hold x (Identity a) -> Behavior x a
662−behaviorHoldIdentity = behaviorHold
663−
664−behaviorConst :: a -> Behavior x a
665−behaviorConst !a = Behavior $ return a
666−
667−behaviorPull :: Pull x a -> Behavior x a
668−behaviorPull !p = Behavior $ do
669− val <- liftIO $ readIORef $ pullValue p
670− case val of
671− Just subscribed -> do
672− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
673− askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (pullSubscribedInvalidators subscribed) (wi:))
674− liftIO $ touch $ pullSubscribedOwnInvalidator subscribed
675− return $ pullSubscribedValue subscribed
676− Nothing -> do
677− i <- liftIO $ newInvalidatorPull p
678− wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorPull"
679− parentsRef <- liftIO $ newIORef []
680− holdInits <- askBehaviorHoldInits
681− a <- liftIO $ runReaderT (unBehaviorM $ pullCompute p) (Just (wi, parentsRef), holdInits)
682− invsRef <- liftIO . newIORef . maybeToList =<< askInvalidator
683− parents <- liftIO $ readIORef parentsRef
684− let subscribed = PullSubscribed
685− { pullSubscribedValue = a
686− , pullSubscribedInvalidators = invsRef
687− , pullSubscribedOwnInvalidator = i
688− , pullSubscribedParents = parents
689− }
690− liftIO $ writeIORef (pullValue p) $ Just subscribed
691− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
692− return a
693−
694−behaviorDyn :: Patch p => Dyn x p -> Behavior x (PatchTarget p)
695−behaviorDyn !d = Behavior $ readHoldTracked =<< getDynHold d
696−
697−{-# INLINE readHoldTracked #-}
698−readHoldTracked :: Hold x p -> BehaviorM x (PatchTarget p)
699−readHoldTracked h = do
700− result <- liftIO $ readIORef $ holdValue h
701− askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (holdInvalidators h) (wi:))
702− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedHold h) :))
703− liftIO $ touch h -- Otherwise, if this gets inlined enough, the hold's parent reference may get collected
704− return result
705−
706−{-# INLINABLE readBehaviorUntracked #-}
707−readBehaviorUntracked :: Defer (SomeHoldInit x) m => Behavior x a -> m a
708−readBehaviorUntracked b = do
709− holdInits <- getDeferralQueue
710− liftIO $ runBehaviorM (readBehaviorTracked b) Nothing holdInits --TODO: Specialize readBehaviorTracked to the Nothing and Just cases
711−
712−--------------------------------------------------------------------------------
713−-- Dynamic
714−--------------------------------------------------------------------------------
715−
716−data Dynamic x p = Dynamic
717− { dynamicCurrent :: !(Behavior x (PatchTarget p))
718− , dynamicUpdated :: !(Event x p)
719− }
720−
721−dynamicHold :: HasSpiderTimeline x => Hold x p -> Dynamic x p
722−dynamicHold !h = Dynamic
723− { dynamicCurrent = behaviorHold h
724− , dynamicUpdated = eventHold h
725− }
726−
727−dynamicHoldIdentity :: HasSpiderTimeline x => Hold x (Identity a) -> Dynamic x (Identity a)
728−dynamicHoldIdentity = dynamicHold
729−
730−dynamicConst :: PatchTarget p -> Dynamic x p
731−dynamicConst !a = Dynamic
732− { dynamicCurrent = behaviorConst a
733− , dynamicUpdated = eventNever
734− }
735−
736−dynamicDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> Dynamic x p
737−dynamicDyn !d = Dynamic
738− { dynamicCurrent = behaviorDyn d
739− , dynamicUpdated = eventDyn d
740− }
741−
742−dynamicDynIdentity :: HasSpiderTimeline x => Dyn x (Identity a) -> Dynamic x (Identity a)
743−dynamicDynIdentity = dynamicDyn
744−
745−--------------------------------------------------------------------------------
746−-- Combinators
747−--------------------------------------------------------------------------------
748−
749−--TODO: Figure out why certain things are not 'representational', then make them
750−--representational so we can use coerce
751−
752−--type role Hold representational
753−data Hold x p
754− = Hold { holdValue :: !(IORef (PatchTarget p))
755− , holdInvalidators :: !(IORef [Weak (Invalidator x)])
756− , holdEvent :: Event x p -- This must be lazy, or holds cannot be defined before their input Events
757− , holdParent :: !(IORef (Maybe (EventSubscription x))) -- Keeps its parent alive (will be undefined until the hold is initialized) --TODO: Probably shouldn't be an IORef
758−#ifdef DEBUG_NODEIDS
759− , holdNodeId :: Int
760−#endif
761− }
762−
763−-- | A statically allocated 'SpiderTimeline'; this is the only instance of
764−-- 'SpiderTimeline' that can used when using
765−-- -fspecialize-to-spidertimeline-global.
766−data Global
767−
768−{-# NOINLINE globalSpiderTimelineEnv #-}
769−globalSpiderTimelineEnv :: SpiderTimelineEnv Global
770−globalSpiderTimelineEnv = unsafePerformIO unsafeNewSpiderTimelineEnv
771−
772−-- | Stores all global data relevant to a particular Spider timeline; only one
773−-- value should exist for each type @x@
774−data SpiderTimelineEnv x = SpiderTimelineEnv
775− { _spiderTimeline_lock :: {-# UNPACK #-} !(MVar ())
776− , _spiderTimeline_eventEnv :: {-# UNPACK #-} !(EventEnv x)
777−#ifdef DEBUG
778− , _spiderTimeline_depth :: {-# UNPACK #-} !(IORef Int)
779−#endif
780− }
781−type role SpiderTimelineEnv nominal
782−
783−instance Eq (SpiderTimelineEnv x) where
784− _ == _ = True -- Since only one exists of each type
785−
786−instance GEq SpiderTimelineEnv where
787−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
788− geqToEq _ = id
789− geqUnify (a :: SpiderTimelineEnv a) (b :: SpiderTimelineEnv b) different same = if _spiderTimeline_lock a == _spiderTimeline_lock b
790− then case unsafeCoerce Refl :: a :~: b of
791− Refl -> same -- This unsafeCoerce is safe because the same SpiderTimelineEnv can't have two different 'x' arguments
792− else different
793−#else
794− a `geq` b = if _spiderTimeline_lock a == _spiderTimeline_lock b
795− then Just $ unsafeCoerce Refl -- This unsafeCoerce is safe because the same SpiderTimelineEnv can't have two different 'x' arguments
796− else Nothing
797−#endif
798−
799−data EventEnv x
800− = EventEnv { eventEnvAssignments :: !(IORef [SomeAssignment x]) -- Needed for Subscribe
801− , eventEnvHoldInits :: !(IORef [SomeHoldInit x]) -- Needed for Subscribe
802− , eventEnvDynInits :: !(IORef [SomeDynInit x])
803− , eventEnvMergeUpdates :: !(IORef [SomeMergeUpdate x])
804− , eventEnvMergeInits :: !(IORef [SomeMergeInit x]) -- Needed for Subscribe
805− , eventEnvClears :: !(IORef [SomeClear]) -- Needed for Subscribe
806− , eventEnvIntClears :: !(IORef [SomeIntClear])
807− , eventEnvRootClears :: !(IORef [SomeRootClear])
808− , eventEnvCurrentHeight :: !(IORef Height) -- Needed for Subscribe
809− , eventEnvResetCoincidences :: !(IORef [SomeResetCoincidence x]) -- Needed for Subscribe
810− , eventEnvDelayedMerges :: !(IORef (IntMap [EventM x ()]))
811− }
812−
813−{-# INLINE runEventM #-}
814−runEventM :: EventM x a -> IO a
815−runEventM = unEventM
816−
817−asksEventEnv :: forall x a. HasSpiderTimeline x => (EventEnv x -> a) -> EventM x a
818−asksEventEnv f = return $ f $ _spiderTimeline_eventEnv (spiderTimeline :: SpiderTimelineEnv x)
819−
820−class MonadIO m => Defer a m where
821− getDeferralQueue :: m (IORef [a])
822−
823−{-# INLINE defer #-}
824−defer :: Defer a m => a -> m ()
825−defer a = do
826− q <- getDeferralQueue
827− liftIO $ modifyIORef' q (a:)
828−
829−instance HasSpiderTimeline x => Defer (SomeAssignment x) (EventM x) where
830− {-# INLINE getDeferralQueue #-}
831− getDeferralQueue = asksEventEnv eventEnvAssignments
832−
833−instance HasSpiderTimeline x => Defer (SomeHoldInit x) (EventM x) where
834− {-# INLINE getDeferralQueue #-}
835− getDeferralQueue = asksEventEnv eventEnvHoldInits
836−
837−instance HasSpiderTimeline x => Defer (SomeDynInit x) (EventM x) where
838− {-# INLINE getDeferralQueue #-}
839− getDeferralQueue = asksEventEnv eventEnvDynInits
840−
841−instance Defer (SomeHoldInit x) (BehaviorM x) where
842− {-# INLINE getDeferralQueue #-}
843− getDeferralQueue = BehaviorM $ asks snd
844−
845−instance HasSpiderTimeline x => Defer (SomeMergeUpdate x) (EventM x) where
846− {-# INLINE getDeferralQueue #-}
847− getDeferralQueue = asksEventEnv eventEnvMergeUpdates
848−
849−instance HasSpiderTimeline x => Defer (SomeMergeInit x) (EventM x) where
850− {-# INLINE getDeferralQueue #-}
851− getDeferralQueue = asksEventEnv eventEnvMergeInits
852−
853−class HasSpiderTimeline x => HasCurrentHeight x m | m -> x where
854− getCurrentHeight :: m Height
855− scheduleMerge :: Height -> EventM x () -> m ()
856−
857−instance HasSpiderTimeline x => HasCurrentHeight x (EventM x) where
858− {-# INLINE getCurrentHeight #-}
859− getCurrentHeight = do
860− heightRef <- asksEventEnv eventEnvCurrentHeight
861− liftIO $ readIORef heightRef
862− {-# INLINE scheduleMerge #-}
863− scheduleMerge height subscribed = do
864− delayedRef <- asksEventEnv eventEnvDelayedMerges
865− liftIO $ modifyIORef' delayedRef $ IntMap.insertWith (++) (unHeight height) [subscribed]
866−
867−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
868−class x ~ Global => HasSpiderTimeline x where
869−#else
870−class HasSpiderTimeline x where
871−#endif
872− -- | Retrieve the current SpiderTimelineEnv
873− spiderTimeline :: SpiderTimelineEnv x
874−
875−instance HasSpiderTimeline Global where
876− spiderTimeline = globalSpiderTimelineEnv
877−
878−putCurrentHeight :: HasSpiderTimeline x => Height -> EventM x ()
879−putCurrentHeight h = do
880− heightRef <- asksEventEnv eventEnvCurrentHeight
881− liftIO $ writeIORef heightRef $! h
882−
883−instance HasSpiderTimeline x => Defer SomeClear (EventM x) where
884− {-# INLINE getDeferralQueue #-}
885− getDeferralQueue = asksEventEnv eventEnvClears
886−
887−{-# INLINE scheduleClear #-}
888−scheduleClear :: Defer SomeClear m => IORef (Maybe a) -> m ()
889−scheduleClear r = defer $ SomeClear r
890−
891−instance HasSpiderTimeline x => Defer SomeIntClear (EventM x) where
892− {-# INLINE getDeferralQueue #-}
893− getDeferralQueue = asksEventEnv eventEnvIntClears
894−
895−{-# INLINE scheduleIntClear #-}
896−scheduleIntClear :: Defer SomeIntClear m => IORef (IntMap a) -> m ()
897−scheduleIntClear r = defer $ SomeIntClear r
898−
899−instance HasSpiderTimeline x => Defer SomeRootClear (EventM x) where
900− {-# INLINE getDeferralQueue #-}
901− getDeferralQueue = asksEventEnv eventEnvRootClears
902−
903−{-# INLINE scheduleRootClear #-}
904−scheduleRootClear :: Defer SomeRootClear m => IORef (DMap k Identity) -> m ()
905−scheduleRootClear r = defer $ SomeRootClear r
906−
907−instance HasSpiderTimeline x => Defer (SomeResetCoincidence x) (EventM x) where
908− {-# INLINE getDeferralQueue #-}
909− getDeferralQueue = asksEventEnv eventEnvResetCoincidences
910−
911−-- Note: hold cannot examine its event until after the phase is over
912−{-# INLINE [1] hold #-}
913−hold :: (Patch p, Defer (SomeHoldInit x) m) => PatchTarget p -> Event x p -> m (Hold x p)
914−hold v0 e = do
915− valRef <- liftIO $ newIORef v0
916− invsRef <- liftIO $ newIORef []
917− parentRef <- liftIO $ newIORef Nothing
918−#ifdef DEBUG_NODEIDS
919− nodeId <- liftIO newNodeId
920−#endif
921− let h = Hold
922− { holdValue = valRef
923− , holdInvalidators = invsRef
924− , holdEvent = e
925− , holdParent = parentRef
926−#ifdef DEBUG_NODEIDS
927− , holdNodeId = nodeId
928−#endif
929− }
930− defer $ SomeHoldInit h
931− return h
932−
933−{-# INLINE getHoldEventSubscription #-}
934−getHoldEventSubscription :: forall p x. (HasSpiderTimeline x, Patch p) => Hold x p -> EventM x (EventSubscription x)
935−getHoldEventSubscription h = do
936− ep <- liftIO $ readIORef $ holdParent h
937− case ep of
938− Just subd -> return subd
939− Nothing -> do
940− let e = holdEvent h
941− subscriptionRef <- liftIO $ newIORef $ error "getHoldEventSubscription: subdRef uninitialized"
942− (subscription@(EventSubscription _ _), occ) <- subscribeAndRead e =<< liftIO (newSubscriberHold h)
943− liftIO $ writeIORef subscriptionRef $! subscription
944− case occ of
945− Nothing -> return ()
946− Just o -> do
947− old <- liftIO $ readIORef $ holdValue h
948− case apply o old of
949− Nothing -> return ()
950− Just new -> do
951− -- Need to evaluate these so that we don't retain the Hold itself
952− v <- liftIO $ evaluate $ holdValue h
953− i <- liftIO $ evaluate $ holdInvalidators h
954− defer $ SomeAssignment v i new
955− liftIO $ writeIORef (holdParent h) $ Just subscription
956− return subscription
957−
958−type BehaviorEnv x = (Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]), IORef [SomeHoldInit x])
959−
960−--type role BehaviorM representational
961−-- BehaviorM can sample behaviors
962−newtype BehaviorM x a = BehaviorM { unBehaviorM :: ReaderT (BehaviorEnv x) IO a } deriving (Functor, Applicative, MonadIO, MonadFix)
963−
964−instance Monad (BehaviorM x) where
965− {-# INLINE (>>=) #-}
966− BehaviorM x >>= f = BehaviorM $ x >>= unBehaviorM . f
967− {-# INLINE (>>) #-}
968− BehaviorM x >> BehaviorM y = BehaviorM $ x >> y
969− {-# INLINE return #-}
970− return x = BehaviorM $ return x
971− {-# INLINE fail #-}
972− fail s = BehaviorM $ fail s
973−
974−data BehaviorSubscribed x a
975− = forall p. BehaviorSubscribedHold (Hold x p)
976− | BehaviorSubscribedPull (PullSubscribed x a)
977−
978−data SomeBehaviorSubscribed x = forall a. SomeBehaviorSubscribed (BehaviorSubscribed x a)
979−
980−--type role PullSubscribed representational
981−data PullSubscribed x a
982− = PullSubscribed { pullSubscribedValue :: !a
983− , pullSubscribedInvalidators :: !(IORef [Weak (Invalidator x)])
984− , pullSubscribedOwnInvalidator :: !(Invalidator x)
985− , pullSubscribedParents :: ![SomeBehaviorSubscribed x] -- Need to keep parent behaviors alive, or they won't let us know when they're invalidated
986− }
987−
988−--type role Pull representational
989−data Pull x a
990− = Pull { pullValue :: !(IORef (Maybe (PullSubscribed x a)))
991− , pullCompute :: !(BehaviorM x a)
992−#ifdef DEBUG_NODEIDS
993− , pullNodeId :: Int
994−#endif
995− }
996−
997−data Invalidator x
998− = forall a. InvalidatorPull (Pull x a)
999− | forall a. InvalidatorSwitch (SwitchSubscribed x a)
1000−
1001−data RootSubscribed x a = forall k. GCompare k => RootSubscribed
1002− { rootSubscribedKey :: !(k a)
1003− , rootSubscribedCachedSubscribed :: !(IORef (DMap k (RootSubscribed x))) -- From the original Root
1004− , rootSubscribedSubscribers :: !(WeakBag (Subscriber x a))
1005− , rootSubscribedOccurrence :: !(IO (Maybe a)) -- Lookup from rootOccurrence
1006− , rootSubscribedUninit :: IO ()
1007− , 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?
1008−#ifdef DEBUG_NODEIDS
1009− , rootSubscribedNodeId :: Int
1010−#endif
1011− }
1012−
1013−data Root x (k :: * -> *)
1014− = Root { rootOccurrence :: !(IORef (DMap k Identity)) -- The currently-firing occurrence of this event
1015− , rootSubscribed :: !(IORef (DMap k (RootSubscribed x)))
1016− , rootInit :: !(forall a. k a -> RootTrigger x a -> IO (IO ()))
1017− }
1018−
1019−data SomeHoldInit x = forall p. Patch p => SomeHoldInit !(Hold x p)
1020−
1021−data SomeDynInit x = forall p. Patch p => SomeDynInit !(Dyn x p)
1022−
1023−data SomeMergeUpdate x = SomeMergeUpdate
1024− { _someMergeUpdate_update :: !(EventM x [EventSubscription x])
1025− , _someMergeUpdate_invalidateHeight :: !(IO ())
1026− , _someMergeUpdate_recalculateHeight :: !(IO ())
1027− }
1028−
1029−newtype SomeMergeInit x = SomeMergeInit { unSomeMergeInit :: EventM x () }
1030−
1031−-- EventM can do everything BehaviorM can, plus create holds
1032−newtype EventM x a = EventM { unEventM :: IO a } deriving (Functor, Applicative, Monad, MonadIO, MonadFix, MonadException, MonadAsyncException) -- 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
1033−
1034−newtype MergeSubscribedParent x a = MergeSubscribedParent { unMergeSubscribedParent :: EventSubscription x }
1035−
1036−data MergeSubscribedParentWithMove x k a = MergeSubscribedParentWithMove
1037− { _mergeSubscribedParentWithMove_subscription :: !(EventSubscription x)
1038− , _mergeSubscribedParentWithMove_key :: !(IORef (k a))
1039− }
1040−
1041−data HeightBag = HeightBag
1042− { _heightBag_size :: {-# UNPACK #-} !Int
1043− , _heightBag_contents :: !(IntMap Word) -- Number of excess in each bucket
1044− }
1045− deriving (Show, Read, Eq, Ord)
1046−
1047−heightBagEmpty :: HeightBag
1048−heightBagEmpty = heightBagVerify $ HeightBag 0 IntMap.empty
1049−
1050−heightBagSize :: HeightBag -> Int
1051−heightBagSize = _heightBag_size
1052−
1053−heightBagFromList :: [Height] -> HeightBag
1054−heightBagFromList heights = heightBagVerify $ foldl' (flip heightBagAdd) heightBagEmpty heights
1055−
1056−heightBagAdd :: Height -> HeightBag -> HeightBag
1057−heightBagAdd (Height h) (HeightBag s c) = heightBagVerify $ HeightBag (succ s) $ IntMap.insertWithKey (\_ _ old -> succ old) h 0 c
1058−
1059−heightBagRemove :: Height -> HeightBag -> HeightBag
1060−heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.lookup h c of
1061− Nothing -> error $ "heightBagRemove: Height " <> show h <> " not present in bag " <> show b
1062− Just old -> HeightBag (pred s) $ case old of
1063− 0 -> IntMap.delete h c
1064− _ -> IntMap.insert h (pred old) c
1065−
1066−heightBagMax :: HeightBag -> Height
1067−heightBagMax (HeightBag _ c) = case IntMap.maxViewWithKey c of
1068− Just ((h, _), _) -> Height h
1069− Nothing -> zeroHeight
1070−
1071−heightBagVerify :: HeightBag -> HeightBag
1072−#ifdef DEBUG
1073−heightBagVerify b@(HeightBag s c) = if
1074− | s /= IntMap.size c + fromIntegral (sum (IntMap.elems c))
1075− -> error $ "heightBagVerify: size doesn't match: " <> show b
1076− | unHeight invalidHeight `IntMap.member` c
1077− -> error $ "heightBagVerify: contains invalid height: " <> show b
1078− | otherwise -> b
1079−#else
1080−heightBagVerify = id
1081−#endif
1082−
1083−data FanSubscribedChildren (x :: *) k a = FanSubscribedChildren
1084− { _fanSubscribedChildren_list :: !(WeakBag (Subscriber x a))
1085− , _fanSubscribedChildren_self :: {-# NOUNPACK #-} !(k a, FanSubscribed x k)
1086− , _fanSubscribedChildren_weakSelf :: !(IORef (Weak (k a, FanSubscribed x k)))
1087− }
1088−
1089−data FanSubscribed (x :: *) k
1090− = FanSubscribed { fanSubscribedCachedSubscribed :: !(IORef (Maybe (FanSubscribed x k)))
1091− , fanSubscribedOccurrence :: !(IORef (Maybe (DMap k Identity)))
1092− , fanSubscribedSubscribers :: !(IORef (DMap k (FanSubscribedChildren x k))) -- This DMap should never be empty
1093− , fanSubscribedParent :: !(EventSubscription x)
1094−#ifdef DEBUG_NODEIDS
1095− , fanSubscribedNodeId :: Int
1096−#endif
1097− }
1098−
1099−data Fan x k
1100− = Fan { fanParent :: !(Event x (DMap k Identity))
1101− , fanSubscribed :: !(IORef (Maybe (FanSubscribed x k)))
1102− }
1103−
1104−data SwitchSubscribed x a
1105− = SwitchSubscribed { switchSubscribedCachedSubscribed :: !(IORef (Maybe (SwitchSubscribed x a)))
1106− , switchSubscribedOccurrence :: !(IORef (Maybe a))
1107− , switchSubscribedHeight :: !(IORef Height)
1108− , switchSubscribedSubscribers :: !(WeakBag (Subscriber x a))
1109− , switchSubscribedOwnInvalidator :: {-# NOUNPACK #-} !(Invalidator x)
1110− , switchSubscribedOwnWeakInvalidator :: !(IORef (Weak (Invalidator x)))
1111− , switchSubscribedBehaviorParents :: !(IORef [SomeBehaviorSubscribed x])
1112− , switchSubscribedParent :: !(Behavior x (Event x a))
1113− , switchSubscribedCurrentParent :: !(IORef (EventSubscription x))
1114− , switchSubscribedWeakSelf :: !(IORef (Weak (SwitchSubscribed x a)))
1115−#ifdef DEBUG_NODEIDS
1116− , switchSubscribedNodeId :: Int
1117−#endif
1118− }
1119−
1120−data Switch x a
1121− = Switch { switchParent :: !(Behavior x (Event x a))
1122− , switchSubscribed :: !(IORef (Maybe (SwitchSubscribed x a)))
1123− }
1124−
1125−#ifdef USE_TEMPLATE_HASKELL
1126−{-# ANN CoincidenceSubscribed "HLint: ignore Redundant bracket" #-}
1127−#endif
1128−data CoincidenceSubscribed x a
1129− = CoincidenceSubscribed { coincidenceSubscribedCachedSubscribed :: !(IORef (Maybe (CoincidenceSubscribed x a)))
1130− , coincidenceSubscribedOccurrence :: !(IORef (Maybe a))
1131− , coincidenceSubscribedSubscribers :: !(WeakBag (Subscriber x a))
1132− , coincidenceSubscribedHeight :: !(IORef Height)
1133− , coincidenceSubscribedOuter :: {-# NOUNPACK #-} (Subscriber x (Event x a))
1134− , coincidenceSubscribedOuterParent :: !(EventSubscription x)
1135− , coincidenceSubscribedInnerParent :: !(IORef (Maybe (EventSubscribed x)))
1136− , coincidenceSubscribedWeakSelf :: !(IORef (Weak (CoincidenceSubscribed x a)))
1137−#ifdef DEBUG_NODEIDS
1138− , coincidenceSubscribedNodeId :: Int
1139−#endif
1140− }
1141−
1142−data Coincidence x a
1143− = Coincidence { coincidenceParent :: !(Event x (Event x a))
1144− , coincidenceSubscribed :: !(IORef (Maybe (CoincidenceSubscribed x a)))
1145− }
1146−
1147−{-# NOINLINE newInvalidatorSwitch #-}
1148−newInvalidatorSwitch :: SwitchSubscribed x a -> IO (Invalidator x)
1149−newInvalidatorSwitch subd = return $! InvalidatorSwitch subd
1150−
1151−{-# NOINLINE newInvalidatorPull #-}
1152−newInvalidatorPull :: Pull x a -> IO (Invalidator x)
1153−newInvalidatorPull p = return $! InvalidatorPull p
1154−
1155−instance HasSpiderTimeline x => FunctorMaybe (Event x) where
1156− fmapMaybe f = push $ return . f
1157−
1158−instance HasSpiderTimeline x => Align (Event x) where
1159− nil = eventNever
1160− align ea eb = fmapMaybe dmapToThese $ merge $ dynamicConst $ DMap.fromDistinctAscList [LeftTag :=> ea, RightTag :=> eb]
1161−
1162−newtype Dyn x p = Dyn { unDyn :: IORef (Either (BehaviorM x (PatchTarget p), Event x p) (Hold x p)) }
1163−
1164−newMapDyn :: HasSpiderTimeline x => (a -> b) -> Dynamic x (Identity a) -> Dynamic x (Identity b)
1165−newMapDyn f d = dynamicDynIdentity $ unsafeBuildDynamic (fmap f $ readBehaviorTracked $ dynamicCurrent d) (Identity . f . runIdentity <$> dynamicUpdated d)
1166−
1167−--TODO: Avoid the duplication between this and R.zipDynWith
1168−zipDynWith :: HasSpiderTimeline x => (a -> b -> c) -> Dynamic x (Identity a) -> Dynamic x (Identity b) -> Dynamic x (Identity c)
1169−zipDynWith f da db =
1170− let eab = align (dynamicUpdated da) (dynamicUpdated db)
1171− ec = flip push eab $ \o -> do
1172− (a, b) <- case o of
1173− This (Identity a) -> do
1174− b <- readBehaviorUntracked $ dynamicCurrent db
1175− return (a, b)
1176− That (Identity b) -> do
1177− a <- readBehaviorUntracked $ dynamicCurrent da
1178− return (a, b)
1179− These (Identity a) (Identity b) -> return (a, b)
1180− return $ Just $ Identity $ f a b
1181− in dynamicDynIdentity $ unsafeBuildDynamic (f <$> readBehaviorUntracked (dynamicCurrent da) <*> readBehaviorUntracked (dynamicCurrent db)) ec
1182−
1183−buildDynamic :: (Defer (SomeDynInit x) m, Patch p) => BehaviorM x (PatchTarget p) -> Event x p -> m (Dyn x p)
1184−buildDynamic readV0 v' = do
1185− result <- liftIO $ newIORef $ Left (readV0, v')
1186− let !d = Dyn result
1187− defer $ SomeDynInit d
1188− return d
1189−
1190−unsafeBuildDynamic :: BehaviorM x (PatchTarget p) -> Event x p -> Dyn x p
1191−unsafeBuildDynamic readV0 v' = Dyn $ unsafeNewIORef x $ Left x
1192− where x = (readV0, v')
1193−
1194−-- ResultM can read behaviors and events
1195−type ResultM = EventM
1196−
1197−{-# NOINLINE unsafeNewIORef #-}
1198−unsafeNewIORef :: a -> b -> IORef b
1199−unsafeNewIORef a b = unsafePerformIO $ do
1200− touch a
1201− newIORef b
1202−
1203−instance HasSpiderTimeline x => Functor (Event x) where
1204− fmap f = push $ return . Just . f
1205−
1206−instance Functor (Behavior x) where
1207− fmap f = pull . fmap f . readBehaviorTracked
1208−
1209−{-# INLINE push #-}
1210−push :: HasSpiderTimeline x => (a -> ComputeM x (Maybe b)) -> Event x a -> Event x b
1211−push f e = cacheEvent (pushCheap f e)
1212−
1213−{-# INLINABLE pull #-}
1214−pull :: BehaviorM x a -> Behavior x a
1215−pull a = behaviorPull $ Pull
1216− { pullCompute = a
1217− , pullValue = unsafeNewIORef a Nothing
1218−#ifdef DEBUG_NODEIDS
1219− , pullNodeId = unsafeNodeId a
1220−#endif
1221− }
1222−
1223−{-# INLINABLE switch #-}
1224−switch :: HasSpiderTimeline x => Behavior x (Event x a) -> Event x a
1225−switch a = eventSwitch $ Switch
1226− { switchParent = a
1227− , switchSubscribed = unsafeNewIORef a Nothing
1228− }
1229−
1230−coincidence :: HasSpiderTimeline x => Event x (Event x a) -> Event x a
1231−coincidence a = eventCoincidence $ Coincidence
1232− { coincidenceParent = a
1233− , coincidenceSubscribed = unsafeNewIORef a Nothing
1234− }
1235−
1236−-- Propagate the given event occurrence; before cleaning up, run the given action, which may read the state of events and behaviors
1237−run :: forall x b. HasSpiderTimeline x => [DSum (RootTrigger x) Identity] -> ResultM x b -> SpiderHost x b
1238−run roots after = do
1239− tracePropagate (Proxy :: Proxy x) $ "Running an event frame with " <> show (length roots) <> " events"
1240− t <- SpiderHost ask
1241− result <- SpiderHost $ lift $ withMVar (_spiderTimeline_lock t) $ \_ -> flip runReaderT t $ unSpiderHost $ runFrame $ do
1242− rootsToPropagate <- forM roots $ \r@(RootTrigger (_, occRef, k) :=> a) -> do
1243− occBefore <- liftIO $ do
1244− occBefore <- readIORef occRef
1245− writeIORef occRef $! DMap.insert k a occBefore
1246− return occBefore
1247− if DMap.null occBefore
1248− then do scheduleRootClear occRef
1249− return $ Just r
1250− else return Nothing
1251− forM_ (catMaybes rootsToPropagate) $ \(RootTrigger (subscribersRef, _, _) :=> Identity a) -> do
1252− propagate a subscribersRef
1253− delayedRef <- asksEventEnv eventEnvDelayedMerges
1254− let go = do
1255− delayed <- liftIO $ readIORef delayedRef
1256− case IntMap.minViewWithKey delayed of
1257− Nothing -> return ()
1258− Just ((currentHeight, cur), future) -> do
1259− tracePropagate (Proxy :: Proxy x) $ "Running height " ++ show currentHeight
1260− putCurrentHeight $ Height currentHeight
1261− liftIO $ writeIORef delayedRef $! future
1262− sequence_ cur
1263− go
1264− go
1265− putCurrentHeight maxBound
1266− after
1267− tracePropagate (Proxy :: Proxy x) "Done running an event frame"
1268− return result
1269−
1270−scheduleMerge' :: HasSpiderTimeline x => Height -> IORef Height -> EventM x () -> EventM x ()
1271−scheduleMerge' initialHeight heightRef a = scheduleMerge initialHeight $ do
1272− height <- liftIO $ readIORef heightRef
1273− currentHeight <- getCurrentHeight
1274− case height `compare` currentHeight of
1275− LT -> error "Somehow a merge's height has been decreased after it was scheduled"
1276− GT -> scheduleMerge' height heightRef a -- The height has been increased (by a coincidence event; TODO: is this the only way?)
1277− EQ -> a
1278−
1279−data SomeClear = forall a. SomeClear {-# UNPACK #-} !(IORef (Maybe a))
1280−
1281−data SomeIntClear = forall a. SomeIntClear {-# UNPACK #-} !(IORef (IntMap a))
1282−
1283−data SomeRootClear = forall k. SomeRootClear {-# UNPACK #-} !(IORef (DMap k Identity))
1284−
1285−data SomeAssignment x = forall a. SomeAssignment {-# UNPACK #-} !(IORef a) {-# UNPACK #-} !(IORef [Weak (Invalidator x)]) a
1286−
1287−debugFinalize :: Bool
1288−debugFinalize = False
1289−
1290−mkWeakPtrWithDebug :: a -> String -> IO (Weak a)
1291−mkWeakPtrWithDebug x debugNote = do
1292− x' <- evaluate x
1293− mkWeakPtr x' $
1294− if debugFinalize
1295− then Just $ putStrLn $ "finalizing: " ++ debugNote
1296− else Nothing
1297−
1298−type WeakList a = [Weak a]
1299−
1300−{-# INLINE withIncreasedDepth #-}
1301−#ifdef DEBUG
1302−withIncreasedDepth :: CanTrace x m => m a -> m a
1303−withIncreasedDepth a = do
1304− spiderTimeline <- askSpiderTimelineEnv
1305− liftIO $ modifyIORef' (_spiderTimeline_depth spiderTimeline) succ
1306− result <- a
1307− liftIO $ modifyIORef' (_spiderTimeline_depth spiderTimeline) pred
1308− return result
1309−#else
1310−withIncreasedDepth :: m a -> m a
1311−withIncreasedDepth = id
1312−#endif
1313−
1314−type CanTrace x m = (HasSpiderTimeline x, MonadIO m)
1315−
1316−{-# INLINE tracePropagate #-}
1317−tracePropagate :: (CanTrace x m) => proxy x -> String -> m ()
1318−tracePropagate p = traceWhen p debugPropagate
1319−
1320−{-# INLINE traceInvalidate #-}
1321−traceInvalidate :: String -> IO ()
1322−traceInvalidate = when debugInvalidate . liftIO . putStrLn
1323−
1324−{-# INLINE traceWhen #-}
1325−traceWhen :: (CanTrace x m) => proxy x -> Bool -> String -> m ()
1326−traceWhen p b message = traceMWhen p b $ return message
1327−
1328−{-# INLINE traceMWhen #-}
1329−traceMWhen :: (CanTrace x m) => proxy x -> Bool -> m String -> m ()
1330−traceMWhen _ b getMessage = when b $ do
1331− message <- getMessage
1332−#ifdef DEBUG
1333− spiderTimeline <- askSpiderTimelineEnv
1334− d <- liftIO $ readIORef $ _spiderTimeline_depth spiderTimeline
1335−#else
1336− let d = 0
1337−#endif
1338− liftIO $ putStrLn $ replicate d ' ' <> message
1339−
1340−whoCreatedIORef :: IORef a -> IO [String]
1341−whoCreatedIORef (IORef a) = whoCreated $! a
1342−
1343−#ifdef DEBUG_CYCLES
1344−groupByHead :: Eq a => [NonEmpty a] -> [(a, NonEmpty [a])]
1345−groupByHead = \case
1346− [] -> []
1347− (x :| xs) : t -> case groupByHead t of
1348− [] -> [(x, xs :| [])]
1349− l@((y, yss) : t')
1350− | x == y -> (x, xs `NonEmpty.cons` yss) : t'
1351− | otherwise -> (x, xs :| []) : l
1352−
1353−listsToForest :: Eq a => [[a]] -> Forest a
1354−listsToForest l = fmap (\(a, l') -> Node a $ listsToForest $ toList l') $ groupByHead $ catMaybes $ fmap nonEmpty l
1355−#endif
1356−
1357−{-# INLINE propagateSubscriberHold #-}
1358−propagateSubscriberHold :: forall x p. (HasSpiderTimeline x, Patch p) => Hold x p -> p -> EventM x ()
1359−propagateSubscriberHold h a = do
1360− {-# SCC "trace" #-} traceMWhen (Proxy :: Proxy x) debugPropagate $ liftIO $ do
1361− invalidators <- liftIO $ readIORef $ holdInvalidators h
1362− return $ "SubscriberHold" <> showNodeId h <> ": " ++ show (length invalidators)
1363− v <- {-# SCC "read" #-} liftIO $ readIORef $ holdValue h
1364− case {-# SCC "apply" #-} apply a v of
1365− Nothing -> return ()
1366− Just v' -> do
1367− {-# SCC "trace2" #-} withIncreasedDepth $ tracePropagate (Proxy :: Proxy x) $ "propagateSubscriberHold: assigning Hold" <> showNodeId h
1368− vRef <- {-# SCC "vRef" #-} liftIO $ evaluate $ holdValue h
1369− iRef <- {-# SCC "iRef" #-} liftIO $ evaluate $ holdInvalidators h
1370− defer $ {-# SCC "assignment" #-} SomeAssignment vRef iRef v'
1371−
1372−data SomeResetCoincidence x = forall a. SomeResetCoincidence !(EventSubscription x) !(Maybe (CoincidenceSubscribed x a)) -- The CoincidenceSubscriber will be present only if heights need to be reset
1373−
1374−runBehaviorM :: BehaviorM x a -> Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]) -> IORef [SomeHoldInit x] -> IO a
1375−runBehaviorM a mwi holdInits = runReaderT (unBehaviorM a) (mwi, holdInits)
1376−
1377−askInvalidator :: BehaviorM x (Maybe (Weak (Invalidator x)))
1378−askInvalidator = do
1379− (!m, _) <- BehaviorM ask
1380− case m of
1381− Nothing -> return Nothing
1382− Just (!wi, _) -> return $ Just wi
1383−
1384−askParentsRef :: BehaviorM x (Maybe (IORef [SomeBehaviorSubscribed x]))
1385−askParentsRef = do
1386− (!m, _) <- BehaviorM ask
1387− case m of
1388− Nothing -> return Nothing
1389− Just (_, !p) -> return $ Just p
1390−
1391−askBehaviorHoldInits :: BehaviorM x (IORef [SomeHoldInit x])
1392−askBehaviorHoldInits = do
1393− (_, !his) <- BehaviorM ask
1394− return his
1395−
1396−{-# INLINE getDynHold #-}
1397−getDynHold :: (Defer (SomeHoldInit x) m, Patch p) => Dyn x p -> m (Hold x p)
1398−getDynHold d = do
1399− mh <- liftIO $ readIORef $ unDyn d
1400− case mh of
1401− Right h -> return h
1402− Left (readV0, v') -> do
1403− holdInits <- getDeferralQueue
1404− v0 <- liftIO $ runBehaviorM readV0 Nothing holdInits
1405− h <- hold v0 v'
1406− liftIO $ writeIORef (unDyn d) $ Right h
1407− return h
1408−
1409−-- Always refers to 0
1410−{-# NOINLINE zeroRef #-}
1411−zeroRef :: IORef Height
1412−zeroRef = unsafePerformIO $ newIORef zeroHeight
1413−
1414−getRootSubscribed :: GCompare k => k a -> Root x k -> Subscriber x a -> IO (WeakBagTicket, RootSubscribed x a, Maybe a)
1415−getRootSubscribed k r sub = do
1416− mSubscribed <- readIORef $ rootSubscribed r
1417− let getOcc = fmap (coerce . DMap.lookup k) $ readIORef $ rootOccurrence r
1418− case DMap.lookup k mSubscribed of
1419− Just subscribed -> {-# SCC "hitRoot" #-} do
1420− sln <- subscribeRootSubscribed subscribed sub
1421− occ <- getOcc
1422− return (sln, subscribed, occ)
1423− Nothing -> {-# SCC "missRoot" #-} do
1424− weakSelf <- newIORef $ error "getRootSubscribed: weakSelfRef not initialized"
1425− let !cached = rootSubscribed r
1426− uninitRef <- newIORef $ error "getRootsubscribed: uninitRef not initialized"
1427− (subs, sln) <- WeakBag.singleton sub weakSelf cleanupRootSubscribed
1428− when debugPropagate $ putStrLn $ "getRootSubscribed: calling rootInit"
1429− uninit <- rootInit r k $ RootTrigger (subs, rootOccurrence r, k)
1430− writeIORef uninitRef $! uninit
1431− let !subscribed = RootSubscribed
1432− { rootSubscribedKey = k
1433− , rootSubscribedCachedSubscribed = cached
1434− , rootSubscribedOccurrence = getOcc
1435− , rootSubscribedSubscribers = subs
1436− , rootSubscribedUninit = uninit
1437− , rootSubscribedWeakSelf = weakSelf
1438−#ifdef DEBUG_NODEIDS
1439− , rootSubscribedNodeId = unsafeNodeId (k, r, subs)
1440−#endif
1441− }
1442− -- If we die at the same moment that all our children die, they will
1443− -- try to clean us up but will fail because their Weak reference to us
1444− -- will also be dead. So, if we are dying, check if there are any
1445− -- children; since children don't bother cleaning themselves up if
1446− -- their parents are already dead, I don't think there's a race
1447− -- condition here. However, if there are any children, then we can
1448− -- infer that we need to clean ourselves up, so we do.
1449− finalCleanup = do
1450− cs <- readIORef $ _weakBag_children subs
1451− when (not $ IntMap.null cs) (cleanupRootSubscribed subscribed)
1452− writeIORef weakSelf =<< evaluate =<< mkWeakPtr subscribed (Just finalCleanup)
1453− 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
1454− occ <- getOcc
1455− return (sln, subscribed, occ)
1456−
1457−#ifdef USE_TEMPLATE_HASKELL
1458−{-# ANN cleanupRootSubscribed "HLint: ignore Redundant bracket" #-}
1459−#endif
1460−cleanupRootSubscribed :: RootSubscribed x a -> IO ()
1461−cleanupRootSubscribed self@RootSubscribed { rootSubscribedKey = k, rootSubscribedCachedSubscribed = cached } = do
1462− rootSubscribedUninit self
1463− modifyIORef' cached $ DMap.delete k
1464−
1465−{-# INLINE subscribeRootSubscribed #-}
1466−subscribeRootSubscribed :: RootSubscribed x a -> Subscriber x a -> IO WeakBagTicket
1467−subscribeRootSubscribed subscribed sub = WeakBag.insert sub (rootSubscribedSubscribers subscribed) (rootSubscribedWeakSelf subscribed) cleanupRootSubscribed
1468−
1469−newtype EventSelectorInt x a = EventSelectorInt { selectInt :: Int -> Event x a }
1470−
1471−data FanInt x a = FanInt
1472− { _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
1473− , _fanInt_subscriptionRef :: {-# UNPACK #-} !(IORef (EventSubscription x)) -- This should have a valid subscription iff subscribers is non-empty
1474− , _fanInt_occRef :: {-# UNPACK #-} !(IORef (IntMap a))
1475− }
1476−
1477−newFanInt :: IO (FanInt x a)
1478−newFanInt = do
1479− 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
1480− subscriptionRef <- newIORef $ error "fanInt: no subscription"
1481− occRef <- newIORef $ error "fanInt: no occurrence"
1482− return $ FanInt
1483− { _fanInt_subscribers = subscribers
1484− , _fanInt_subscriptionRef = subscriptionRef
1485− , _fanInt_occRef = occRef
1486− }
1487−
1488−{-# NOINLINE unsafeNewFanInt #-}
1489−unsafeNewFanInt :: b -> FanInt x a
1490−unsafeNewFanInt b = unsafePerformIO $ do
1491− touch b
1492− newFanInt
1493−
1494−fanInt :: HasSpiderTimeline x => Event x (IntMap a) -> EventSelectorInt x a
1495−fanInt p =
1496− let self = unsafeNewFanInt p
1497− in EventSelectorInt $ \k -> Event $ \sub -> do
1498− isEmpty <- liftIO $ FastMutableIntMap.isEmpty (_fanInt_subscribers self)
1499− when isEmpty $ do -- This is the first subscriber, so we need to subscribe to our input
1500− (subscription, parentOcc) <- subscribeAndRead p $ Subscriber
1501− { subscriberPropagate = \m -> do
1502− liftIO $ writeIORef (_fanInt_occRef self) m
1503− scheduleIntClear $ _fanInt_occRef self
1504− FastMutableIntMap.forIntersectionWithImmutable_ (_fanInt_subscribers self) m $ \b v -> do --TODO: Do we need to know that no subscribers are being added as we traverse?
1505− FastWeakBag.traverse b $ \s -> do
1506− subscriberPropagate s v
1507− , subscriberInvalidateHeight = \old -> do
1508− FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b -> do
1509− FastWeakBag.traverse b $ \s -> do
1510− subscriberInvalidateHeight s old
1511− , subscriberRecalculateHeight = \new -> do
1512− FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b -> do
1513− FastWeakBag.traverse b $ \s -> do
1514− subscriberRecalculateHeight s new
1515− }
1516− liftIO $ do
1517− writeIORef (_fanInt_subscriptionRef self) subscription
1518− writeIORef (_fanInt_occRef self) $ fromMaybe IntMap.empty parentOcc
1519− scheduleIntClear $ _fanInt_occRef self
1520− liftIO $ do
1521− b <- FastMutableIntMap.lookup (_fanInt_subscribers self) k >>= \case
1522− Nothing -> do
1523− b <- FastWeakBag.empty
1524− FastMutableIntMap.insert (_fanInt_subscribers self) k b
1525− return b
1526− Just b -> return b
1527− t <- liftIO $ FastWeakBag.insert sub b
1528− currentOcc <- readIORef (_fanInt_occRef self)
1529− (EventSubscription _ (EventSubscribed !heightRef _)) <- readIORef (_fanInt_subscriptionRef self)
1530− return (EventSubscription (FastWeakBag.remove t) $! EventSubscribed heightRef $! toAny (_fanInt_subscriptionRef self, t), IntMap.lookup k currentOcc)
1531−
1532−{-# INLINABLE getFanSubscribed #-}
1533−getFanSubscribed :: (HasSpiderTimeline x, GCompare k) => k a -> Fan x k -> Subscriber x a -> EventM x (WeakBagTicket, FanSubscribed x k, Maybe a)
1534−getFanSubscribed k f sub = do
1535− mSubscribed <- liftIO $ readIORef $ fanSubscribed f
1536− case mSubscribed of
1537− Just subscribed -> {-# SCC "hitFan" #-} liftIO $ do
1538− sln <- subscribeFanSubscribed k subscribed sub
1539− occ <- readIORef $ fanSubscribedOccurrence subscribed
1540− return (sln, subscribed, coerce $ DMap.lookup k =<< occ)
1541− Nothing -> {-# SCC "missFan" #-} do
1542− subscribedRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribedRef not yet initialized"
1543− subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1544− s <- liftIO $ newSubscriberFan subscribedUnsafe
1545− (subscription, parentOcc) <- subscribeAndRead (fanParent f) s
1546− weakSelf <- liftIO $ newIORef $ error "getFanSubscribed: weakSelf not yet initialized"
1547− (subsForK, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupFanSubscribed
1548− subscribersRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribersRef not yet initialized"
1549− occRef <- liftIO $ newIORef parentOcc
1550− when (isJust parentOcc) $ scheduleClear occRef
1551− let subscribed = FanSubscribed
1552− { fanSubscribedCachedSubscribed = fanSubscribed f
1553− , fanSubscribedOccurrence = occRef
1554− , fanSubscribedParent = subscription
1555− , fanSubscribedSubscribers = subscribersRef
1556−#ifdef DEBUG_NODEIDS
1557− , fanSubscribedNodeId = unsafeNodeId f
1558−#endif
1559− }
1560− let !self = (k, subscribed)
1561− liftIO $ writeIORef subscribersRef $! DMap.singleton k $ FanSubscribedChildren subsForK self weakSelf
1562− liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug self "FanSubscribed"
1563− liftIO $ writeIORef subscribedRef $! subscribed
1564− liftIO $ writeIORef (fanSubscribed f) $ Just subscribed
1565− return (slnForSub, subscribed, coerce $ DMap.lookup k =<< parentOcc)
1566−
1567−cleanupFanSubscribed :: GCompare k => (k a, FanSubscribed x k) -> IO ()
1568−cleanupFanSubscribed (k, subscribed) = do
1569− subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1570− let reducedSubscribers = DMap.delete k subscribers
1571− if DMap.null reducedSubscribers
1572− then do
1573− unsubscribe $ fanSubscribedParent subscribed
1574− -- Not necessary in this case, because this whole FanSubscribed is dead: writeIORef (fanSubscribedSubscribers subscribed) reducedSubscribers
1575− writeIORef (fanSubscribedCachedSubscribed subscribed) Nothing
1576− else writeIORef (fanSubscribedSubscribers subscribed) $! reducedSubscribers
1577−
1578−{-# INLINE subscribeFanSubscribed #-}
1579−subscribeFanSubscribed :: GCompare k => k a -> FanSubscribed x k -> Subscriber x a -> IO WeakBagTicket
1580−subscribeFanSubscribed k subscribed sub = do
1581− subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1582− case DMap.lookup k subscribers of
1583− Nothing -> {-# SCC "missSubscribeFanSubscribed" #-} do
1584− let !self = (k, subscribed)
1585− weakSelf <- newIORef =<< mkWeakPtrWithDebug self "FanSubscribed"
1586− (list, sln) <- WeakBag.singleton sub weakSelf cleanupFanSubscribed
1587− 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
1588− return sln
1589− Just (FanSubscribedChildren list _ weakSelf) -> {-# SCC "hitSubscribeFanSubscribed" #-} WeakBag.insert sub list weakSelf cleanupFanSubscribed
1590−
1591−{-# INLINABLE getSwitchSubscribed #-}
1592−getSwitchSubscribed :: HasSpiderTimeline x => Switch x a -> Subscriber x a -> EventM x (WeakBagTicket, SwitchSubscribed x a, Maybe a)
1593−getSwitchSubscribed s sub = do
1594− mSubscribed <- liftIO $ readIORef $ switchSubscribed s
1595− case mSubscribed of
1596− Just subscribed -> {-# SCC "hitSwitch" #-} liftIO $ do
1597− sln <- subscribeSwitchSubscribed subscribed sub
1598− occ <- readIORef $ switchSubscribedOccurrence subscribed
1599− return (sln, subscribed, occ)
1600− Nothing -> {-# SCC "missSwitch" #-} do
1601− subscribedRef <- liftIO $ newIORef $ error "getSwitchSubscribed: subscribed has not yet been created"
1602− subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1603− i <- liftIO $ newInvalidatorSwitch subscribedUnsafe
1604− mySub <- liftIO $ newSubscriberSwitch subscribedUnsafe
1605− wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorSwitch"
1606− wiRef <- liftIO $ newIORef wi
1607− parentsRef <- liftIO $ newIORef [] --TODO: This should be unnecessary, because it will always be filled with just the single parent behavior
1608− holdInits <- getDeferralQueue
1609− e <- liftIO $ runBehaviorM (readBehaviorTracked (switchParent s)) (Just (wi, parentsRef)) holdInits
1610− (subscription@(EventSubscription _ subd), parentOcc) <- subscribeAndRead e mySub
1611− heightRef <- liftIO $ newIORef =<< getEventSubscribedHeight subd
1612− subscriptionRef <- liftIO $ newIORef subscription
1613− occRef <- liftIO $ newIORef parentOcc
1614− when (isJust parentOcc) $ scheduleClear occRef
1615− weakSelf <- liftIO $ newIORef $ error "getSwitchSubscribed: weakSelf not yet initialized"
1616− (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupSwitchSubscribed
1617− let !subscribed = SwitchSubscribed
1618− { switchSubscribedCachedSubscribed = switchSubscribed s
1619− , switchSubscribedOccurrence = occRef
1620− , switchSubscribedHeight = heightRef
1621− , switchSubscribedSubscribers = subs
1622− , switchSubscribedOwnInvalidator = i
1623− , switchSubscribedOwnWeakInvalidator = wiRef
1624− , switchSubscribedBehaviorParents = parentsRef
1625− , switchSubscribedParent = switchParent s
1626− , switchSubscribedCurrentParent = subscriptionRef
1627− , switchSubscribedWeakSelf = weakSelf
1628−#ifdef DEBUG_NODEIDS
1629− , switchSubscribedNodeId = unsafeNodeId s
1630−#endif
1631− }
1632− liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "switchSubscribedWeakSelf"
1633− liftIO $ writeIORef subscribedRef $! subscribed
1634− liftIO $ writeIORef (switchSubscribed s) $ Just subscribed
1635− return (slnForSub, subscribed, parentOcc)
1636−
1637−cleanupSwitchSubscribed :: SwitchSubscribed x a -> IO ()
1638−cleanupSwitchSubscribed subscribed = do
1639− unsubscribe =<< readIORef (switchSubscribedCurrentParent subscribed)
1640− finalize =<< readIORef (switchSubscribedOwnWeakInvalidator subscribed) -- We don't need to get invalidated if we're dead
1641− writeIORef (switchSubscribedCachedSubscribed subscribed) Nothing
1642−
1643−{-# INLINE subscribeSwitchSubscribed #-}
1644−subscribeSwitchSubscribed :: SwitchSubscribed x a -> Subscriber x a -> IO WeakBagTicket
1645−subscribeSwitchSubscribed subscribed sub = WeakBag.insert sub (switchSubscribedSubscribers subscribed) (switchSubscribedWeakSelf subscribed) cleanupSwitchSubscribed
1646−
1647−{-# INLINABLE getCoincidenceSubscribed #-}
1648−getCoincidenceSubscribed :: forall x a. HasSpiderTimeline x => Coincidence x a -> Subscriber x a -> EventM x (WeakBagTicket, CoincidenceSubscribed x a, Maybe a)
1649−getCoincidenceSubscribed c sub = do
1650− mSubscribed <- liftIO $ readIORef $ coincidenceSubscribed c
1651− case mSubscribed of
1652− Just subscribed -> {-# SCC "hitCoincidence" #-} liftIO $ do
1653− sln <- subscribeCoincidenceSubscribed subscribed sub
1654− occ <- readIORef $ coincidenceSubscribedOccurrence subscribed
1655− return (sln, subscribed, occ)
1656− Nothing -> {-# SCC "missCoincidence" #-} do
1657− subscribedRef <- liftIO $ newIORef $ error "getCoincidenceSubscribed: subscribed has not yet been created"
1658− subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1659− subOuter <- liftIO $ newSubscriberCoincidenceOuter subscribedUnsafe
1660− (outerSubscription@(EventSubscription _ outerSubd), outerOcc) <- subscribeAndRead (coincidenceParent c) subOuter
1661− outerHeight <- liftIO $ getEventSubscribedHeight outerSubd
1662− (occ, height, mInnerSubd) <- case outerOcc of
1663− Nothing -> return (Nothing, outerHeight, Nothing)
1664− Just o -> do
1665− (occ, height, innerSubd) <- subscribeCoincidenceInner o outerHeight subscribedUnsafe
1666− return (occ, height, Just innerSubd)
1667− occRef <- liftIO $ newIORef occ
1668− when (isJust occ) $ scheduleClear occRef
1669− heightRef <- liftIO $ newIORef height
1670− innerSubdRef <- liftIO $ newIORef mInnerSubd
1671− scheduleClear innerSubdRef
1672− weakSelf <- liftIO $ newIORef $ error "getCoincidenceSubscribed: weakSelf not yet implemented"
1673− (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupCoincidenceSubscribed
1674− let subscribed = CoincidenceSubscribed
1675− { coincidenceSubscribedCachedSubscribed = coincidenceSubscribed c
1676− , coincidenceSubscribedOccurrence = occRef
1677− , coincidenceSubscribedHeight = heightRef
1678− , coincidenceSubscribedSubscribers = subs
1679− , coincidenceSubscribedOuter = subOuter
1680− , coincidenceSubscribedOuterParent = outerSubscription
1681− , coincidenceSubscribedInnerParent = innerSubdRef
1682− , coincidenceSubscribedWeakSelf = weakSelf
1683−#ifdef DEBUG_NODEIDS
1684− , coincidenceSubscribedNodeId = unsafeNodeId c
1685−#endif
1686− }
1687− liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "CoincidenceSubscribed"
1688− liftIO $ writeIORef subscribedRef $! subscribed
1689− liftIO $ writeIORef (coincidenceSubscribed c) $ Just subscribed
1690− return (slnForSub, subscribed, occ)
1691−
1692−cleanupCoincidenceSubscribed :: CoincidenceSubscribed x a -> IO ()
1693−cleanupCoincidenceSubscribed subscribed = do
1694− unsubscribe $ coincidenceSubscribedOuterParent subscribed
1695− writeIORef (coincidenceSubscribedCachedSubscribed subscribed) Nothing
1696−
1697−{-# INLINE subscribeCoincidenceSubscribed #-}
1698−subscribeCoincidenceSubscribed :: CoincidenceSubscribed x a -> Subscriber x a -> IO WeakBagTicket
1699−subscribeCoincidenceSubscribed subscribed sub = WeakBag.insert sub (coincidenceSubscribedSubscribers subscribed) (coincidenceSubscribedWeakSelf subscribed) cleanupCoincidenceSubscribed
1700−
1701−{-# INLINE merge #-}
1702−merge :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMap k (Event x)) -> Event x (DMap k Identity)
1703−merge d = cacheEvent (mergeCheap d)
1704−
1705−{-# INLINE mergeWithMove #-}
1706−mergeWithMove :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMapWithMove k (Event x)) -> Event x (DMap k Identity)
1707−mergeWithMove d = cacheEvent (mergeCheapWithMove d)
1708−
1709−{-# INLINE [1] mergeCheap #-}
1710−mergeCheap :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMap k (Event x)) -> Event x (DMap k Identity)
1711−mergeCheap = mergeCheap' getInitialSubscribers updateMe destroy
1712− where
1713− updateMe :: MergeUpdateFunc k x (PatchDMap k (Event x)) (MergeSubscribedParent x)
1714− updateMe subscriber heightBagRef oldParents (PatchDMap p) = do
1715− let f (subscriptionsToKill, ps) (k :=> ComposeMaybe me) = do
1716− (mOldSubd, newPs) <- case me of
1717− Nothing -> return $ DMap.updateLookupWithKey (\_ _ -> Nothing) k ps
1718− Just e -> do
1719− let s = subscriber $ return k
1720− subscription@(EventSubscription _ subd) <- subscribe e s
1721− newParentHeight <- liftIO $ getEventSubscribedHeight subd
1722− let newParent = MergeSubscribedParent subscription
1723− liftIO $ modifyIORef' heightBagRef $ heightBagAdd newParentHeight
1724− return $ DMap.insertLookupWithKey' (\_ new _ -> new) k newParent ps
1725− forM_ mOldSubd $ \oldSubd -> do
1726− oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $ unMergeSubscribedParent oldSubd
1727− liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
1728− return (maybeToList (unMergeSubscribedParent <$> mOldSubd) ++ subscriptionsToKill, newPs)
1729− foldM f ([], oldParents) $ DMap.toList p
1730− getInitialSubscribers :: MergeInitFunc k x (MergeSubscribedParent x)
1731− getInitialSubscribers initialParents subscriber = do
1732− subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
1733− let s = subscriber $ return k
1734− (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead e s
1735− height <- liftIO $ getEventSubscribedHeight parentSubd
1736− return (fmap (\x -> k :=> Identity x) parentOcc, height, k :=> MergeSubscribedParent subscription)
1737− return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
1738− , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
1739− , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
1740− )
1741− destroy :: MergeDestroyFunc k (MergeSubscribedParent x)
1742− destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParent sub) -> unsubscribe sub
1743−
1744−{-# INLINE [1] mergeCheapWithMove #-}
1745−mergeCheapWithMove :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMapWithMove k (Event x)) -> Event x (DMap k Identity)
1746−mergeCheapWithMove = mergeCheap' getInitialSubscribers updateMe destroy
1747− where
1748− updateMe :: MergeUpdateFunc k x (PatchDMapWithMove k (Event x)) (MergeSubscribedParentWithMove x k)
1749− updateMe subscriber heightBagRef oldParents p = do
1750− -- Prepare new parents for insertion
1751− let subscribeParent :: forall a. k a -> Event x a -> EventM x (MergeSubscribedParentWithMove x k a)
1752− subscribeParent k e = do
1753− keyRef <- liftIO $ newIORef k
1754− let s = subscriber $ liftIO $ readIORef keyRef
1755− subscription@(EventSubscription _ subd) <- subscribe e s
1756− liftIO $ do
1757− newParentHeight <- getEventSubscribedHeight subd
1758− modifyIORef' heightBagRef $ heightBagAdd newParentHeight
1759− return $ MergeSubscribedParentWithMove subscription keyRef
1760− p' <- PatchDMapWithMove.traversePatchDMapWithMoveWithKey subscribeParent p
1761− -- Collect old parents for deletion and update the keys of moved parents
1762− let moveOrDelete :: forall a. k a -> PatchDMapWithMove.NodeInfo k (Event x) a -> MergeSubscribedParentWithMove x k a -> Constant (EventM x (Maybe (EventSubscription x))) a
1763− moveOrDelete _ ni parent = Constant $ case getComposeMaybe $ PatchDMapWithMove._nodeInfo_to ni of
1764− Nothing -> do
1765− oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $ _mergeSubscribedParentWithMove_subscription parent
1766− liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
1767− return $ Just $ _mergeSubscribedParentWithMove_subscription parent
1768− Just toKey -> do
1769− liftIO $ writeIORef (_mergeSubscribedParentWithMove_key parent) $! toKey
1770− return Nothing
1771− toDelete <- fmap catMaybes $ mapM (\(_ :=> v) -> getConstant v) $ DMap.toList $ DMap.intersectionWithKey moveOrDelete (unPatchDMapWithMove p) oldParents
1772− return (toDelete, applyAlways p' oldParents)
1773− getInitialSubscribers :: MergeInitFunc k x (MergeSubscribedParentWithMove x k)
1774− getInitialSubscribers initialParents subscriber = do
1775− subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
1776− keyRef <- liftIO $ newIORef k
1777− let s = subscriber $ liftIO $ readIORef keyRef
1778− (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead e s
1779− height <- liftIO $ getEventSubscribedHeight parentSubd
1780− return (fmap (\x -> k :=> Identity x) parentOcc, height, k :=> MergeSubscribedParentWithMove subscription keyRef)
1781− return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
1782− , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
1783− , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
1784− )
1785− destroy :: MergeDestroyFunc k (MergeSubscribedParentWithMove x k)
1786− destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParentWithMove sub _) -> unsubscribe sub
1787−
1788−type MergeUpdateFunc k x p s
1789− = (forall a. EventM x (k a) -> Subscriber x a)
1790− -> IORef HeightBag
1791− -> DMap k s
1792− -> p
1793− -> EventM x ([EventSubscription x], DMap k s)
1794−
1795−type MergeInitFunc k x s
1796− = DMap k (Event x)
1797− -> (forall a. EventM x (k a) -> Subscriber x a)
1798− -> EventM x (DMap k Identity, [Height], DMap k s)
1799−
1800−type MergeDestroyFunc k s
1801− = DMap k s
1802− -> IO ()
1803−
1804−data Merge x k s = Merge
1805− { _merge_parentsRef :: {-# UNPACK #-} !(IORef (DMap k s))
1806− , _merge_heightBagRef :: {-# UNPACK #-} !(IORef HeightBag)
1807− , _merge_heightRef :: {-# UNPACK #-} !(IORef Height)
1808− , _merge_sub :: {-# UNPACK #-} !(Subscriber x (DMap k Identity))
1809− , _merge_accumRef :: {-# UNPACK #-} !(IORef (DMap k Identity))
1810− }
1811−
1812−invalidateMergeHeight :: Merge x k s -> IO ()
1813−invalidateMergeHeight m = invalidateMergeHeight' (_merge_heightRef m) (_merge_sub m)
1814−
1815−invalidateMergeHeight' :: IORef Height -> Subscriber x a -> IO ()
1816−invalidateMergeHeight' heightRef sub = do
1817− oldHeight <- readIORef heightRef
1818− when (oldHeight /= invalidHeight) $ do -- If the height used to be valid, it must be invalid now; we should never have *more* heights than we have parents
1819− writeIORef heightRef $! invalidHeight
1820− subscriberInvalidateHeight sub oldHeight
1821−
1822−
1823−revalidateMergeHeight :: Merge x k s -> IO ()
1824−revalidateMergeHeight m = do
1825− currentHeight <- readIORef $ _merge_heightRef m
1826− when (currentHeight == invalidHeight) $ do -- revalidateMergeHeight may be called multiple times; perhaps the's a way to finesse it to avoid this check
1827− heights <- readIORef $ _merge_heightBagRef m
1828− parents <- readIORef $ _merge_parentsRef m
1829− -- When the number of heights in the bag reaches the number of parents, we should have a valid height
1830− case heightBagSize heights `compare` DMap.size parents of
1831− LT -> return ()
1832− EQ -> do
1833− let height = succHeight $ heightBagMax heights
1834− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
1835− writeIORef (_merge_heightRef m) $! height
1836− subscriberRecalculateHeight (_merge_sub m) height
1837− GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show (DMap.size parents) <> ") for Merge"
1838−
1839−scheduleMergeSelf :: HasSpiderTimeline x => Merge x k s -> Height -> EventM x ()
1840−scheduleMergeSelf m height = scheduleMerge' height (_merge_heightRef m) $ do
1841− vals <- liftIO $ readIORef $ _merge_accumRef m
1842− liftIO $ writeIORef (_merge_accumRef m) $! DMap.empty -- Once we're done with this, we can clear it immediately, because if there's a cacheEvent in front of us, it'll handle subsequent subscribers, and if not, we won't get subsequent subscribers
1843− --TODO: Assert that m is not empty
1844− subscriberPropagate (_merge_sub m) vals
1845−
1846−mergeSubscriber :: forall x k s a. (HasSpiderTimeline x, GCompare k) => Merge x k s -> EventM x (k a) -> Subscriber x a
1847−mergeSubscriber m getKey = Subscriber
1848− { subscriberPropagate = \a -> do
1849− oldM <- liftIO $ readIORef $ _merge_accumRef m
1850− k <- getKey
1851− let newM = DMap.insertWith (error $ "Same key fired multiple times for Merge") k (Identity a) oldM
1852− tracePropagate (Proxy :: Proxy x) $ " DMap.size oldM = " <> show (DMap.size oldM) <> "; DMap.size newM = " <> show (DMap.size newM)
1853− liftIO $ writeIORef (_merge_accumRef m) $! newM
1854− when (DMap.null oldM) $ do -- Only schedule the firing once
1855− height <- liftIO $ readIORef $ _merge_heightRef m
1856− --TODO: assertions about height
1857− currentHeight <- getCurrentHeight
1858− when (height <= currentHeight) $ do
1859− if height /= invalidHeight
1860− then do
1861− myStack <- liftIO $ whoCreatedIORef undefined --TODO
1862− error $ "Height (" ++ show height ++ ") is not greater than current height (" ++ show currentHeight ++ ")\n" ++ unlines (reverse myStack)
1863− else liftIO $ do
1864−#ifdef DEBUG_CYCLES
1865− nodesInvolvedInCycle <- walkInvalidHeightParents $ eventSubscribedMerge subscribed
1866− stacks <- forM nodesInvolvedInCycle $ \(Some.This es) -> whoCreatedEventSubscribed es
1867− let cycleInfo = ":\n" <> drawForest (listsToForest stacks)
1868−#else
1869− let cycleInfo = ""
1870−#endif
1871− error $ "Causality loop found" <> cycleInfo
1872− scheduleMergeSelf m height
1873− , subscriberInvalidateHeight = \old -> do --TODO: When removing a parent doesn't actually change the height, maybe we can avoid invalidating
1874− modifyIORef' (_merge_heightBagRef m) $ heightBagRemove old
1875− invalidateMergeHeight m
1876− , subscriberRecalculateHeight = \new -> do
1877− modifyIORef' (_merge_heightBagRef m) $ heightBagAdd new
1878− revalidateMergeHeight m
1879− }
1880−
1881−--TODO: Be able to run as much of this as possible promptly
1882−updateMerge :: (HasSpiderTimeline x, GCompare k) => Merge x k s -> MergeUpdateFunc k x p s -> p -> SomeMergeUpdate x
1883−updateMerge m updateFunc p = SomeMergeUpdate updateMe (invalidateMergeHeight m) (revalidateMergeHeight m)
1884− where updateMe = do
1885− oldParents <- liftIO $ readIORef $ _merge_parentsRef m
1886− (subscriptionsToKill, newParents) <- updateFunc (mergeSubscriber m) (_merge_heightBagRef m) oldParents p
1887− liftIO $ writeIORef (_merge_parentsRef m) $! newParents
1888− return subscriptionsToKill
1889−
1890−{-# INLINE mergeCheap' #-}
1891−mergeCheap' :: forall k x p s. (HasSpiderTimeline x, GCompare k, PatchTarget p ~ DMap k (Event x)) => MergeInitFunc k x s -> MergeUpdateFunc k x p s -> MergeDestroyFunc k s -> Dynamic x p -> Event x (DMap k Identity)
1892−mergeCheap' getInitialSubscribers updateFunc destroy d = Event $ \sub -> do
1893− initialParents <- readBehaviorUntracked $ dynamicCurrent d
1894− accumRef <- liftIO $ newIORef $ error "merge: accumRef not yet initialized"
1895− heightRef <- liftIO $ newIORef $ error "merge: heightRef not yet initialized"
1896− heightBagRef <- liftIO $ newIORef $ error "merge: heightBagRef not yet initialized"
1897− parentsRef :: IORef (DMap k s) <- liftIO $ newIORef $ error "merge: parentsRef not yet initialized"
1898− let m = Merge
1899− { _merge_parentsRef = parentsRef
1900− , _merge_heightBagRef = heightBagRef
1901− , _merge_heightRef = heightRef
1902− , _merge_sub = sub
1903− , _merge_accumRef = accumRef
1904− }
1905− (dm, heights, initialParentState) <- getInitialSubscribers initialParents $ mergeSubscriber m
1906− let myHeightBag = heightBagFromList $ filter (/= invalidHeight) heights
1907− myHeight = if invalidHeight `elem` heights
1908− then invalidHeight
1909− else succHeight $ heightBagMax myHeightBag
1910− currentHeight <- getCurrentHeight
1911− let (occ, accum) = if currentHeight >= myHeight -- If we should have fired by now
1912− then (if DMap.null dm then Nothing else Just dm, DMap.empty)
1913− else (Nothing, dm)
1914− unless (DMap.null accum) $ do
1915− scheduleMergeSelf m myHeight
1916− liftIO $ writeIORef accumRef $! accum
1917− liftIO $ writeIORef heightRef $! myHeight
1918− liftIO $ writeIORef heightBagRef $! myHeightBag
1919− changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
1920− liftIO $ writeIORef parentsRef $! initialParentState
1921− defer $ SomeMergeInit $ do
1922− let s = Subscriber
1923− { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
1924− tracePropagate (Proxy :: Proxy x) $ "SubscriberMerge/Change"
1925− defer $ updateMerge m updateFunc a
1926− , subscriberInvalidateHeight = \_ -> return ()
1927− , subscriberRecalculateHeight = \_ -> return ()
1928− }
1929− (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) s
1930− forM_ change $ \c -> defer $ updateMerge m updateFunc c
1931− -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
1932− -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
1933− -- its subscription.
1934− liftIO $ writeIORef changeSubdRef (s, changeSubscription)
1935− let unsubscribeAll = destroy =<< readIORef parentsRef
1936− return ( EventSubscription unsubscribeAll $ EventSubscribed heightRef $ toAny (parentsRef, changeSubdRef)
1937− , occ
1938− )
1939−
1940−mergeInt :: forall x a. (HasSpiderTimeline x) => Dynamic x (PatchIntMap (Event x a)) -> Event x (IntMap a)
1941−mergeInt = cacheEvent . mergeIntCheap
1942−
1943−{-# INLINABLE mergeIntCheap #-}
1944−mergeIntCheap :: forall x a. (HasSpiderTimeline x) => Dynamic x (PatchIntMap (Event x a)) -> Event x (IntMap a)
1945−mergeIntCheap d = Event $ \sub -> do
1946− initialParents <- readBehaviorUntracked $ dynamicCurrent d
1947− accum <- liftIO $ FastMutableIntMap.newEmpty
1948− heightRef <- liftIO $ newIORef zeroHeight
1949− heightBagRef <- liftIO $ newIORef heightBagEmpty
1950− parents <- liftIO $ FastMutableIntMap.newEmpty
1951− let scheduleSelf = do
1952− height <- liftIO $ readIORef $ heightRef
1953− scheduleMerge' height heightRef $ do
1954− vals <- liftIO $ FastMutableIntMap.getFrozenAndClear accum
1955− subscriberPropagate sub vals
1956− invalidateMyHeight = do
1957− invalidateMergeHeight' heightRef sub
1958− recalculateMyHeight = do
1959− currentHeight <- readIORef heightRef
1960− 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?
1961− heights <- readIORef heightBagRef
1962− numParents <- FastMutableIntMap.size parents
1963− case heightBagSize heights `compare` numParents of
1964− LT -> return ()
1965− EQ -> do
1966− let height = succHeight $ heightBagMax heights
1967− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
1968− writeIORef heightRef $! height
1969− subscriberRecalculateHeight sub height
1970− GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show numParents <> ") for Merge"
1971− mySubscriber k = Subscriber
1972− { subscriberPropagate = \a -> do
1973− wasEmpty <- liftIO $ FastMutableIntMap.isEmpty accum
1974− liftIO $ FastMutableIntMap.insert accum k a
1975− when wasEmpty scheduleSelf
1976− , subscriberInvalidateHeight = \old -> do
1977− modifyIORef' heightBagRef $ heightBagRemove old
1978− invalidateMyHeight
1979− , subscriberRecalculateHeight = \new -> do
1980− modifyIORef' heightBagRef $ heightBagAdd new
1981− recalculateMyHeight
1982− }
1983− forM_ (IntMap.toList initialParents) $ \(k, p) -> do
1984− (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead p $ mySubscriber k
1985− liftIO $ do
1986− forM_ parentOcc $ FastMutableIntMap.insert accum k
1987− FastMutableIntMap.insert parents k subscription
1988− height <- getEventSubscribedHeight parentSubd
1989− if height == invalidHeight
1990− then writeIORef heightRef invalidHeight
1991− else do
1992− modifyIORef' heightBagRef $ heightBagAdd height
1993− modifyIORef' heightRef $ \oldHeight ->
1994− if oldHeight == invalidHeight
1995− then invalidHeight
1996− else max (succHeight height) oldHeight
1997− myHeight <- liftIO $ readIORef heightRef
1998− currentHeight <- getCurrentHeight
1999− isEmpty <- liftIO $ FastMutableIntMap.isEmpty accum
2000− occ <- if currentHeight >= myHeight -- If we should have fired by now
2001− then if isEmpty
2002− then return Nothing
2003− else liftIO $ Just <$> FastMutableIntMap.getFrozenAndClear accum
2004− else do when (not isEmpty) scheduleSelf -- We have things accumulated, but we shouldn't have fired them yet
2005− return Nothing
2006− changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
2007− defer $ SomeMergeInit $ do
2008− let updateMe a = SomeMergeUpdate u invalidateMyHeight recalculateMyHeight
2009− where
2010− u = do
2011− let f k newParent = do
2012− subscription@(EventSubscription _ subd) <- subscribe newParent $ mySubscriber k
2013− newParentHeight <- liftIO $ getEventSubscribedHeight subd
2014− liftIO $ modifyIORef' heightBagRef $ heightBagAdd newParentHeight
2015− return subscription
2016− newSubscriptions <- FastMutableIntMap.traverseIntMapPatchWithKey f a
2017− oldParents <- liftIO $ FastMutableIntMap.applyPatch parents newSubscriptions
2018− liftIO $ for_ oldParents $ \oldParent -> do
2019− oldParentHeight <- getEventSubscribedHeight $ _eventSubscription_subscribed oldParent
2020− modifyIORef' heightBagRef $ heightBagRemove oldParentHeight
2021− return $ IntMap.elems oldParents
2022− let s = Subscriber
2023− { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
2024− tracePropagate (Proxy :: Proxy x) $ "SubscriberMergeInt/Change"
2025− defer $ updateMe a
2026− , subscriberInvalidateHeight = \_ -> return ()
2027− , subscriberRecalculateHeight = \_ -> return ()
2028− }
2029− (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) s
2030− forM_ change $ \c -> defer $ updateMe c
2031− -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
2032− -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
2033− -- its subscription.
2034− liftIO $ writeIORef changeSubdRef (s, changeSubscription)
2035− let unsubscribeAll = traverse_ unsubscribe =<< FastMutableIntMap.getFrozenAndClear parents
2036− return ( EventSubscription unsubscribeAll $ EventSubscribed heightRef $ toAny (parents, changeSubdRef)
2037− , occ
2038− )
2039−
2040−newtype EventSelector x k = EventSelector { select :: forall a. k a -> Event x a }
2041−
2042−fan :: (HasSpiderTimeline x, GCompare k) => Event x (DMap k Identity) -> EventSelector x k
2043−fan e =
2044− let f = Fan
2045− { fanParent = e
2046− , fanSubscribed = unsafeNewIORef e Nothing
2047− }
2048− in EventSelector $ \k -> eventFan k f
2049−
2050−runHoldInits :: HasSpiderTimeline x => IORef [SomeHoldInit x] -> IORef [SomeDynInit x] -> IORef [SomeMergeInit x] -> EventM x ()
2051−runHoldInits holdInitRef dynInitRef mergeInitRef = do
2052− holdInits <- liftIO $ readIORef holdInitRef
2053− dynInits <- liftIO $ readIORef dynInitRef
2054− mergeInits <- liftIO $ readIORef mergeInitRef
2055− unless (null holdInits && null dynInits && null mergeInits) $ do
2056− liftIO $ writeIORef holdInitRef []
2057− liftIO $ writeIORef dynInitRef []
2058− liftIO $ writeIORef mergeInitRef []
2059− mapM_ initHold holdInits
2060− mapM_ initDyn dynInits
2061− mapM_ unSomeMergeInit mergeInits
2062− runHoldInits holdInitRef dynInitRef mergeInitRef
2063−
2064−initHold :: HasSpiderTimeline x => SomeHoldInit x -> EventM x ()
2065−initHold (SomeHoldInit h) = void $ getHoldEventSubscription h
2066−
2067−initDyn :: HasSpiderTimeline x => SomeDynInit x -> EventM x ()
2068−initDyn (SomeDynInit d) = void $ getDynHold d
2069−
2070−newEventEnv :: IO (EventEnv x)
2071−newEventEnv = do
2072− toAssignRef <- newIORef [] -- This should only actually get used when events are firing
2073− holdInitRef <- newIORef []
2074− dynInitRef <- newIORef []
2075− mergeUpdateRef <- newIORef []
2076− mergeInitRef <- newIORef []
2077− heightRef <- newIORef zeroHeight
2078− toClearRef <- newIORef []
2079− toClearIntRef <- newIORef []
2080− toClearRootRef <- newIORef []
2081− coincidenceInfosRef <- newIORef []
2082− delayedRef <- newIORef IntMap.empty
2083− return $ EventEnv toAssignRef holdInitRef dynInitRef mergeUpdateRef mergeInitRef toClearRef toClearIntRef toClearRootRef heightRef coincidenceInfosRef delayedRef
2084−
2085−clearEventEnv :: EventEnv x -> IO ()
2086−clearEventEnv (EventEnv toAssignRef holdInitRef dynInitRef mergeUpdateRef mergeInitRef toClearRef toClearIntRef toClearRootRef heightRef coincidenceInfosRef delayedRef) = do
2087− writeIORef toAssignRef []
2088− writeIORef holdInitRef []
2089− writeIORef dynInitRef []
2090− writeIORef mergeUpdateRef []
2091− writeIORef mergeInitRef []
2092− writeIORef heightRef zeroHeight
2093− writeIORef toClearRef []
2094− writeIORef toClearIntRef []
2095− writeIORef toClearRootRef []
2096− writeIORef coincidenceInfosRef []
2097− writeIORef delayedRef IntMap.empty
2098−
2099−-- | Run an event action outside of a frame
2100−runFrame :: forall x a. HasSpiderTimeline x => EventM x a -> SpiderHost x a --TODO: This function also needs to hold the mutex
2101−runFrame a = SpiderHost $ ask >>= \_ -> lift $ do
2102− let env = _spiderTimeline_eventEnv (spiderTimeline :: SpiderTimelineEnv x)
2103− let go = do
2104− result <- a
2105− 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
2106− return result
2107− result <- runEventM go
2108− toClear <- readIORef $ eventEnvClears env
2109− forM_ toClear $ \(SomeClear ref) -> {-# SCC "clear" #-} writeIORef ref Nothing
2110− toClearInt <- readIORef $ eventEnvIntClears env
2111− forM_ toClearInt $ \(SomeIntClear ref) -> {-# SCC "intClear" #-} writeIORef ref $! IntMap.empty
2112− toClearRoot <- readIORef $ eventEnvRootClears env
2113− forM_ toClearRoot $ \(SomeRootClear ref) -> {-# SCC "rootClear" #-} writeIORef ref $! DMap.empty
2114− toAssign <- readIORef $ eventEnvAssignments env
2115− toReconnectRef <- newIORef []
2116− coincidenceInfos <- readIORef $ eventEnvResetCoincidences env
2117− forM_ toAssign $ \(SomeAssignment vRef iRef v) -> {-# SCC "assignment" #-} do
2118− writeIORef vRef v
2119− when debugInvalidate $ putStrLn $ "Invalidating Hold"
2120− writeIORef iRef =<< evaluate =<< invalidate toReconnectRef =<< readIORef iRef
2121− mergeUpdates <- readIORef $ eventEnvMergeUpdates env
2122− writeIORef (eventEnvMergeUpdates env) []
2123− when debugPropagate $ putStrLn "Updating merges"
2124− mergeSubscriptionsToKill <- runEventM $ concat <$> mapM _someMergeUpdate_update mergeUpdates
2125− when debugPropagate $ putStrLn "Updating merges done"
2126− toReconnect <- readIORef toReconnectRef
2127− clearEventEnv env
2128− switchSubscriptionsToKill <- forM toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
2129− oldSubscription <- readIORef $ switchSubscribedCurrentParent subscribed
2130− wi <- readIORef $ switchSubscribedOwnWeakInvalidator subscribed
2131− when debugInvalidate $ putStrLn $ "Finalizing invalidator for Switch" <> showNodeId subscribed
2132− finalize wi
2133− i <- evaluate $ switchSubscribedOwnInvalidator subscribed
2134− wi' <- mkWeakPtrWithDebug i "wi'"
2135− writeIORef (switchSubscribedOwnWeakInvalidator subscribed) $! wi'
2136− writeIORef (switchSubscribedBehaviorParents subscribed) []
2137− writeIORef (eventEnvHoldInits env) [] --TODO: Should we reuse this?
2138− e <- runBehaviorM (readBehaviorTracked (switchSubscribedParent subscribed)) (Just (wi', switchSubscribedBehaviorParents subscribed)) $ eventEnvHoldInits env
2139− 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
2140− --TODO: Make sure we touch the pieces of the SwitchSubscribed at the appropriate times
2141− sub <- newSubscriberSwitch subscribed
2142− subscription <- runReaderT (unSpiderHost (runFrame ({-# SCC "subscribeSwitch" #-} subscribe e sub))) spiderTimeline --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
2143− {-
2144− stackTrace <- liftIO $ fmap renderStack $ ccsToStrings =<< (getCCSOf $! switchSubscribedParent subscribed)
2145− liftIO $ putStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
2146− EventRoot _ -> "EventRoot"
2147− EventNever -> "EventNever"
2148− _ -> "something else"
2149− -}
2150− writeIORef (switchSubscribedCurrentParent subscribed) $! subscription
2151− return oldSubscription
2152− liftIO $ mapM_ unsubscribe mergeSubscriptionsToKill
2153− liftIO $ mapM_ unsubscribe switchSubscriptionsToKill
2154− forM_ toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
2155− EventSubscription _ subd' <- readIORef $ switchSubscribedCurrentParent subscribed
2156− parentHeight <- getEventSubscribedHeight subd'
2157− myHeight <- readIORef $ switchSubscribedHeight subscribed
2158− when (parentHeight /= myHeight) $ do
2159− writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
2160− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight myHeight
2161− 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
2162− forM_ coincidenceInfos $ \(SomeResetCoincidence subscription mcs) -> do
2163− unsubscribe subscription
2164− mapM_ invalidateCoincidenceHeight mcs
2165− forM_ coincidenceInfos $ \(SomeResetCoincidence _ mcs) -> mapM_ recalculateCoincidenceHeight mcs
2166− mapM_ _someMergeUpdate_recalculateHeight mergeUpdates
2167− forM_ toReconnect $ \(SomeSwitchSubscribed subscribed) -> do
2168− height <- calculateSwitchHeight subscribed
2169− updateSwitchHeight height subscribed
2170− return result
2171−
2172−newtype Height = Height { unHeight :: Int } deriving (Show, Read, Eq, Ord, Bounded)
2173−
2174−{-# INLINE zeroHeight #-}
2175−zeroHeight :: Height
2176−zeroHeight = Height 0
2177−
2178−{-# INLINE invalidHeight #-}
2179−invalidHeight :: Height
2180−invalidHeight = Height (-1000)
2181−
2182−#ifdef DEBUG_CYCLES
2183−-- | An invalid height that is currently being traversed, e.g. by walkInvalidHeightParents
2184−{-# INLINE invalidHeightBeingTraversed #-}
2185−invalidHeightBeingTraversed :: Height
2186−invalidHeightBeingTraversed = Height (-1001)
2187−#endif
2188−
2189−{-# INLINE succHeight #-}
2190−succHeight :: Height -> Height
2191−succHeight h@(Height a) =
2192− if h == invalidHeight
2193− then invalidHeight
2194− else Height $ succ a
2195−
2196−invalidateCoincidenceHeight :: CoincidenceSubscribed x a -> IO ()
2197−invalidateCoincidenceHeight subscribed = do
2198− oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
2199− when (oldHeight /= invalidHeight) $ do
2200− writeIORef (coincidenceSubscribedHeight subscribed) $! invalidHeight
2201− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
2202−
2203−updateSwitchHeight :: Height -> SwitchSubscribed x a -> IO ()
2204−updateSwitchHeight new subscribed = do
2205− oldHeight <- readIORef $ switchSubscribedHeight subscribed
2206− when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
2207− when (new /= invalidHeight) $ do --TODO: This 'when' should probably be an assertion
2208− writeIORef (switchSubscribedHeight subscribed) $! new
2209− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
2210−
2211−recalculateCoincidenceHeight :: CoincidenceSubscribed x a -> IO ()
2212−recalculateCoincidenceHeight subscribed = do
2213− oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
2214− when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
2215− height <- calculateCoincidenceHeight subscribed
2216− when (height /= invalidHeight) $ do
2217− writeIORef (coincidenceSubscribedHeight subscribed) $! height
2218− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
2219−
2220−calculateSwitchHeight :: SwitchSubscribed x a -> IO Height
2221−calculateSwitchHeight subscribed = getEventSubscribedHeight . _eventSubscription_subscribed =<< readIORef (switchSubscribedCurrentParent subscribed)
2222−
2223−calculateCoincidenceHeight :: CoincidenceSubscribed x a -> IO Height
2224−calculateCoincidenceHeight subscribed = do
2225− outerHeight <- getEventSubscribedHeight $ _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
2226− innerHeight <- maybe (return zeroHeight) getEventSubscribedHeight =<< readIORef (coincidenceSubscribedInnerParent subscribed)
2227− return $ if outerHeight == invalidHeight || innerHeight == invalidHeight then invalidHeight else max outerHeight innerHeight
2228−
2229−data SomeSwitchSubscribed x = forall a. SomeSwitchSubscribed {-# NOUNPACK #-} (SwitchSubscribed x a)
2230−
2231−invalidate :: IORef [SomeSwitchSubscribed x] -> WeakList (Invalidator x) -> IO (WeakList (Invalidator x))
2232−invalidate toReconnectRef wis = do
2233− forM_ wis $ \wi -> do
2234− mi <- deRefWeak wi
2235− case mi of
2236− Nothing -> do
2237− traceInvalidate "invalidate Dead"
2238− return () --TODO: Should we clean this up here?
2239− Just i -> do
2240− finalize wi -- Once something's invalidated, it doesn't need to hang around; this will change when some things are strict
2241− case i of
2242− InvalidatorPull p -> do
2243− traceInvalidate $ "invalidate: Pull" <> showNodeId p
2244− mVal <- readIORef $ pullValue p
2245− forM_ mVal $ \val -> do
2246− writeIORef (pullValue p) Nothing
2247− writeIORef (pullSubscribedInvalidators val) =<< evaluate =<< invalidate toReconnectRef =<< readIORef (pullSubscribedInvalidators val)
2248− InvalidatorSwitch subscribed -> do
2249− traceInvalidate $ "invalidate: Switch" <> showNodeId subscribed
2250− modifyIORef' toReconnectRef (SomeSwitchSubscribed subscribed :)
2251− 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
2252−
2253−--------------------------------------------------------------------------------
2254−-- Reflex integration
2255−--------------------------------------------------------------------------------
2256−
2257−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
2258−-- When we're specializing, we include this from Reflex.Class instead, because
2259−-- it needs access to these types; when we're not, we want them here, so our
2260−-- instance isn't an orphan instance.
2261−#include "SpiderTimeline.include.hs"
2262−#include "SpiderTimelineHost.include.hs"
2263−#endif
2264−
2265−unsafeNewSpiderTimelineEnv :: forall x. IO (SpiderTimelineEnv x)
2266−unsafeNewSpiderTimelineEnv = do
2267− lock <- newMVar ()
2268− env <- newEventEnv
2269−#ifdef DEBUG
2270− depthRef <- newIORef 0
2271−#endif
2272− return $ SpiderTimelineEnv
2273− { _spiderTimeline_lock = lock
2274− , _spiderTimeline_eventEnv = env
2275−#ifdef DEBUG
2276− , _spiderTimeline_depth = depthRef
2277−#endif
2278− }
2279−
2280−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
2281−-- | Create a new SpiderTimelineEnv
2282−newSpiderTimeline :: IO (Some SpiderTimelineEnv)
2283−newSpiderTimeline = withSpiderTimeline (pure . Some.This)
2284−
2285−data LocalSpiderTimeline x s
2286−
2287−instance Reifies s (SpiderTimelineEnv x) =>
2288− HasSpiderTimeline (LocalSpiderTimeline x s) where
2289− spiderTimeline = localSpiderTimeline (Proxy :: Proxy s) $ reflect (Proxy :: Proxy s)
2290−
2291−localSpiderTimeline
2292− :: Proxy s
2293− -> SpiderTimelineEnv x
2294− -> SpiderTimelineEnv (LocalSpiderTimeline x s)
2295−localSpiderTimeline _ = unsafeCoerce
2296−
2297−-- | Pass a new timeline to the given function.
2298−withSpiderTimeline :: (forall x. HasSpiderTimeline x => SpiderTimelineEnv x -> IO r) -> IO r
2299−withSpiderTimeline k = do
2300− env <- unsafeNewSpiderTimelineEnv
2301− reify env $ \s -> k $ localSpiderTimeline s env
2302−#endif
2303−
2304−newtype SpiderPullM x a = SpiderPullM (BehaviorM x a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
2305−
2306−type ComputeM = EventM
2307−
2308−newtype SpiderPushM x a = SpiderPushM (ComputeM x a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
2309−
2310−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
2311−instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
2312− {-# SPECIALIZE instance R.Reflex (SpiderTimeline Global) #-}
2313− newtype Behavior (SpiderTimeline x) a = SpiderBehavior { unSpiderBehavior :: Behavior x a }
2314− newtype Event (SpiderTimeline x) a = SpiderEvent { unSpiderEvent :: Event x a }
2315− newtype Dynamic (SpiderTimeline x) a = SpiderDynamic { unSpiderDynamic :: Dynamic x (Identity a) } -- deriving (Functor, Applicative, Monad)
2316− newtype Incremental (SpiderTimeline x) p = SpiderIncremental { unSpiderIncremental :: Dynamic x p }
2317− type PullM (SpiderTimeline x) = SpiderPullM x
2318− type PushM (SpiderTimeline x) = SpiderPushM x
2319− {-# INLINABLE never #-}
2320− never = SpiderEvent eventNever
2321− {-# INLINABLE constant #-}
2322− constant = SpiderBehavior . behaviorConst
2323− {-# INLINE push #-}
2324− push f = SpiderEvent . push (coerce f) . unSpiderEvent
2325− {-# INLINE pushCheap #-}
2326− pushCheap f = SpiderEvent . pushCheap (coerce f) . unSpiderEvent
2327− {-# INLINABLE pull #-}
2328− pull = SpiderBehavior . pull . coerce
2329− {-# INLINABLE merge #-}
2330− merge = SpiderEvent . merge . dynamicConst . (coerce :: DMap k (R.Event (SpiderTimeline x)) -> DMap k (Event x))
2331− {-# INLINABLE fan #-}
2332− fan e = R.EventSelector $ SpiderEvent . select (fan (unSpiderEvent e))
2333− {-# INLINABLE switch #-}
2334− switch = SpiderEvent . switch . (coerce :: Behavior x (R.Event (SpiderTimeline x) a) -> Behavior x (Event x a)) . unSpiderBehavior
2335− {-# INLINABLE coincidence #-}
2336− coincidence = SpiderEvent . coincidence . (coerce :: Event x (R.Event (SpiderTimeline x) a) -> Event x (Event x a)) . unSpiderEvent
2337− {-# INLINABLE current #-}
2338− current = SpiderBehavior . dynamicCurrent . unSpiderDynamic
2339− {-# INLINABLE updated #-}
2340− updated = coerce $ SpiderEvent . dynamicUpdated . unSpiderDynamic
2341− {-# INLINABLE unsafeBuildDynamic #-}
2342− unsafeBuildDynamic readV0 v' = SpiderDynamic $ dynamicDynIdentity $ unsafeBuildDynamic (coerce readV0) $ coerce $ unSpiderEvent v'
2343− {-# INLINABLE unsafeBuildIncremental #-}
2344− unsafeBuildIncremental readV0 dv = SpiderIncremental $ dynamicDyn $ unsafeBuildDynamic (coerce readV0) $ unSpiderEvent dv
2345− {-# INLINABLE mergeIncremental #-}
2346− mergeIncremental = SpiderEvent . merge . (unsafeCoerce :: Dynamic x (PatchDMap k (R.Event (SpiderTimeline x))) -> Dynamic x (PatchDMap k (Event x))) . unSpiderIncremental
2347− {-# INLINABLE mergeIncrementalWithMove #-}
2348− mergeIncrementalWithMove = SpiderEvent . mergeWithMove . (unsafeCoerce :: Dynamic x (PatchDMapWithMove k (R.Event (SpiderTimeline x))) -> Dynamic x (PatchDMapWithMove k (Event x))) . unSpiderIncremental
2349− {-# INLINABLE currentIncremental #-}
2350− currentIncremental = SpiderBehavior . dynamicCurrent . unSpiderIncremental
2351− {-# INLINABLE updatedIncremental #-}
2352− updatedIncremental = SpiderEvent . dynamicUpdated . unSpiderIncremental
2353− {-# INLINABLE incrementalToDynamic #-}
2354− incrementalToDynamic (SpiderIncremental i) = SpiderDynamic $ dynamicDynIdentity $ unsafeBuildDynamic (readBehaviorUntracked $ dynamicCurrent i) $ flip push (dynamicUpdated i) $ \p -> do
2355− c <- readBehaviorUntracked $ dynamicCurrent i
2356− return $ Identity <$> apply p c --TODO: Avoid the redundant 'apply'
2357− eventCoercion Coercion = Coercion
2358− behaviorCoercion Coercion = Coercion
2359− dynamicCoercion = unsafeCoerce --TODO: How can we avoid this unsafeCoerce? This is safe only because we know how Identity works as a Patch instance
2360− {-# INLINABLE mergeIntIncremental #-}
2361− mergeIntIncremental = SpiderEvent . mergeInt . (unsafeCoerce :: Dynamic x (PatchIntMap (R.Event (SpiderTimeline x) a)) -> Dynamic x (PatchIntMap (Event x a))) . unSpiderIncremental
2362− {-# INLINABLE fanInt #-}
2363− fanInt e = R.EventSelectorInt $ SpiderEvent . selectInt (fanInt (unSpiderEvent e))
2364−#endif
2365−
2366−data RootTrigger x a = forall k. GCompare k => RootTrigger (WeakBag (Subscriber x a), IORef (DMap k Identity), k a)
2367−
2368−data SpiderEventHandle x a = SpiderEventHandle
2369− { spiderEventHandleSubscription :: EventSubscription x
2370− , spiderEventHandleValue :: IORef (Maybe a)
2371− }
2372−
2373−instance MonadRef (EventM x) where
2374− type Ref (EventM x) = Ref IO
2375− {-# INLINABLE newRef #-}
2376− {-# INLINABLE readRef #-}
2377− {-# INLINABLE writeRef #-}
2378− newRef = liftIO . newRef
2379− readRef = liftIO . readRef
2380− writeRef r a = liftIO $ writeRef r a
2381−
2382−instance MonadAtomicRef (EventM x) where
2383− {-# INLINABLE atomicModifyRef #-}
2384− atomicModifyRef r f = liftIO $ atomicModifyRef r f
2385−
2386−-- | The monad for actions that manipulate a Spider timeline identified by @x@
2387−newtype SpiderHost x a = SpiderHost { unSpiderHost :: ReaderT (SpiderTimelineEnv x) IO a } deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2388−
2389−instance Monad (SpiderHost x) where
2390− {-# INLINABLE (>>=) #-}
2391− SpiderHost x >>= f = SpiderHost $ x >>= unSpiderHost . f
2392− {-# INLINABLE (>>) #-}
2393− SpiderHost x >> SpiderHost y = SpiderHost $ x >> y
2394− {-# INLINABLE return #-}
2395− return x = SpiderHost $ return x
2396− {-# INLINABLE fail #-}
2397− fail s = SpiderHost $ fail s
2398−
2399−-- | Run an action affecting the global Spider timeline; this will be guarded by
2400−-- a mutex for that timeline
2401−runSpiderHost :: SpiderHost Global a -> IO a
2402−runSpiderHost (SpiderHost a) = runReaderT a globalSpiderTimelineEnv
2403−
2404−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
2405−-- | Run an action affecting a given Spider timeline; this will be guarded by a
2406−-- mutex for that timeline
2407−runSpiderHostForTimeline :: SpiderHost x a -> SpiderTimelineEnv x -> IO a
2408−runSpiderHostForTimeline (SpiderHost a) = runReaderT a
2409−#endif
2410−
2411−newtype SpiderHostFrame x a = SpiderHostFrame { runSpiderHostFrame :: EventM x a } deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2412−
2413−instance Monad (SpiderHostFrame x) where
2414− {-# INLINABLE (>>=) #-}
2415− SpiderHostFrame x >>= f = SpiderHostFrame $ x >>= runSpiderHostFrame . f
2416− {-# INLINABLE (>>) #-}
2417− SpiderHostFrame x >> SpiderHostFrame y = SpiderHostFrame $ x >> y
2418− {-# INLINABLE return #-}
2419− return x = SpiderHostFrame $ return x
2420− {-# INLINABLE fail #-}
2421− fail s = SpiderHostFrame $ fail s
2422−
2423−instance NotReady (SpiderTimeline x) (SpiderHostFrame x) where
2424− notReadyUntil _ = pure ()
2425− notReady = pure ()
2426−
2427−newEventWithTriggerIO :: (RootTrigger x a -> IO (IO ())) -> IO (Event x a)
2428−newEventWithTriggerIO f = do
2429− es <- newFanEventWithTriggerIO $ \Refl -> f
2430− return $ select es Refl
2431−
2432−newFanEventWithTriggerIO :: GCompare k => (forall a. k a -> RootTrigger x a -> IO (IO ())) -> IO (EventSelector x k)
2433−newFanEventWithTriggerIO f = do
2434− occRef <- newIORef DMap.empty
2435− subscribedRef <- newIORef DMap.empty
2436− let !r = Root
2437− { rootOccurrence = occRef
2438− , rootSubscribed = subscribedRef
2439− , rootInit = f
2440− }
2441− return $ EventSelector $ \k -> eventRoot k r
2442−
2443−newtype ReadPhase x a = ReadPhase (ResultM x a) deriving (Functor, Applicative, Monad, MonadFix)
2444−
2445−instance MonadRef (SpiderHost x) where
2446− type Ref (SpiderHost x) = Ref IO
2447− newRef = SpiderHost . newRef
2448− readRef = SpiderHost . readRef
2449− writeRef r = SpiderHost . writeRef r
2450−
2451−instance MonadAtomicRef (SpiderHost x) where
2452− atomicModifyRef r = SpiderHost . atomicModifyRef r
2453−
2454−instance MonadRef (SpiderHostFrame x) where
2455− type Ref (SpiderHostFrame x) = Ref IO
2456− newRef = SpiderHostFrame . newRef
2457− readRef = SpiderHostFrame . readRef
2458− writeRef r = SpiderHostFrame . writeRef r
2459−
2460−instance MonadAtomicRef (SpiderHostFrame x) where
2461− atomicModifyRef r = SpiderHostFrame . atomicModifyRef r
2462−
2463−instance PrimMonad (SpiderHostFrame x) where
2464− type PrimState (SpiderHostFrame x) = PrimState IO
2465− primitive = SpiderHostFrame . EventM . primitive