1{-# LANGUAGE BangPatterns #-}
3{-# LANGUAGE ConstraintKinds #-}
4{-# LANGUAGE EmptyDataDecls #-}
5{-# LANGUAGE ExistentialQuantification #-}
6{-# LANGUAGE FlexibleContexts #-}
7{-# LANGUAGE FlexibleInstances #-}
8{-# LANGUAGE FunctionalDependencies #-}
10{-# LANGUAGE GeneralizedNewtypeDeriving #-}
11{-# LANGUAGE LambdaCase #-}
12{-# LANGUAGE RankNTypes #-}
13{-# LANGUAGE RoleAnnotations #-}
14{-# LANGUAGE ScopedTypeVariables #-}
15{-# LANGUAGE TypeFamilies #-}
16{-# LANGUAGE TypeOperators #-}
17{-# LANGUAGE UndecidableInstances #-}
18{-# LANGUAGE PolyKinds #-}
19{-# LANGUAGE DeriveFunctor #-}
20{-# LANGUAGE StandaloneDeriving #-}
21{-# LANGUAGE InstanceSigs #-}
22{-# LANGUAGE MultiWayIf #-}
24#ifdef USE_REFLEX_OPTIMIZER
25{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
27{-# OPTIONS_GHC -Wunused-binds #-}
28-- | This module is the implementation of the 'Spider' 'Reflex' engine. It uses
29-- a graph traversal algorithm to propagate 'Event's and 'Behavior's.
30module Reflex.Spider.Internal (module Reflex.Spider.Internal) where
32#if MIN_VERSION_base(4,10,0)
33import Control.Applicative (liftA2)
35import Control.Concurrent
36import Control.Exception
37import Control.Monad hiding (forM, forM_, mapM, mapM_)
38import Control.Monad.Exception
39import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_)
40import Control.Monad.Primitive
41import Control.Monad.Reader.Class
42import Control.Monad.IO.Class
43import Control.Monad.ReaderIO
44import Control.Monad.Ref
45import Control.Monad.Fail (MonadFail)
46import qualified Control.Monad.Fail as MonadFail
49import Data.Dependent.Map (DMap)
50import qualified Data.Dependent.Map as DMap
51import Data.Dependent.Sum (DSum (..))
52import Data.FastMutableIntMap (FastMutableIntMap, PatchIntMap (..))
53import qualified Data.FastMutableIntMap as FastMutableIntMap
54import Data.Foldable hiding (concat, elem, sequence_)
55import Data.Functor.Constant
56import Data.Functor.Misc
57import Data.Functor.Product
58import Data.GADT.Compare
59import Data.IntMap.Strict (IntMap)
60import qualified Data.IntMap.Strict as IntMap
62import Data.Kind (Type)
63import Data.Maybe hiding (mapMaybe)
64import Data.Monoid (mempty, (<>))
67import Data.Traversable
68import Data.Type.Equality ((:~:)(Refl))
69import Data.Witherable (Filterable, mapMaybe)
70import GHC.Exts hiding (toList)
71import GHC.IORef (IORef (..))
74import System.IO.Unsafe
78#ifdef MIN_VERSION_semialign
79#if MIN_VERSION_these(0,8,0)
80import Data.These.Combinators (justThese)
82#if MIN_VERSION_semialign(1,1,0)
83import Data.Zip (Zip (..))
88import Control.Monad.State hiding (forM, forM_, mapM, mapM_, sequence)
91import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
92import qualified Data.List.NonEmpty as NonEmpty
93import Data.Tree (Forest, Tree (..), drawForest)
94import Data.List (isPrefixOf)
96import Data.FastWeakBag (FastWeakBag, FastWeakBagTicket)
97import qualified Data.FastWeakBag as FastWeakBag
100import Data.Some (Some(Some))
101import Data.Type.Coercion
102import Data.Profunctor.Unsafe ((#.), (.#))
103import Data.WeakBag (WeakBag, WeakBagTicket, _weakBag_children)
104import qualified Data.WeakBag as WeakBag
105import qualified Reflex.Class
106import qualified Reflex.Class as R
107import qualified Reflex.Host.Class
108import Reflex.NotReady.Class
110import qualified Data.Patch.DMapWithMove as PatchDMapWithMove
111import Reflex.PerformEvent.Base (PerformEventT)
113#ifdef DEBUG_TRACE_EVENTS
114import qualified Data.ByteString.Char8 as BS8
115import System.IO (stderr)
116import Data.List (isPrefixOf)
119-- TODO stdout might not be the best channel for debug output
120debugStrLn :: String -> IO ()
123#ifdef DEBUG_TRACE_EVENTS
124withStackOneLine :: (BS8.ByteString -> a) -> a
125withStackOneLine expr = unsafePerformIO $ do
126 stack <- currentCallStack
127 return (expr . BS8.pack . unwords . dropInternal . reverse $ stack)
128 where dropInternal = filterStack "Reflex.Spider.Internal"
132debugPropagate :: Bool
134debugInvalidateHeight :: Bool
136debugInvalidate :: Bool
141#ifdef DEBUG_TRACE_PROPAGATION
144debugPropagate = False
147#ifdef DEBUG_TRACE_HEIGHT
148debugInvalidateHeight = True
150debugInvalidateHeight = False
153#ifdef DEBUG_TRACE_INVALIDATION
154debugInvalidate = True
156debugInvalidate = False
159class HasNodeId a where
160 getNodeId :: a -> Int
162instance HasNodeId (CacheSubscribed x a) where
163 getNodeId = _cacheSubscribed_nodeId
165instance HasNodeId (FanInt x a) where
166 getNodeId = _fanInt_nodeId
168instance HasNodeId (Hold x p) where
169 getNodeId = holdNodeId
171instance HasNodeId (SwitchSubscribed x a) where
172 getNodeId = switchSubscribedNodeId
174instance HasNodeId (FanSubscribed x v a) where
175 getNodeId = fanSubscribedNodeId
177instance HasNodeId (CoincidenceSubscribed x a) where
178 getNodeId = coincidenceSubscribedNodeId
180instance HasNodeId (RootSubscribed x a) where
181 getNodeId = rootSubscribedNodeId
183instance HasNodeId (Pull x a) where
184 getNodeId = pullNodeId
186{-# INLINE showNodeId #-}
187showNodeId :: HasNodeId a => a -> String
188showNodeId = showNodeId' . getNodeId
190showNodeId' :: Int -> String
191showNodeId' = ("#"<>) . show
196debugPropagate = False
197debugInvalidateHeight = False
198debugInvalidate = False
200-- This must be inline, or error messages will cause memory leaks due to retaining the node in question
201{-# INLINE showNodeId #-}
202showNodeId :: a -> String
205{-# INLINE showNodeId' #-}
206showNodeId' :: Int -> String
212{-# NOINLINE nextNodeIdRef #-}
213nextNodeIdRef :: IORef Int
214nextNodeIdRef = unsafePerformIO $ newIORef 1
217newNodeId = atomicModifyIORef' nextNodeIdRef $ \n -> (succ n, n)
220--------------------------------------------------------------------------------
222--------------------------------------------------------------------------------
224--NB: Once you subscribe to an Event, you must always hold on the the WHOLE EventSubscription you get back
225-- If you do not retain the subscription, you may be prematurely unsubscribed from the parent event.
226data EventSubscription x = EventSubscription
227 { _eventSubscription_unsubscribe :: !(IO ())
228 , _eventSubscription_subscribed :: {-# UNPACK #-} !(EventSubscribed x)
231unsubscribe :: EventSubscription x -> IO ()
232unsubscribe (EventSubscription u _) = u
234--------------------------------------------------------------------------------
236--------------------------------------------------------------------------------
238newtype Event x a = Event { unEvent :: Subscriber x a -> EventM x (EventSubscription x, Maybe a) }
240{-# INLINE subscribeAndRead #-}
241subscribeAndRead :: Event x a -> Subscriber x a -> EventM x (EventSubscription x, Maybe a)
242subscribeAndRead = unEvent
245"cacheEvent/cacheEvent" forall e. cacheEvent (cacheEvent e) = cacheEvent e
246"cacheEvent/pushCheap" forall f e. pushCheap f (cacheEvent e) = cacheEvent (pushCheap f e)
247"hold/cacheEvent" forall f e. hold f (cacheEvent e) = hold f e
250-- | Construct an 'Event' equivalent to that constructed by 'push', but with no
251-- caching; if the computation function is very cheap, this is (much) more
252-- efficient than 'push'
253{-# INLINE [1] pushCheap #-}
254pushCheap :: HasSpiderTimeline x => (a -> ComputeM x (Maybe b)) -> Event x a -> Event x b
255pushCheap !f e = Event $ \sub -> do
256 (subscription, occ) <- subscribeAndRead e $ debugSubscriber' "push" $ sub
257 { subscriberPropagate = \a -> do
259 mapM_ (subscriberPropagate sub) mb
261 occ' <- join <$> mapM f occ
262 return (subscription, occ')
264-- | A subscriber that never triggers other 'Event's
265{-# INLINE terminalSubscriber #-}
266terminalSubscriber :: (a -> EventM x ()) -> Subscriber x a
267terminalSubscriber p = Subscriber
268 { subscriberPropagate = p
269 , subscriberInvalidateHeight = \_ -> return ()
270 , subscriberRecalculateHeight = \_ -> return ()
273-- | Subscribe to an Event only for the duration of one occurrence
274{-# INLINE subscribeAndReadHead #-}
275subscribeAndReadHead :: HasSpiderTimeline x => Event x a -> Subscriber x a -> EventM x (EventSubscription x, Maybe a)
276subscribeAndReadHead e sub = do
277 subscriptionRef <- liftIO $ newIORef $ error "subscribeAndReadHead: not initialized"
278 (subscription, occ) <- subscribeAndRead e $ debugSubscriber' "head" $ sub
279 { subscriberPropagate = \a -> do
280 liftIO $ unsubscribe =<< readIORef subscriptionRef
281 subscriberPropagate sub a
284 Nothing -> writeIORef subscriptionRef $! subscription
285 Just _ -> unsubscribe subscription
286 return (subscription, occ)
288--TODO: Make this lazy in its input event
289headE :: (MonadIO m, Defer (SomeMergeInit x) m, HasSpiderTimeline x) => Event x a -> m (Event x a)
291 parent <- liftIO $ newIORef $ Just originalE
292 defer $ SomeMergeInit $ do --TODO: Rename SomeMergeInit appropriately
293 let clearParent = liftIO $ writeIORef parent Nothing
294 (_, occ) <- subscribeAndReadHead originalE $ terminalSubscriber $ const clearParent
295 when (isJust occ) clearParent
296 return $ Event $ \sub ->
297 liftIO (readIORef parent) >>= \case
298 Nothing -> subscribeAndReadNever
299 Just e -> subscribeAndReadHead e sub
301data CacheSubscribed x a
302 = CacheSubscribed { _cacheSubscribed_subscribers :: {-# UNPACK #-} !(FastWeakBag (Subscriber x a))
303 , _cacheSubscribed_parent :: {-# UNPACK #-} !(EventSubscription x)
304 , _cacheSubscribed_occurrence :: {-# UNPACK #-} !(IORef (Maybe a))
306 , _cacheSubscribed_nodeId :: {-# UNPACK #-} !Int
310nowSpiderEventM :: (HasSpiderTimeline x) => EventM x (R.Event (SpiderTimeline x) ())
314now :: (MonadIO m, Defer (Some Clear) m, HasSpiderTimeline x
317 nowOrNot <- liftIO $ newIORef $ Just ()
318 scheduleClear nowOrNot
319 return . Event $ \_ -> do
320 occ <- liftIO . readIORef $ nowOrNot
321 return ( EventSubscription (return ()) eventSubscribedNow
325-- | Construct an 'Event' whose value is guaranteed not to be recomputed
328--TODO: Try a caching strategy where we subscribe directly to the parent when
329--there's only one subscriber, and then build our own FastWeakBag only when a second
331{-# NOINLINE [0] cacheEvent #-}
332cacheEvent :: forall x a. HasSpiderTimeline x => Event x a -> Event x a
334#ifdef DEBUG_TRACE_EVENTS
335 withStackOneLine $ \callSite -> Event $
340 mSubscribedRef :: IORef (FastWeak (CacheSubscribed x a))
341 <- newIORef emptyFastWeak
342 pure $ \sub -> {-# SCC "cacheEvent" #-} do
343#ifdef DEBUG_TRACE_EVENTS
344 unless (BS8.null callSite) $ liftIO $ BS8.hPutStrLn stderr callSite
346 subscribedTicket <- liftIO (readIORef mSubscribedRef >>= getFastWeakTicket) >>= \case
347 Just subscribedTicket -> return subscribedTicket
350 nodeId <- liftIO newNodeId
352 subscribers <- liftIO FastWeakBag.empty
353 occRef <- liftIO $ newIORef Nothing -- This should never be read prior to being set below
355 (parentSub, occ) <- subscribeAndRead e $ debugSubscriber' ("cacheEvent" <> showNodeId' nodeId) $ Subscriber
357 (parentSub, occ) <- subscribeAndRead e $ Subscriber
359 { subscriberPropagate = \a -> do
360 liftIO $ writeIORef occRef (Just a)
362 propagateFast a subscribers
363 , subscriberInvalidateHeight = FastWeakBag.traverse_ subscribers . invalidateSubscriberHeight
364 , subscriberRecalculateHeight = FastWeakBag.traverse_ subscribers . recalculateSubscriberHeight
366 when (isJust occ) $ do
367 liftIO $ writeIORef occRef occ -- Set the initial value of occRef; we don't need to do this if occ is Nothing
369 let !subscribed = CacheSubscribed
370 { _cacheSubscribed_subscribers = subscribers
371 , _cacheSubscribed_parent = parentSub
372 , _cacheSubscribed_occurrence = occRef
374 , _cacheSubscribed_nodeId = nodeId
377 subscribedTicket <- liftIO $ mkFastWeakTicket subscribed
378 liftIO $ writeIORef mSubscribedRef =<< getFastWeakTicketWeak subscribedTicket
379 return subscribedTicket
380 liftIO $ cacheSubscription sub mSubscribedRef subscribedTicket
382cacheSubscription :: Subscriber x a -> IORef (FastWeak (CacheSubscribed x a))
383 -> FastWeakTicket (CacheSubscribed x a) -> IO (EventSubscription x, Maybe a)
384cacheSubscription sub mSubscribedRef subscribedTicket = do
385 subscribed <- getFastWeakTicketValue subscribedTicket
386 ticket <- FastWeakBag.insert sub $ _cacheSubscribed_subscribers subscribed
387 occ <- readIORef $ _cacheSubscribed_occurrence subscribed
389 let parentSub = _cacheSubscribed_parent subscribed
390 es = EventSubscription
391 { _eventSubscription_unsubscribe = do
392 FastWeakBag.remove ticket
394 isEmpty <- FastWeakBag.isEmpty $ _cacheSubscribed_subscribers subscribed
396 writeIORef mSubscribedRef emptyFastWeak
397 unsubscribe parentSub
399 touch subscribedTicket
400 , _eventSubscription_subscribed = EventSubscribed
401 { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed parentSub
402 , eventSubscribedRetained = toAny subscribedTicket
404 , eventSubscribedGetParents = return [_eventSubscription_subscribed parentSub]
405 , eventSubscribedHasOwnHeightRef = False
406 , eventSubscribedWhoCreated = whoCreatedIORef mSubscribedRef
413subscribe :: Event x a -> Subscriber x a -> EventM x (EventSubscription x)
414subscribe e s = fst <$> subscribeAndRead e s
417wrap :: MonadIO m => (t -> EventSubscribed x) -> (Subscriber x a -> m (WeakBagTicket, t, Maybe a)) -> Subscriber x a -> m (EventSubscription x, Maybe a)
418wrap tag getSpecificSubscribed sub = do
419 (sln, subd, occ) <- getSpecificSubscribed sub
421 return (EventSubscription (WeakBag.remove sln >> touch sln) es, occ)
423eventRoot :: (GCompare k, HasSpiderTimeline x) => k a -> Root x k -> Event x a
424eventRoot !k !r = Event $ wrap eventSubscribedRoot $ liftIO . getRootSubscribed k r
426subscribeAndReadNever :: EventM x (EventSubscription x, Maybe a)
427subscribeAndReadNever = return (EventSubscription (return ()) eventSubscribedNever, Nothing)
429eventNever :: Event x a
430eventNever = Event $ const subscribeAndReadNever
432eventFan :: (GCompare k, HasSpiderTimeline x) => k a -> Fan x k v -> Event x (v a)
433eventFan !k !f = Event $ wrap eventSubscribedFan $ getFanSubscribed k f
435eventSwitch :: HasSpiderTimeline x => Switch x a -> Event x a
436eventSwitch !s = Event $ wrap eventSubscribedSwitch $ getSwitchSubscribed s
438eventCoincidence :: HasSpiderTimeline x => Coincidence x a -> Event x a
439eventCoincidence !c = Event $ wrap eventSubscribedCoincidence $ getCoincidenceSubscribed c
441eventHold :: Hold x p -> Event x p
442eventHold !h = Event $ subscribeHoldEvent h
444eventDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> Event x p
445eventDyn !j = Event $ \sub -> getDynHold j >>= \h -> subscribeHoldEvent h sub
447{-# INLINE subscribeCoincidenceInner #-}
448subscribeCoincidenceInner :: HasSpiderTimeline x => Event x a -> Height -> CoincidenceSubscribed x a -> EventM x (Maybe a, Height, EventSubscribed x)
449subscribeCoincidenceInner inner outerHeight subscribedUnsafe = do
450 subInner <- liftIO $ newSubscriberCoincidenceInner subscribedUnsafe
451 (subscription@(EventSubscription _ innerSubd), innerOcc) <- subscribeAndRead inner subInner
452 innerHeight <- liftIO $ getEventSubscribedHeight innerSubd
453 let height = max innerHeight outerHeight
454 defer $ SomeResetCoincidence subscription $ if height > outerHeight then Just subscribedUnsafe else Nothing
455 return (innerOcc, height, innerSubd)
457--------------------------------------------------------------------------------
459--------------------------------------------------------------------------------
461data Subscriber x a = Subscriber
462 { subscriberPropagate :: !(a -> EventM x ())
463 , subscriberInvalidateHeight :: !(Height -> IO ())
464 , subscriberRecalculateHeight :: !(Height -> IO ())
467newSubscriberHold :: (HasSpiderTimeline x, Patch p) => Hold x p -> IO (Subscriber x p)
468newSubscriberHold h = return $ Subscriber
469 { subscriberPropagate = {-# SCC "traverseHold" #-} propagateSubscriberHold h
470 , subscriberInvalidateHeight = \_ -> return ()
471 , subscriberRecalculateHeight = \_ -> return ()
474newSubscriberFan :: forall x k v. (HasSpiderTimeline x, GCompare k) => FanSubscribed x k v -> IO (Subscriber x (DMap k v))
475newSubscriberFan subscribed = debugSubscriber ("SubscriberFan " <> showNodeId subscribed) $ Subscriber
476 { subscriberPropagate = \a -> {-# SCC "traverseFan" #-} do
477 subs <- liftIO $ readIORef $ fanSubscribedSubscribers subscribed
478 tracePropagate (Proxy :: Proxy x) $ show (DMap.size subs) <> " keys subscribed, " <> show (DMap.size a) <> " keys firing"
479 liftIO $ writeIORef (fanSubscribedOccurrence subscribed) $ Just a
480 scheduleClear $ fanSubscribedOccurrence subscribed
481 let f _ (Pair v subsubs) = do
482 propagate v $ _fanSubscribedChildren_list subsubs
484 _ <- DMap.traverseWithKey f $ DMap.intersectionWithKey (\_ -> Pair) a subs --TODO: Would be nice to have DMap.traverse_
486 , subscriberInvalidateHeight = \old -> do
487 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
488 forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse_ (_fanSubscribedChildren_list v) $ invalidateSubscriberHeight old
489 , subscriberRecalculateHeight = \new -> do
490 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
491 forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse_ (_fanSubscribedChildren_list v) $ recalculateSubscriberHeight new
494newSubscriberSwitch :: forall x a. HasSpiderTimeline x => SwitchSubscribed x a -> IO (Subscriber x a)
495newSubscriberSwitch subscribed = debugSubscriber ("SubscriberCoincidenceOuter" <> showNodeId subscribed) $ Subscriber
496 { subscriberPropagate = \a -> {-# SCC "traverseSwitch" #-} do
497 liftIO $ writeIORef (switchSubscribedOccurrence subscribed) $ Just a
498 scheduleClear $ switchSubscribedOccurrence subscribed
499 propagate a $ switchSubscribedSubscribers subscribed
500 , subscriberInvalidateHeight = \_ -> do
501 oldHeight <- readIORef $ switchSubscribedHeight subscribed
502 when (oldHeight /= invalidHeight) $ do
503 writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
504 WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
505 , subscriberRecalculateHeight = (`updateSwitchHeight` subscribed)
508newSubscriberCoincidenceOuter :: forall x b. HasSpiderTimeline x => CoincidenceSubscribed x b -> IO (Subscriber x (Event x b))
509newSubscriberCoincidenceOuter subscribed = debugSubscriber ("SubscriberCoincidenceOuter" <> showNodeId subscribed) $ Subscriber
510 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceOuter" #-} do
511 outerHeight <- liftIO $ readIORef $ coincidenceSubscribedHeight subscribed
512 tracePropagate (Proxy :: Proxy x) $ " outerHeight = " <> show outerHeight
513 (occ, innerHeight, innerSubd) <- subscribeCoincidenceInner a outerHeight subscribed
514 tracePropagate (Proxy :: Proxy x) $ " isJust occ = " <> show (isJust occ)
515 tracePropagate (Proxy :: Proxy x) $ " innerHeight = " <> show innerHeight
517 liftIO $ writeIORef (coincidenceSubscribedInnerParent subscribed) $ Just innerSubd
518 scheduleClear $ coincidenceSubscribedInnerParent subscribed
521 when (innerHeight > outerHeight) $ liftIO $ do -- If the event fires, it will fire at a later height
522 writeIORef (coincidenceSubscribedHeight subscribed) $! innerHeight
523 WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight outerHeight
524 WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight innerHeight
525 Just o -> do -- Since it's already firing, no need to adjust height
526 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) occ
527 scheduleClear $ coincidenceSubscribedOccurrence subscribed
528 propagate o $ coincidenceSubscribedSubscribers subscribed
529 , subscriberInvalidateHeight = \_ -> invalidateCoincidenceHeight subscribed
530 , subscriberRecalculateHeight = \_ -> recalculateCoincidenceHeight subscribed
533newSubscriberCoincidenceInner :: forall x a. HasSpiderTimeline x => CoincidenceSubscribed x a -> IO (Subscriber x a)
534newSubscriberCoincidenceInner subscribed = debugSubscriber ("SubscriberCoincidenceInner" <> showNodeId subscribed) $ Subscriber
535 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceInner" #-} do
536 occ <- liftIO $ readIORef $ coincidenceSubscribedOccurrence subscribed
538 Just _ -> return () -- SubscriberCoincidenceOuter must have already propagated this event
540 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) $ Just a
541 scheduleClear $ coincidenceSubscribedOccurrence subscribed
542 propagate a $ coincidenceSubscribedSubscribers subscribed
543 , subscriberInvalidateHeight = \_ -> invalidateCoincidenceHeight subscribed
544 , subscriberRecalculateHeight = \_ -> recalculateCoincidenceHeight subscribed
547invalidateSubscriberHeight :: Height -> Subscriber x a -> IO ()
548invalidateSubscriberHeight = flip subscriberInvalidateHeight
550recalculateSubscriberHeight :: Height -> Subscriber x a -> IO ()
551recalculateSubscriberHeight = flip subscriberRecalculateHeight
553-- | Propagate everything at the current height
554propagate :: forall x a. HasSpiderTimeline x => a -> WeakBag (Subscriber x a) -> EventM x ()
555propagate a subscribers = withIncreasedDepth (Proxy::Proxy x) $
556 -- Note: in the following traversal, we do not visit nodes that are added to the list during our traversal; they are new events, which will necessarily have full information already, so there is no need to traverse them
557 --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
558 WeakBag.traverse_ subscribers $ \s -> subscriberPropagate s a
560-- | Propagate everything at the current height
561propagateFast :: forall x a. HasSpiderTimeline x => a -> FastWeakBag (Subscriber x a) -> EventM x ()
562propagateFast a subscribers = withIncreasedDepth (Proxy::Proxy x) $
563 -- Note: in the following traversal, we do not visit nodes that are added to the list during our traversal; they are new events, which will necessarily have full information already, so there is no need to traverse them
564 --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
565 FastWeakBag.traverse_ subscribers $ \s -> subscriberPropagate s a
567--------------------------------------------------------------------------------
569--------------------------------------------------------------------------------
574-- Why do we use Any here, instead of just giving eventSubscribedRetained an
575-- existential type? Sadly, GHC does not currently know how to unbox types
576-- with existentially quantified fields. So instead we just coerce values
577-- to type Any on the way in. Since we never coerce them back, this is
579data EventSubscribed x = EventSubscribed
580 { eventSubscribedHeightRef :: {-# UNPACK #-} !(IORef Height)
581 , eventSubscribedRetained :: {-# NOUNPACK #-} !Any
583 , eventSubscribedGetParents :: !(IO [EventSubscribed x]) -- For debugging loops
584 , eventSubscribedHasOwnHeightRef :: !Bool
585 , eventSubscribedWhoCreated :: !(IO [String])
589eventSubscribedRoot :: RootSubscribed x a -> EventSubscribed x
590eventSubscribedRoot !r = EventSubscribed
591 { eventSubscribedHeightRef = zeroRef
592 , eventSubscribedRetained = toAny r
594 , eventSubscribedGetParents = return []
595 , eventSubscribedHasOwnHeightRef = False
596 , eventSubscribedWhoCreated = return ["root"]
600eventSubscribedNever :: EventSubscribed x
601eventSubscribedNever = EventSubscribed
602 { eventSubscribedHeightRef = zeroRef
603 , eventSubscribedRetained = toAny ()
605 , eventSubscribedGetParents = return []
606 , eventSubscribedHasOwnHeightRef = False
607 , eventSubscribedWhoCreated = return ["never"]
610eventSubscribedNow :: EventSubscribed x
611eventSubscribedNow = EventSubscribed
612 { eventSubscribedHeightRef = zeroRef
613 , eventSubscribedRetained = toAny ()
615 , eventSubscribedGetParents = return []
616 , eventSubscribedHasOwnHeightRef = False
617 , eventSubscribedWhoCreated = return ["now"]
621eventSubscribedFan :: FanSubscribed x k v -> EventSubscribed x
622eventSubscribedFan !subscribed = EventSubscribed
623 { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ fanSubscribedParent subscribed
624 , eventSubscribedRetained = toAny subscribed
626 , eventSubscribedGetParents = return [_eventSubscription_subscribed $ fanSubscribedParent subscribed]
627 , eventSubscribedHasOwnHeightRef = False
628 , eventSubscribedWhoCreated = whoCreatedIORef $ fanSubscribedCachedSubscribed subscribed
632eventSubscribedSwitch :: SwitchSubscribed x a -> EventSubscribed x
633eventSubscribedSwitch !subscribed = EventSubscribed
634 { eventSubscribedHeightRef = switchSubscribedHeight subscribed
635 , eventSubscribedRetained = toAny subscribed
637 , eventSubscribedGetParents = do
638 s <- readIORef $ switchSubscribedCurrentParent subscribed
639 return [_eventSubscription_subscribed s]
640 , eventSubscribedHasOwnHeightRef = True
641 , eventSubscribedWhoCreated = whoCreatedIORef $ switchSubscribedCachedSubscribed subscribed
645eventSubscribedCoincidence :: CoincidenceSubscribed x a -> EventSubscribed x
646eventSubscribedCoincidence !subscribed = EventSubscribed
647 { eventSubscribedHeightRef = coincidenceSubscribedHeight subscribed
648 , eventSubscribedRetained = toAny subscribed
650 , eventSubscribedGetParents = do
651 innerSubscription <- readIORef $ coincidenceSubscribedInnerParent subscribed
652 let outerParent = _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
653 innerParents = maybeToList $ innerSubscription
654 return $ outerParent : innerParents
655 , eventSubscribedHasOwnHeightRef = True
656 , eventSubscribedWhoCreated = whoCreatedIORef $ coincidenceSubscribedCachedSubscribed subscribed
660getEventSubscribedHeight :: EventSubscribed x -> IO Height
661getEventSubscribedHeight es = readIORef $ eventSubscribedHeightRef es
664whoCreatedEventSubscribed :: EventSubscribed x -> IO [String]
665whoCreatedEventSubscribed = eventSubscribedWhoCreated
667walkInvalidHeightParents :: EventSubscribed x -> IO [EventSubscribed x]
668walkInvalidHeightParents s0 = do
669 subscribers <- flip execStateT mempty $ ($ s0) $ fix $ \loop s -> do
670 h <- liftIO $ readIORef $ eventSubscribedHeightRef s
671 when (h == invalidHeight) $ do
672 when (eventSubscribedHasOwnHeightRef s) $ liftIO $ writeIORef (eventSubscribedHeightRef s) $! invalidHeightBeingTraversed
674 mapM_ loop =<< liftIO (eventSubscribedGetParents s)
675 forM_ subscribers $ \s -> writeIORef (eventSubscribedHeightRef s) $! invalidHeight
679{-# INLINE subscribeHoldEvent #-}
680subscribeHoldEvent :: Hold x p -> Subscriber x p -> EventM x (EventSubscription x, Maybe p)
681subscribeHoldEvent = subscribeAndRead . holdEvent
683--------------------------------------------------------------------------------
685--------------------------------------------------------------------------------
687newtype Behavior x a = Behavior { readBehaviorTracked :: BehaviorM x a }
689behaviorHold :: Hold x p -> Behavior x (PatchTarget p)
690behaviorHold !h = Behavior $ readHoldTracked h
692behaviorHoldIdentity :: Hold x (Identity a) -> Behavior x a
693behaviorHoldIdentity = behaviorHold
695behaviorConst :: a -> Behavior x a
696behaviorConst !a = Behavior $ return a
698behaviorPull :: Pull x a -> Behavior x a
699behaviorPull !p = Behavior $ do
700 val <- liftIO $ readIORef $ pullValue p
702 Just subscribed -> do
703 askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (Some (BehaviorSubscribedPull subscribed)) :))
704 askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (pullSubscribedInvalidators subscribed) (wi:))
705 liftIO $ touch $ pullSubscribedOwnInvalidator subscribed
706 return $ pullSubscribedValue subscribed
708 i <- liftIO $ newInvalidatorPull p
709 wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorPull"
710 parentsRef <- liftIO $ newIORef []
711 holdInits <- askBehaviorHoldInits
712 a <- liftIO $ runReaderIO (unBehaviorM $ pullCompute p) (Just (wi, parentsRef), holdInits)
713 invsRef <- liftIO . newIORef . maybeToList =<< askInvalidator
714 parents <- liftIO $ readIORef parentsRef
715 let subscribed = PullSubscribed
716 { pullSubscribedValue = a
717 , pullSubscribedInvalidators = invsRef
718 , pullSubscribedOwnInvalidator = i
719 , pullSubscribedParents = parents
721 liftIO $ writeIORef (pullValue p) $ Just subscribed
722 askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (Some (BehaviorSubscribedPull subscribed)) :))
725behaviorDyn :: Patch p => Dyn x p -> Behavior x (PatchTarget p)
726behaviorDyn !d = Behavior $ readHoldTracked =<< getDynHold d
728{-# INLINE readHoldTracked #-}
729readHoldTracked :: Hold x p -> BehaviorM x (PatchTarget p)
730readHoldTracked h = do
731 result <- liftIO $ readIORef $ holdValue h
732 askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (holdInvalidators h) (wi:))
733 askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (Some (BehaviorSubscribedHold h)) :))
734 liftIO $ touch h -- Otherwise, if this gets inlined enough, the hold's parent reference may get collected
737{-# INLINABLE readBehaviorUntracked #-}
738readBehaviorUntracked :: Defer (SomeHoldInit x) m => Behavior x a -> m a
739readBehaviorUntracked b = do
740 holdInits <- getDeferralQueue
741 liftIO $ runBehaviorM (readBehaviorTracked b) Nothing holdInits --TODO: Specialize readBehaviorTracked to the Nothing and Just cases
743--------------------------------------------------------------------------------
745--------------------------------------------------------------------------------
747type DynamicS x p = Dynamic x (PatchTarget p) p
749data Dynamic x target p = Dynamic
750 { dynamicCurrent :: !(Behavior x target)
751 , dynamicUpdated :: Event x p -- This must be lazy; see the comment on holdEvent --TODO: Would this let us eliminate `Dyn`?
754deriving instance (HasSpiderTimeline x) => Functor (Dynamic x target)
759dynamicHold :: Hold x p -> DynamicS x p
760dynamicHold !h = Dynamic
761 { dynamicCurrent = behaviorHold h
762 , dynamicUpdated = eventHold h
765dynamicHoldIdentity :: Hold x (Identity a) -> DynamicS x (Identity a)
766dynamicHoldIdentity = dynamicHold
768dynamicConst :: PatchTarget p -> DynamicS x p
769dynamicConst !a = Dynamic
770 { dynamicCurrent = behaviorConst a
771 , dynamicUpdated = eventNever
774dynamicDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> DynamicS x p
775dynamicDyn !d = Dynamic
776 { dynamicCurrent = behaviorDyn d
777 , dynamicUpdated = eventDyn d
780dynamicDynIdentity :: HasSpiderTimeline x => Dyn x (Identity a) -> DynamicS x (Identity a)
781dynamicDynIdentity = dynamicDyn
783--------------------------------------------------------------------------------
785--------------------------------------------------------------------------------
787--type role Hold representational
789 = Hold { holdValue :: !(IORef (PatchTarget p))
790 , holdInvalidators :: !(IORef [Weak (Invalidator x)])
791 , holdEvent :: Event x p -- This must be lazy, or holds cannot be defined before their input Events
792 , holdParent :: !(IORef (Maybe (EventSubscription x))) -- Keeps its parent alive (will be undefined until the hold is initialized) --TODO: Probably shouldn't be an IORef
798-- | A statically allocated 'SpiderTimeline'
801{-# NOINLINE globalSpiderTimelineEnv #-}
802globalSpiderTimelineEnv :: SpiderTimelineEnv Global
803globalSpiderTimelineEnv = unsafePerformIO unsafeNewSpiderTimelineEnv
805-- | Stores all global data relevant to a particular Spider timeline; only one
806-- value should exist for each type @x@
807newtype SpiderTimelineEnv x = STE {unSTE :: SpiderTimelineEnv' x}
808-- We implement SpiderTimelineEnv with a newtype wrapper so
809-- we can get the coercions we want safely.
810type role SpiderTimelineEnv nominal
812data SpiderTimelineEnv' x = SpiderTimelineEnv
813 { _spiderTimeline_lock :: {-# UNPACK #-} !(MVar ())
814 , _spiderTimeline_eventEnv :: {-# UNPACK #-} !(EventEnv x)
816 , _spiderTimeline_depth :: {-# UNPACK #-} !(IORef Int)
819type role SpiderTimelineEnv' phantom
821instance Eq (SpiderTimelineEnv x) where
822 _ == _ = True -- Since only one exists of each type
824instance GEq SpiderTimelineEnv where
825 a `geq` b = if _spiderTimeline_lock (unSTE a) == _spiderTimeline_lock (unSTE b)
826 then Just $ unsafeCoerce Refl -- This unsafeCoerce is safe because the same SpiderTimelineEnv can't have two different 'x' arguments
830 = EventEnv { eventEnvAssignments :: !(IORef [SomeAssignment x]) -- Needed for Subscribe
831 , eventEnvHoldInits :: !(IORef [SomeHoldInit x]) -- Needed for Subscribe
832 , eventEnvDynInits :: !(IORef [SomeDynInit x])
833 , eventEnvMergeUpdates :: !(IORef [SomeMergeUpdate x])
834 , eventEnvMergeInits :: !(IORef [SomeMergeInit x]) -- Needed for Subscribe
835 , eventEnvClears :: !(IORef [Some Clear]) -- Needed for Subscribe
836 , eventEnvIntClears :: !(IORef [Some IntClear])
837 , eventEnvRootClears :: !(IORef [Some RootClear])
838 , eventEnvCurrentHeight :: !(IORef Height) -- Needed for Subscribe
839 , eventEnvResetCoincidences :: !(IORef [SomeResetCoincidence x]) -- Needed for Subscribe
840 , eventEnvDelayedMerges :: !(IORef (IntMap [EventM x ()]))
843{-# INLINE runEventM #-}
844runEventM :: EventM x a -> IO a
847asksEventEnv :: forall x a. HasSpiderTimeline x => (EventEnv x -> a) -> EventM x a
848asksEventEnv f = return $ f $ _spiderTimeline_eventEnv (unSTE (spiderTimeline :: SpiderTimelineEnv x))
850class MonadIO m => Defer a m where
851 getDeferralQueue :: m (IORef [a])
854defer :: Defer a m => a -> m ()
856 q <- getDeferralQueue
857 liftIO $ modifyIORef' q (a:)
859instance HasSpiderTimeline x => Defer (SomeAssignment x) (EventM x) where
860 {-# INLINE getDeferralQueue #-}
861 getDeferralQueue = asksEventEnv eventEnvAssignments
863instance HasSpiderTimeline x => Defer (SomeHoldInit x) (EventM x) where
864 {-# INLINE getDeferralQueue #-}
865 getDeferralQueue = asksEventEnv eventEnvHoldInits
867instance HasSpiderTimeline x => Defer (SomeDynInit x) (EventM x) where
868 {-# INLINE getDeferralQueue #-}
869 getDeferralQueue = asksEventEnv eventEnvDynInits
871instance Defer (SomeHoldInit x) (BehaviorM x) where
872 {-# INLINE getDeferralQueue #-}
873 getDeferralQueue = BehaviorM $ asks snd
875instance HasSpiderTimeline x => Defer (SomeMergeUpdate x) (EventM x) where
876 {-# INLINE getDeferralQueue #-}
877 getDeferralQueue = asksEventEnv eventEnvMergeUpdates
879instance HasSpiderTimeline x => Defer (SomeMergeInit x) (EventM x) where
880 {-# INLINE getDeferralQueue #-}
881 getDeferralQueue = asksEventEnv eventEnvMergeInits
883class HasSpiderTimeline x => HasCurrentHeight x m | m -> x where
884 getCurrentHeight :: m Height
885 scheduleMerge :: Height -> EventM x () -> m ()
887instance HasSpiderTimeline x => HasCurrentHeight x (EventM x) where
888 {-# INLINE getCurrentHeight #-}
889 getCurrentHeight = do
890 heightRef <- asksEventEnv eventEnvCurrentHeight
891 liftIO $ readIORef heightRef
892 {-# INLINE scheduleMerge #-}
893 scheduleMerge height subscribed = do
894 delayedRef <- asksEventEnv eventEnvDelayedMerges
895 liftIO $ modifyIORef' delayedRef $ IntMap.insertWith (++) (unHeight height) [subscribed]
897class HasSpiderTimeline x where
898 -- | Retrieve the current SpiderTimelineEnv
899 spiderTimeline :: SpiderTimelineEnv x
901instance HasSpiderTimeline Global where
902 spiderTimeline = globalSpiderTimelineEnv
904putCurrentHeight :: HasSpiderTimeline x => Height -> EventM x ()
905putCurrentHeight h = do
906 heightRef <- asksEventEnv eventEnvCurrentHeight
907 liftIO $ writeIORef heightRef $! h
909instance HasSpiderTimeline x => Defer (Some Clear) (EventM x) where
910 {-# INLINE getDeferralQueue #-}
911 getDeferralQueue = asksEventEnv eventEnvClears
913{-# INLINE scheduleClear #-}
914scheduleClear :: Defer (Some Clear) m => IORef (Maybe a) -> m ()
915scheduleClear r = defer $ Some $ Clear r
917instance HasSpiderTimeline x => Defer (Some IntClear) (EventM x) where
918 {-# INLINE getDeferralQueue #-}
919 getDeferralQueue = asksEventEnv eventEnvIntClears
921{-# INLINE scheduleIntClear #-}
922scheduleIntClear :: Defer (Some IntClear) m => IORef (IntMap a) -> m ()
923scheduleIntClear r = defer $ Some $ IntClear r
925instance HasSpiderTimeline x => Defer (Some RootClear) (EventM x) where
926 {-# INLINE getDeferralQueue #-}
927 getDeferralQueue = asksEventEnv eventEnvRootClears
929{-# INLINE scheduleRootClear #-}
930scheduleRootClear :: Defer (Some RootClear) m => IORef (DMap k Identity) -> m ()
931scheduleRootClear r = defer $ Some $ RootClear r
933instance HasSpiderTimeline x => Defer (SomeResetCoincidence x) (EventM x) where
934 {-# INLINE getDeferralQueue #-}
935 getDeferralQueue = asksEventEnv eventEnvResetCoincidences
937-- Note: hold cannot examine its event until after the phase is over
938{-# INLINE [1] hold #-}
939hold :: (Patch p, Defer (SomeHoldInit x) m) => PatchTarget p -> Event x p -> m (Hold x p)
941 valRef <- liftIO $ newIORef v0
942 invsRef <- liftIO $ newIORef []
943 parentRef <- liftIO $ newIORef Nothing
945 nodeId <- liftIO newNodeId
949 , holdInvalidators = invsRef
951 , holdParent = parentRef
953 , holdNodeId = nodeId
956 defer $ SomeHoldInit h
959{-# INLINE getHoldEventSubscription #-}
960getHoldEventSubscription :: forall p x. (HasSpiderTimeline x, Patch p) => Hold x p -> EventM x (EventSubscription x)
961getHoldEventSubscription h = do
962 ep <- liftIO $ readIORef $ holdParent h
964 Just subd -> return subd
967 subscriptionRef <- liftIO $ newIORef $ error "getHoldEventSubscription: subdRef uninitialized"
968 (subscription@(EventSubscription _ _), occ) <- subscribeAndRead e =<< liftIO (newSubscriberHold h)
969 liftIO $ writeIORef subscriptionRef $! subscription
973 old <- liftIO $ readIORef $ holdValue h
977 -- Need to evaluate these so that we don't retain the Hold itself
978 v <- liftIO $ evaluate $ holdValue h
979 i <- liftIO $ evaluate $ holdInvalidators h
980 defer $ SomeAssignment v i new
981 liftIO $ writeIORef (holdParent h) $ Just subscription
984type BehaviorEnv x = (Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]), IORef [SomeHoldInit x])
986-- BehaviorM can sample behaviors
987newtype BehaviorM x a = BehaviorM { unBehaviorM :: ReaderIO (BehaviorEnv x) a }
988 deriving (Functor, Applicative, MonadIO, MonadFix, MonadReader (BehaviorEnv x))
990instance Monad (BehaviorM x) where
992 BehaviorM x >>= f = BehaviorM $ x >>= unBehaviorM . f
994 BehaviorM x >> BehaviorM y = BehaviorM $ x >> y
995 {-# INLINE return #-}
996 return x = BehaviorM $ return x
997#if !MIN_VERSION_base(4,13,0)
999 fail s = BehaviorM $ fail s
1002data BehaviorSubscribed x a
1003 = forall p. BehaviorSubscribedHold (Hold x p)
1004 | BehaviorSubscribedPull (PullSubscribed x a)
1006newtype SomeBehaviorSubscribed x = SomeBehaviorSubscribed (Some (BehaviorSubscribed x))
1008--type role PullSubscribed representational
1009data PullSubscribed x a
1010 = PullSubscribed { pullSubscribedValue :: !a
1011 , pullSubscribedInvalidators :: !(IORef [Weak (Invalidator x)])
1012 , pullSubscribedOwnInvalidator :: !(Invalidator x)
1013 , pullSubscribedParents :: ![SomeBehaviorSubscribed x] -- Need to keep parent behaviors alive, or they won't let us know when they're invalidated
1016--type role Pull representational
1018 = Pull { pullValue :: !(IORef (Maybe (PullSubscribed x a)))
1019 , pullCompute :: !(BehaviorM x a)
1026 = forall a. InvalidatorPull (Pull x a)
1027 | forall a. InvalidatorSwitch (SwitchSubscribed x a)
1029data RootSubscribed x a = forall k. GCompare k => RootSubscribed
1030 { rootSubscribedKey :: !(k a)
1031 , rootSubscribedCachedSubscribed :: !(IORef (DMap k (RootSubscribed x))) -- From the original Root
1032 , rootSubscribedSubscribers :: !(WeakBag (Subscriber x a))
1033 , rootSubscribedOccurrence :: !(IO (Maybe a)) -- Lookup from rootOccurrence
1034 , rootSubscribedUninit :: IO ()
1035 , rootSubscribedWeakSelf :: !(IORef (Weak (RootSubscribed x a))) --TODO: Can we make this a lazy non-IORef and then force it manually to avoid an indirection each time we use it?
1037 , rootSubscribedNodeId :: Int
1042 = Root { rootOccurrence :: !(IORef (DMap k Identity)) -- The currently-firing occurrence of this event
1043 , rootSubscribed :: !(IORef (DMap k (RootSubscribed x)))
1044 , rootInit :: !(forall a. k a -> RootTrigger x a -> IO (IO ()))
1047data SomeHoldInit x = forall p. Patch p => SomeHoldInit !(Hold x p)
1049data SomeDynInit x = forall p. Patch p => SomeDynInit !(Dyn x p)
1051data SomeMergeUpdate x = SomeMergeUpdate
1052 { _someMergeUpdate_update :: !(EventM x [EventSubscription x])
1053 , _someMergeUpdate_invalidateHeight :: !(IO ())
1054 , _someMergeUpdate_recalculateHeight :: !(IO ())
1057newtype SomeMergeInit x = SomeMergeInit { unSomeMergeInit :: EventM x () }
1059-- EventM can do everything BehaviorM can, plus create holds
1060newtype EventM x a = EventM { unEventM :: IO a } deriving (Functor, Applicative, Monad, MonadIO, MonadFix, MonadException, MonadAsyncException)
1062newtype MergeSubscribedParent x a = MergeSubscribedParent { unMergeSubscribedParent :: EventSubscription x }
1064data MergeSubscribedParentWithMove x k a = MergeSubscribedParentWithMove
1065 { _mergeSubscribedParentWithMove_subscription :: !(EventSubscription x)
1066 , _mergeSubscribedParentWithMove_key :: !(IORef (k a))
1069data HeightBag = HeightBag
1070 { _heightBag_size :: {-# UNPACK #-} !Int
1071 , _heightBag_contents :: !(IntMap Word) -- Number of excess in each bucket
1073 deriving (Show, Read, Eq, Ord)
1075heightBagEmpty :: HeightBag
1076heightBagEmpty = heightBagVerify $ HeightBag 0 IntMap.empty
1078heightBagSize :: HeightBag -> Int
1079heightBagSize = _heightBag_size
1081heightBagFromList :: [Height] -> HeightBag
1082heightBagFromList heights = heightBagVerify $ foldl' (flip heightBagAdd) heightBagEmpty heights
1084heightBagAdd :: Height -> HeightBag -> HeightBag
1085heightBagAdd (Height h) (HeightBag s c) = heightBagVerify $ HeightBag (succ s) $
1086 IntMap.insertWithKey (\_ _ old -> succ old) h 0 c
1088heightBagRemove :: Height -> HeightBag -> HeightBag
1089heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.lookup h c of
1090 Nothing -> error $ "heightBagRemove: Height " <> show h <> " not present in bag " <> show b
1091 Just old -> HeightBag (pred s) $ case old of
1092 0 -> IntMap.delete h c
1093 _ -> IntMap.insert h (pred old) c
1095heightBagRemoveMaybe :: Height -> HeightBag -> Maybe HeightBag
1096heightBagRemoveMaybe (Height h) b@(HeightBag s c) = heightBagVerify . removed <$> IntMap.lookup h c where
1097 removed old = HeightBag (pred s) $ case old of
1098 0 -> IntMap.delete h c
1099 _ -> IntMap.insert h (pred old) c
1102heightBagMax :: HeightBag -> Height
1103heightBagMax (HeightBag _ c) = case IntMap.maxViewWithKey c of
1104 Just ((h, _), _) -> Height h
1105 Nothing -> zeroHeight
1107heightBagVerify :: HeightBag -> HeightBag
1109heightBagVerify b@(HeightBag s c) = if
1110 | s /= IntMap.size c + fromIntegral (sum (IntMap.elems c))
1111 -> error $ "heightBagVerify: size doesn't match: " <> show b
1112 | unHeight invalidHeight `IntMap.member` c
1113 -> error $ "heightBagVerify: contains invalid height: " <> show b
1119data FanSubscribedChildren x k v a = FanSubscribedChildren
1120 { _fanSubscribedChildren_list :: !(WeakBag (Subscriber x (v a)))
1121 , _fanSubscribedChildren_self :: {-# NOUNPACK #-} !(k a, FanSubscribed x k v)
1122 , _fanSubscribedChildren_weakSelf :: !(IORef (Weak (k a, FanSubscribed x k v)))
1125data FanSubscribed x k v
1126 = FanSubscribed { fanSubscribedCachedSubscribed :: !(IORef (Maybe (FanSubscribed x k v)))
1127 , fanSubscribedOccurrence :: !(IORef (Maybe (DMap k v)))
1128 , fanSubscribedSubscribers :: !(IORef (DMap k (FanSubscribedChildren x k v))) -- This DMap should never be empty
1129 , fanSubscribedParent :: !(EventSubscription x)
1131 , fanSubscribedNodeId :: Int
1136 = Fan { fanParent :: !(Event x (DMap k v))
1137 , fanSubscribed :: !(IORef (Maybe (FanSubscribed x k v)))
1140data SwitchSubscribed x a
1141 = SwitchSubscribed { switchSubscribedCachedSubscribed :: !(IORef (Maybe (SwitchSubscribed x a)))
1142 , switchSubscribedOccurrence :: !(IORef (Maybe a))
1143 , switchSubscribedHeight :: !(IORef Height)
1144 , switchSubscribedSubscribers :: !(WeakBag (Subscriber x a))
1145 , switchSubscribedOwnInvalidator :: {-# NOUNPACK #-} !(Invalidator x)
1146 , switchSubscribedOwnWeakInvalidator :: !(IORef (Weak (Invalidator x)))
1147 , switchSubscribedBehaviorParents :: !(IORef [SomeBehaviorSubscribed x])
1148 , switchSubscribedParent :: !(Behavior x (Event x a))
1149 , switchSubscribedCurrentParent :: !(IORef (EventSubscription x))
1150 , switchSubscribedWeakSelf :: !(IORef (Weak (SwitchSubscribed x a)))
1152 , switchSubscribedNodeId :: Int
1157 = Switch { switchParent :: !(Behavior x (Event x a))
1158 , switchSubscribed :: !(IORef (Maybe (SwitchSubscribed x a)))
1161#ifdef USE_TEMPLATE_HASKELL
1162{-# ANN CoincidenceSubscribed "HLint: ignore Redundant bracket" #-}
1164data CoincidenceSubscribed x a
1165 = CoincidenceSubscribed { coincidenceSubscribedCachedSubscribed :: !(IORef (Maybe (CoincidenceSubscribed x a)))
1166 , coincidenceSubscribedOccurrence :: !(IORef (Maybe a))
1167 , coincidenceSubscribedSubscribers :: !(WeakBag (Subscriber x a))
1168 , coincidenceSubscribedHeight :: !(IORef Height)
1169 , coincidenceSubscribedOuter :: {-# NOUNPACK #-} (Subscriber x (Event x a))
1170 , coincidenceSubscribedOuterParent :: !(EventSubscription x)
1171 , coincidenceSubscribedInnerParent :: !(IORef (Maybe (EventSubscribed x)))
1172 , coincidenceSubscribedWeakSelf :: !(IORef (Weak (CoincidenceSubscribed x a)))
1174 , coincidenceSubscribedNodeId :: Int
1179 = Coincidence { coincidenceParent :: !(Event x (Event x a))
1180 , coincidenceSubscribed :: !(IORef (Maybe (CoincidenceSubscribed x a)))
1183{-# NOINLINE newInvalidatorSwitch #-}
1184newInvalidatorSwitch :: SwitchSubscribed x a -> IO (Invalidator x)
1185newInvalidatorSwitch subd = return $! InvalidatorSwitch subd
1187{-# NOINLINE newInvalidatorPull #-}
1188newInvalidatorPull :: Pull x a -> IO (Invalidator x)
1189newInvalidatorPull p = return $! InvalidatorPull p
1191instance HasSpiderTimeline x => Filterable (Event x) where
1192 mapMaybe f = push $ return . f
1194instance HasSpiderTimeline x => Align (Event x) where
1196#if MIN_VERSION_these(0, 8, 0)
1197instance HasSpiderTimeline x => Semialign (Event x) where
1199 align ea eb = mapMaybe dmapToThese $ mergeG coerce $ dynamicConst $
1200 DMap.fromDistinctAscList [LeftTag :=> ea, RightTag :=> eb]
1202#ifdef MIN_VERSION_semialign
1203#if MIN_VERSION_semialign(1,1,0)
1204instance HasSpiderTimeline x => Zip (Event x) where
1206 zip x y = mapMaybe justThese $ align x y
1209data DynType x p = UnsafeDyn !(BehaviorM x (PatchTarget p), Event x p)
1210 | BuildDyn !(EventM x (PatchTarget p), Event x p)
1211 | HoldDyn !(Hold x p)
1213newtype Dyn (x :: Type) p = Dyn { unDyn :: IORef (DynType x p) }
1215newMapDyn :: HasSpiderTimeline x => (a -> b) -> DynamicS x (Identity a) -> DynamicS x (Identity b)
1216newMapDyn f d = dynamicDynIdentity $ unsafeBuildDynamic (fmap f $ readBehaviorTracked $ dynamicCurrent d) (Identity . f . runIdentity <$> dynamicUpdated d)
1218--TODO: Avoid the duplication between this and R.zipDynWith
1219zipDynWith :: HasSpiderTimeline x => (a -> b -> c) -> DynamicS x (Identity a) -> DynamicS x (Identity b) -> DynamicS x (Identity c)
1221 let eab = align (dynamicUpdated da) (dynamicUpdated db)
1222 ec = flip push eab $ \o -> do
1224 This (Identity a) -> do
1225 b <- readBehaviorUntracked $ dynamicCurrent db
1227 That (Identity b) -> do
1228 a <- readBehaviorUntracked $ dynamicCurrent da
1230 These (Identity a) (Identity b) -> return (a, b)
1231 return $ Just $ Identity $ f a b
1232 in dynamicDynIdentity $ unsafeBuildDynamic (f <$> readBehaviorUntracked (dynamicCurrent da) <*> readBehaviorUntracked (dynamicCurrent db)) ec
1234buildDynamic :: (Defer (SomeDynInit x) m, Patch p) => EventM x (PatchTarget p) -> Event x p -> m (Dyn x p)
1235buildDynamic readV0 v' = do
1236 result <- liftIO $ newIORef $ BuildDyn (readV0, v')
1238 defer $ SomeDynInit d
1241unsafeBuildDynamic :: BehaviorM x (PatchTarget p) -> Event x p -> Dyn x p
1242unsafeBuildDynamic readV0 v' =
1243 Dyn $ unsafePerformIO $ newIORef $ UnsafeDyn (readV0, v')
1245-- ResultM can read behaviors and events
1246type ResultM = EventM
1248instance HasSpiderTimeline x => Functor (Event x) where
1249 fmap f = push $ return . Just . f
1251instance Functor (Behavior x) where
1252 fmap f = pull . fmap f . readBehaviorTracked
1255push :: HasSpiderTimeline x => (a -> ComputeM x (Maybe b)) -> Event x a -> Event x b
1256push f e = cacheEvent (pushCheap f e)
1258{-# INLINABLE pull #-}
1259pull :: BehaviorM x a -> Behavior x a
1260pull a = unsafePerformIO $ do
1261 ref <- newIORef Nothing
1265 pure $ behaviorPull $ Pull
1273{-# INLINABLE switch #-}
1274switch :: HasSpiderTimeline x => Behavior x (Event x a) -> Event x a
1275switch a = unsafePerformIO $ do
1276 ref <- newIORef Nothing
1277 pure $ eventSwitch $ Switch
1279 , switchSubscribed = ref
1282coincidence :: HasSpiderTimeline x => Event x (Event x a) -> Event x a
1283coincidence a = unsafePerformIO $ do
1284 ref <- newIORef Nothing
1285 pure $ eventCoincidence $ Coincidence
1286 { coincidenceParent = a
1287 , coincidenceSubscribed = ref
1290-- Propagate the given event occurrence; before cleaning up, run the given action, which may read the state of events and behaviors
1291run :: forall x b. HasSpiderTimeline x => [DSum (RootTrigger x) Identity] -> ResultM x b -> SpiderHost x b
1293 tracePropagate (Proxy :: Proxy x) $ "Running an event frame with " <> show (length roots) <> " events"
1294 let t = spiderTimeline :: SpiderTimelineEnv x
1295 result <- SpiderHost $ withMVar (_spiderTimeline_lock (unSTE t)) $ \_ -> unSpiderHost $ runFrame $ do
1296 rootsToPropagate <- forM roots $ \r@(RootTrigger (_, occRef, k) :=> a) -> do
1297 occBefore <- liftIO $ do
1298 occBefore <- readIORef occRef
1299 writeIORef occRef $! DMap.insert k a occBefore
1301 if DMap.null occBefore
1302 then do scheduleRootClear occRef
1305 forM_ (catMaybes rootsToPropagate) $ \(RootTrigger (subscribersRef, _, _) :=> Identity a) -> do
1306 propagate a subscribersRef
1307 delayedRef <- asksEventEnv eventEnvDelayedMerges
1309 delayed <- liftIO $ readIORef delayedRef
1310 case IntMap.minViewWithKey delayed of
1311 Nothing -> return ()
1312 Just ((currentHeight, cur), future) -> do
1313 tracePropagate (Proxy :: Proxy x) $ "Running height " ++ show currentHeight
1314 putCurrentHeight $ Height currentHeight
1315 liftIO $ writeIORef delayedRef $! future
1319 putCurrentHeight maxBound
1321 tracePropagate (Proxy :: Proxy x) "Done running an event frame"
1324scheduleMerge' :: HasSpiderTimeline x => Height -> IORef Height -> EventM x () -> EventM x ()
1325scheduleMerge' initialHeight heightRef a = scheduleMerge initialHeight $ do
1326 height <- liftIO $ readIORef heightRef
1327 currentHeight <- getCurrentHeight
1328 case height `compare` currentHeight of
1329 LT -> error "Somehow a merge's height has been decreased after it was scheduled"
1330 GT -> scheduleMerge' height heightRef a -- The height has been increased (by a coincidence event; TODO: is this the only way?)
1333newtype Clear a = Clear (IORef (Maybe a))
1335newtype IntClear a = IntClear (IORef (IntMap a))
1337newtype RootClear k = RootClear (IORef (DMap k Identity))
1339data SomeAssignment x = forall a. SomeAssignment {-# UNPACK #-} !(IORef a) {-# UNPACK #-} !(IORef [Weak (Invalidator x)]) a
1341debugFinalize :: Bool
1342debugFinalize = False
1344mkWeakPtrWithDebug :: a -> String -> IO (Weak a)
1345mkWeakPtrWithDebug x debugNote = do
1349 then Just $ debugStrLn $ "finalizing: " ++ debugNote
1352type WeakList a = [Weak a]
1354type CanTrace x m = (HasSpiderTimeline x, MonadIO m)
1361debugSubscriber :: forall x a. HasSpiderTimeline x => String -> Subscriber x a -> IO (Subscriber x a)
1362debugSubscriber description = return . debugSubscriber' description
1364debugSubscriber' :: forall x a. HasSpiderTimeline x => String -> Subscriber x a -> Subscriber x a
1365debugSubscriber' description subscribed = Subscriber
1367 subscriberPropagate = \m -> do
1368 tracePropagate (Proxy :: Proxy x) ("subscriberPropagate: " <> description)
1369 subscriberPropagate subscribed m
1370 , subscriberInvalidateHeight = \old -> do
1371 traceInvalidateHeight $ "invalidateSubscriberHeight: " <> description <> ", old = " <> show (unHeight old)
1372 subscriberInvalidateHeight subscribed old
1373 traceInvalidateHeight $ "invalidateSubscriberHeight: " <> description <> ", done"
1374 , subscriberRecalculateHeight = \new -> do
1375 traceInvalidateHeight $ "subscriberRecalculateHeight: " <> description <> ", new = " <> show (unHeight new)
1376 subscriberRecalculateHeight subscribed new
1377 traceInvalidateHeight $ "subscriberRecalculateHeight: " <> description <> ", done"
1381{-# INLINE withIncreasedDepth #-}
1382withIncreasedDepth :: forall proxy x m a. CanTrace x m => proxy x -> m a -> m a
1383withIncreasedDepth _ a = do
1384 liftIO $ modifyIORef' (_spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)) succ
1386 liftIO $ modifyIORef' (_spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)) pred
1389{-# INLINE tracePropagate #-}
1390tracePropagate :: (CanTrace x m) => proxy x -> String -> m ()
1391tracePropagate p = when debugPropagate . trace p
1393{-# INLINE traceInvalidate #-}
1394traceInvalidate :: String -> IO ()
1395traceInvalidate = when debugInvalidate . liftIO . debugStrLn
1397{-# INLINE traceInvalidateHeight #-}
1398traceInvalidateHeight :: String -> IO ()
1399traceInvalidateHeight = when debugInvalidateHeight . liftIO . debugStrLn
1402trace :: (CanTrace x m) => proxy x -> String -> m ()
1403trace p message = traceM p $ return message
1405{-# INLINE traceM #-}
1406traceM :: forall x proxy m. (CanTrace x m) => proxy x -> m String -> m ()
1407traceM _ getMessage = do
1408 message <- getMessage
1409 d <- liftIO $ readIORef $ _spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)
1410 liftIO $ debugStrLn $ replicate d ' ' <> message
1414{-# INLINE withIncreasedDepth #-}
1415withIncreasedDepth :: proxy x -> m a -> m a
1416withIncreasedDepth _ = id
1418{-# INLINE tracePropagate #-}
1419tracePropagate :: (CanTrace x m) => proxy x -> String -> m ()
1420tracePropagate _ _ = return ()
1422{-# INLINE traceInvalidate #-}
1423traceInvalidate :: String -> IO ()
1424traceInvalidate _ = return ()
1426{-# INLINE traceInvalidateHeight #-}
1427traceInvalidateHeight :: String -> IO ()
1428traceInvalidateHeight _ = return ()
1430{-# INLINE debugSubscriber #-}
1431debugSubscriber :: String -> Subscriber x a -> IO (Subscriber x a)
1432debugSubscriber _ = return
1434{-# INLINE debugSubscriber' #-}
1435debugSubscriber' :: String -> Subscriber x a -> Subscriber x a
1436debugSubscriber' _ = id
1441trace :: (CanTrace x m) => proxy x -> String -> m ()
1442trace _ _ = return ()
1444{-# INLINE traceM #-}
1445traceM :: (CanTrace x m) => proxy x -> m String -> m ()
1446traceM _ _ = return ()
1450whoCreatedIORef :: IORef a -> IO [String]
1451whoCreatedIORef (IORef a) = whoCreated $! a
1453groupByHead :: Eq a => [NonEmpty a] -> [(a, NonEmpty [a])]
1456 (x :| xs) : t -> case groupByHead t of
1457 [] -> [(x, xs :| [])]
1459 | x == y -> (x, xs `NonEmpty.cons` yss) : t'
1460 | otherwise -> (x, xs :| []) : l
1462listsToForest :: Eq a => [[a]] -> Forest a
1463listsToForest lists = buildForest <$> groupByHead (mapMaybe nonEmpty lists)
1464 where buildForest (a, lists') = Node a $ listsToForest $ toList lists'
1466showStacks :: [[String]] -> String
1467showStacks = drawForest . listsToForest . fmap (filterStack "Reflex.Spider.Internal")
1469filterStack :: String -> [String] -> [String]
1470#ifdef DEBUG_HIDE_INTERNALS
1471filterStack prefix = filter (not . (prefix `isPrefixOf`))
1473filterStack prefix = id
1478data EventLoopException = EventLoopException [[String]]
1479instance Exception EventLoopException
1481instance Show EventLoopException where
1482 show (EventLoopException stacks) = "causality loop detected:\n" <> if null stacks
1483 then "no location information, compile with profiling enabled for stack tree"
1484 else showStacks stacks
1488data EventLoopException = EventLoopException
1489instance Exception EventLoopException
1491instance Show EventLoopException where
1492 show EventLoopException = "causality loop detected: \n" <>
1493 "compile reflex with flag 'debug-cycles' and compile with profiling enabled for stack tree"
1498{-# INLINE propagateSubscriberHold #-}
1499propagateSubscriberHold :: forall x p. (HasSpiderTimeline x, Patch p) => Hold x p -> p -> EventM x ()
1500propagateSubscriberHold h a = do
1501 {-# SCC "trace" #-} when debugPropagate $ traceM (Proxy :: Proxy x) $ liftIO $ do
1502 invalidators <- liftIO $ readIORef $ holdInvalidators h
1503 return $ "SubscriberHold" <> showNodeId h <> ": " ++ show (length invalidators)
1505 v <- {-# SCC "read" #-} liftIO $ readIORef $ holdValue h
1506 case {-# SCC "apply" #-} apply a v of
1507 Nothing -> return ()
1509 {-# SCC "trace2" #-} withIncreasedDepth (Proxy :: Proxy x) $
1510 tracePropagate (Proxy :: Proxy x) ("propagateSubscriberHold: assigning Hold" <> showNodeId h)
1511 vRef <- {-# SCC "vRef" #-} liftIO $ evaluate $ holdValue h
1512 iRef <- {-# SCC "iRef" #-} liftIO $ evaluate $ holdInvalidators h
1513 defer $ {-# SCC "assignment" #-} SomeAssignment vRef iRef v'
1515data SomeResetCoincidence x = forall a. SomeResetCoincidence !(EventSubscription x) !(Maybe (CoincidenceSubscribed x a)) -- The CoincidenceSubscriber will be present only if heights need to be reset
1517runBehaviorM :: BehaviorM x a -> Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]) -> IORef [SomeHoldInit x] -> IO a
1518runBehaviorM a mwi holdInits = runReaderIO (unBehaviorM a) (mwi, holdInits)
1520askInvalidator :: BehaviorM x (Maybe (Weak (Invalidator x)))
1524 Nothing -> return Nothing
1525 Just (!wi, _) -> return $ Just wi
1527askParentsRef :: BehaviorM x (Maybe (IORef [SomeBehaviorSubscribed x]))
1531 Nothing -> return Nothing
1532 Just (_, !p) -> return $ Just p
1534askBehaviorHoldInits :: BehaviorM x (IORef [SomeHoldInit x])
1535askBehaviorHoldInits = do
1539{-# INLINE getDynHold #-}
1540getDynHold :: (Defer (SomeHoldInit x) m, Patch p) => Dyn x p -> m (Hold x p)
1542 mh <- liftIO $ readIORef $ unDyn d
1544 HoldDyn h -> return h
1545 UnsafeDyn (readV0, v') -> do
1546 holdInits <- getDeferralQueue
1547 v0 <- liftIO $ runBehaviorM readV0 Nothing holdInits
1549 BuildDyn (readV0, v') -> do
1550 v0 <- liftIO $ runEventM readV0
1555 liftIO $ writeIORef (unDyn d) $ HoldDyn h
1559-- Always refers to 0
1560{-# NOINLINE zeroRef #-}
1561zeroRef :: IORef Height
1562zeroRef = unsafePerformIO $ newIORef zeroHeight
1564getRootSubscribed :: forall k x a. (GCompare k, HasSpiderTimeline x) => k a -> Root x k -> Subscriber x a -> IO (WeakBagTicket, RootSubscribed x a, Maybe a)
1565getRootSubscribed k r sub = do
1566 mSubscribed <- readIORef $ rootSubscribed r
1567 let getOcc = fmap (coerce . DMap.lookup k) $ readIORef $ rootOccurrence r
1568 case DMap.lookup k mSubscribed of
1569 Just subscribed -> {-# SCC "hitRoot" #-} do
1570 sln <- subscribeRootSubscribed subscribed sub
1572 return (sln, subscribed, occ)
1573 Nothing -> {-# SCC "missRoot" #-} do
1574 weakSelf <- newIORef $ error "getRootSubscribed: weakSelfRef not initialized"
1575 let !cached = rootSubscribed r
1576 uninitRef <- newIORef $ error "getRootsubscribed: uninitRef not initialized"
1577 (subs, sln) <- WeakBag.singleton sub weakSelf cleanupRootSubscribed
1579 tracePropagate (Proxy::Proxy x) $ "getRootSubscribed: calling rootInit"
1581 uninit <- rootInit r k $ RootTrigger (subs, rootOccurrence r, k)
1582 writeIORef uninitRef $! uninit
1586 let !subscribed = RootSubscribed
1587 { rootSubscribedKey = k
1588 , rootSubscribedCachedSubscribed = cached
1589 , rootSubscribedOccurrence = getOcc
1590 , rootSubscribedSubscribers = subs
1591 , rootSubscribedUninit = uninit
1592 , rootSubscribedWeakSelf = weakSelf
1594 , rootSubscribedNodeId = nid
1597 -- If we die at the same moment that all our children die, they will
1598 -- try to clean us up but will fail because their Weak reference to us
1599 -- will also be dead. So, if we are dying, check if there are any
1600 -- children; since children don't bother cleaning themselves up if
1601 -- their parents are already dead, I don't think there's a race
1602 -- condition here. However, if there are any children, then we can
1603 -- infer that we need to clean ourselves up, so we do.
1605 cs <- readIORef $ _weakBag_children subs
1606 when (not $ IntMap.null cs) (cleanupRootSubscribed subscribed)
1607 writeIORef weakSelf =<< evaluate =<< mkWeakPtr subscribed (Just finalCleanup)
1608 modifyIORef' (rootSubscribed r) $ DMap.insertWith (error $ "getRootSubscribed: duplicate key inserted into Root") k subscribed --TODO: I think we can just write back mSubscribed rather than re-reading it
1610 return (sln, subscribed, occ)
1612#ifdef USE_TEMPLATE_HASKELL
1613{-# ANN cleanupRootSubscribed "HLint: ignore Redundant bracket" #-}
1615cleanupRootSubscribed :: RootSubscribed x a -> IO ()
1616cleanupRootSubscribed self@RootSubscribed { rootSubscribedKey = k, rootSubscribedCachedSubscribed = cached } = do
1617 rootSubscribedUninit self
1618 modifyIORef' cached $ DMap.delete k
1620{-# INLINE subscribeRootSubscribed #-}
1621subscribeRootSubscribed :: RootSubscribed x a -> Subscriber x a -> IO WeakBagTicket
1622subscribeRootSubscribed subscribed sub = WeakBag.insert sub (rootSubscribedSubscribers subscribed) (rootSubscribedWeakSelf subscribed) cleanupRootSubscribed
1624newtype EventSelectorInt x a = EventSelectorInt { selectInt :: Int -> Event x a }
1626data FanInt x a = FanInt
1627 { _fanInt_subscribers :: {-# UNPACK #-} !(FastMutableIntMap (FastWeakBag (Subscriber x a))) --TODO: Clean up the keys in here when their child weak bags get empty --TODO: Remove our own subscription when the subscribers list is completely empty
1628 , _fanInt_subscriptionRef :: {-# UNPACK #-} !(IORef (EventSubscription x)) -- This should have a valid subscription iff subscribers is non-empty
1629 , _fanInt_occRef :: {-# UNPACK #-} !(IORef (IntMap a))
1631 , _fanInt_nodeId :: {-# UNPACK #-} !Int
1635newFanInt :: IO (FanInt x a)
1637 subscribers <- FastMutableIntMap.newEmpty --TODO: Clean up the keys in here when their child weak bags get empty --TODO: Remove our own subscription when the subscribers list is completely empty
1638 subscriptionRef <- newIORef $ error "fanInt: no subscription"
1639 occRef <- newIORef $ error "fanInt: no occurrence"
1644 { _fanInt_subscribers = subscribers
1645 , _fanInt_subscriptionRef = subscriptionRef
1646 , _fanInt_occRef = occRef
1648 , _fanInt_nodeId = nodeId
1652fanInt :: HasSpiderTimeline x => Event x (IntMap a) -> EventSelectorInt x a
1653fanInt p = unsafePerformIO $ do
1655 pure $ EventSelectorInt $ \k -> Event $ \sub -> do
1656 isEmpty <- liftIO $ FastMutableIntMap.isEmpty (_fanInt_subscribers self)
1657 when isEmpty $ do -- This is the first subscriber, so we need to subscribe to our input
1658 let desc = "fanInt" <> showNodeId self <> ", k = " <> show k
1659 (subscription, parentOcc) <- subscribeAndRead p $ debugSubscriber' desc $ Subscriber
1660 { subscriberPropagate = \m -> do
1661 liftIO $ writeIORef (_fanInt_occRef self) m
1662 scheduleIntClear $ _fanInt_occRef self
1663 FastMutableIntMap.forIntersectionWithImmutable_ (_fanInt_subscribers self) m $ \b v -> --TODO: Do we need to know that no subscribers are being added as we traverse?
1664 FastWeakBag.traverse_ b $ \s ->
1665 subscriberPropagate s v
1666 , subscriberInvalidateHeight = \old ->
1667 FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b ->
1668 FastWeakBag.traverse_ b $ \s ->
1669 subscriberInvalidateHeight s old
1670 , subscriberRecalculateHeight = \new ->
1671 FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b ->
1672 FastWeakBag.traverse_ b $ \s ->
1673 subscriberRecalculateHeight s new
1676 writeIORef (_fanInt_subscriptionRef self) subscription
1677 writeIORef (_fanInt_occRef self) $ fromMaybe IntMap.empty parentOcc
1678 scheduleIntClear $ _fanInt_occRef self
1680 b <- FastMutableIntMap.lookup (_fanInt_subscribers self) k >>= \case
1682 b <- FastWeakBag.empty
1683 FastMutableIntMap.insert (_fanInt_subscribers self) k b
1686 ticket <- liftIO $ FastWeakBag.insert sub b
1687 currentOcc <- readIORef (_fanInt_occRef self)
1689 subscribed <- fanIntSubscribed ticket self
1690 return (EventSubscription (FastWeakBag.remove ticket) subscribed, IntMap.lookup k currentOcc)
1692fanIntSubscribed :: FastWeakBagTicket k -> FanInt x a -> IO (EventSubscribed x)
1693fanIntSubscribed ticket self = do
1694 subscribedParent <- _eventSubscription_subscribed <$> readIORef (_fanInt_subscriptionRef self)
1695 return $ EventSubscribed
1696 { eventSubscribedHeightRef = eventSubscribedHeightRef subscribedParent
1697 , eventSubscribedRetained = toAny (_fanInt_subscriptionRef self, ticket)
1699 , eventSubscribedGetParents = return [subscribedParent]
1700 , eventSubscribedHasOwnHeightRef = False
1701 , eventSubscribedWhoCreated = whoCreatedIORef $ _fanInt_subscriptionRef self
1706{-# INLINABLE getFanSubscribed #-}
1707getFanSubscribed :: (HasSpiderTimeline x, GCompare k) => k a -> Fan x k v -> Subscriber x (v a) -> EventM x (WeakBagTicket, FanSubscribed x k v, Maybe (v a))
1708getFanSubscribed k f sub = do
1709 mSubscribed <- liftIO $ readIORef $ fanSubscribed f
1711 Just subscribed -> {-# SCC "hitFan" #-} liftIO $ do
1712 sln <- subscribeFanSubscribed k subscribed sub
1713 occ <- readIORef $ fanSubscribedOccurrence subscribed
1714 return (sln, subscribed, coerce $ DMap.lookup k =<< occ)
1715 Nothing -> {-# SCC "missFan" #-} do
1716 subscribedRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribedRef not yet initialized"
1717 subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1718 s <- liftIO $ newSubscriberFan subscribedUnsafe
1719 (subscription, parentOcc) <- subscribeAndRead (fanParent f) s
1720 weakSelf <- liftIO $ newIORef $ error "getFanSubscribed: weakSelf not yet initialized"
1721 (subsForK, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupFanSubscribed
1722 subscribersRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribersRef not yet initialized"
1723 occRef <- liftIO $ newIORef parentOcc
1724 when (isJust parentOcc) $ scheduleClear occRef
1726 nid <- liftIO newNodeId
1728 let subscribed = FanSubscribed
1729 { fanSubscribedCachedSubscribed = fanSubscribed f
1730 , fanSubscribedOccurrence = occRef
1731 , fanSubscribedParent = subscription
1732 , fanSubscribedSubscribers = subscribersRef
1734 , fanSubscribedNodeId = nid
1737 let !self = (k, subscribed)
1738 liftIO $ writeIORef subscribersRef $! DMap.singleton k $ FanSubscribedChildren subsForK self weakSelf
1739 liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug self "FanSubscribed"
1740 liftIO $ writeIORef subscribedRef $! subscribed
1741 liftIO $ writeIORef (fanSubscribed f) $ Just subscribed
1742 return (slnForSub, subscribed, coerce $ DMap.lookup k =<< parentOcc)
1744cleanupFanSubscribed :: GCompare k => (k a, FanSubscribed x k v) -> IO ()
1745cleanupFanSubscribed (k, subscribed) = do
1746 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1747 let reducedSubscribers = DMap.delete k subscribers
1748 if DMap.null reducedSubscribers
1750 unsubscribe $ fanSubscribedParent subscribed
1751 -- Not necessary in this case, because this whole FanSubscribed is dead: writeIORef (fanSubscribedSubscribers subscribed) reducedSubscribers
1752 writeIORef (fanSubscribedCachedSubscribed subscribed) Nothing
1753 else writeIORef (fanSubscribedSubscribers subscribed) $! reducedSubscribers
1755{-# INLINE subscribeFanSubscribed #-}
1756subscribeFanSubscribed :: GCompare k => k a -> FanSubscribed x k v -> Subscriber x (v a) -> IO WeakBagTicket
1757subscribeFanSubscribed k subscribed sub = do
1758 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1759 case DMap.lookup k subscribers of
1760 Nothing -> {-# SCC "missSubscribeFanSubscribed" #-} do
1761 let !self = (k, subscribed)
1762 weakSelf <- newIORef =<< mkWeakPtrWithDebug self "FanSubscribed"
1763 (list, sln) <- WeakBag.singleton sub weakSelf cleanupFanSubscribed
1764 writeIORef (fanSubscribedSubscribers subscribed) $! DMap.insertWith (error "subscribeFanSubscribed: key that we just failed to find is present - should be impossible") k (FanSubscribedChildren list self weakSelf) subscribers
1766 Just (FanSubscribedChildren list _ weakSelf) -> {-# SCC "hitSubscribeFanSubscribed" #-} WeakBag.insert sub list weakSelf cleanupFanSubscribed
1768{-# INLINABLE getSwitchSubscribed #-}
1769getSwitchSubscribed :: HasSpiderTimeline x => Switch x a -> Subscriber x a -> EventM x (WeakBagTicket, SwitchSubscribed x a, Maybe a)
1770getSwitchSubscribed s sub = do
1771 mSubscribed <- liftIO $ readIORef $ switchSubscribed s
1773 Just subscribed -> {-# SCC "hitSwitch" #-} liftIO $ do
1774 sln <- subscribeSwitchSubscribed subscribed sub
1775 occ <- readIORef $ switchSubscribedOccurrence subscribed
1776 return (sln, subscribed, occ)
1777 Nothing -> {-# SCC "missSwitch" #-} do
1778 subscribedRef <- liftIO $ newIORef $ error "getSwitchSubscribed: subscribed has not yet been created"
1779 subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1780 i <- liftIO $ newInvalidatorSwitch subscribedUnsafe
1781 mySub <- liftIO $ newSubscriberSwitch subscribedUnsafe
1782 wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorSwitch"
1783 wiRef <- liftIO $ newIORef wi
1784 parentsRef <- liftIO $ newIORef [] --TODO: This should be unnecessary, because it will always be filled with just the single parent behavior
1785 holdInits <- getDeferralQueue
1786 e <- liftIO $ runBehaviorM (readBehaviorTracked (switchParent s)) (Just (wi, parentsRef)) holdInits
1787 (subscription@(EventSubscription _ subd), parentOcc) <- subscribeAndRead e mySub
1788 heightRef <- liftIO $ newIORef =<< getEventSubscribedHeight subd
1789 subscriptionRef <- liftIO $ newIORef subscription
1790 occRef <- liftIO $ newIORef parentOcc
1791 when (isJust parentOcc) $ scheduleClear occRef
1792 weakSelf <- liftIO $ newIORef $ error "getSwitchSubscribed: weakSelf not yet initialized"
1793 (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupSwitchSubscribed
1795 nid <- liftIO newNodeId
1797 let !subscribed = SwitchSubscribed
1798 { switchSubscribedCachedSubscribed = switchSubscribed s
1799 , switchSubscribedOccurrence = occRef
1800 , switchSubscribedHeight = heightRef
1801 , switchSubscribedSubscribers = subs
1802 , switchSubscribedOwnInvalidator = i
1803 , switchSubscribedOwnWeakInvalidator = wiRef
1804 , switchSubscribedBehaviorParents = parentsRef
1805 , switchSubscribedParent = switchParent s
1806 , switchSubscribedCurrentParent = subscriptionRef
1807 , switchSubscribedWeakSelf = weakSelf
1809 , switchSubscribedNodeId = nid
1812 liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "switchSubscribedWeakSelf"
1813 liftIO $ writeIORef subscribedRef $! subscribed
1814 liftIO $ writeIORef (switchSubscribed s) $ Just subscribed
1815 return (slnForSub, subscribed, parentOcc)
1817cleanupSwitchSubscribed :: SwitchSubscribed x a -> IO ()
1818cleanupSwitchSubscribed subscribed = do
1819 unsubscribe =<< readIORef (switchSubscribedCurrentParent subscribed)
1820 finalize =<< readIORef (switchSubscribedOwnWeakInvalidator subscribed) -- We don't need to get invalidated if we're dead
1821 writeIORef (switchSubscribedCachedSubscribed subscribed) Nothing
1823{-# INLINE subscribeSwitchSubscribed #-}
1824subscribeSwitchSubscribed :: SwitchSubscribed x a -> Subscriber x a -> IO WeakBagTicket
1825subscribeSwitchSubscribed subscribed sub = WeakBag.insert sub (switchSubscribedSubscribers subscribed) (switchSubscribedWeakSelf subscribed) cleanupSwitchSubscribed
1827{-# INLINABLE getCoincidenceSubscribed #-}
1828getCoincidenceSubscribed :: forall x a. HasSpiderTimeline x => Coincidence x a -> Subscriber x a -> EventM x (WeakBagTicket, CoincidenceSubscribed x a, Maybe a)
1829getCoincidenceSubscribed c sub = do
1830 mSubscribed <- liftIO $ readIORef $ coincidenceSubscribed c
1832 Just subscribed -> {-# SCC "hitCoincidence" #-} liftIO $ do
1833 sln <- subscribeCoincidenceSubscribed subscribed sub
1834 occ <- readIORef $ coincidenceSubscribedOccurrence subscribed
1835 return (sln, subscribed, occ)
1836 Nothing -> {-# SCC "missCoincidence" #-} do
1837 subscribedRef <- liftIO $ newIORef $ error "getCoincidenceSubscribed: subscribed has not yet been created"
1838 subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1839 subOuter <- liftIO $ newSubscriberCoincidenceOuter subscribedUnsafe
1840 (outerSubscription@(EventSubscription _ outerSubd), outerOcc) <- subscribeAndRead (coincidenceParent c) subOuter
1841 outerHeight <- liftIO $ getEventSubscribedHeight outerSubd
1842 (occ, height, mInnerSubd) <- case outerOcc of
1843 Nothing -> return (Nothing, outerHeight, Nothing)
1845 (occ, height, innerSubd) <- subscribeCoincidenceInner o outerHeight subscribedUnsafe
1846 return (occ, height, Just innerSubd)
1847 occRef <- liftIO $ newIORef occ
1848 when (isJust occ) $ scheduleClear occRef
1849 heightRef <- liftIO $ newIORef height
1850 innerSubdRef <- liftIO $ newIORef mInnerSubd
1851 scheduleClear innerSubdRef
1852 weakSelf <- liftIO $ newIORef $ error "getCoincidenceSubscribed: weakSelf not yet implemented"
1853 (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupCoincidenceSubscribed
1855 nid <- liftIO newNodeId
1857 let subscribed = CoincidenceSubscribed
1858 { coincidenceSubscribedCachedSubscribed = coincidenceSubscribed c
1859 , coincidenceSubscribedOccurrence = occRef
1860 , coincidenceSubscribedHeight = heightRef
1861 , coincidenceSubscribedSubscribers = subs
1862 , coincidenceSubscribedOuter = subOuter
1863 , coincidenceSubscribedOuterParent = outerSubscription
1864 , coincidenceSubscribedInnerParent = innerSubdRef
1865 , coincidenceSubscribedWeakSelf = weakSelf
1867 , coincidenceSubscribedNodeId = nid
1870 liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "CoincidenceSubscribed"
1871 liftIO $ writeIORef subscribedRef $! subscribed
1872 liftIO $ writeIORef (coincidenceSubscribed c) $ Just subscribed
1873 return (slnForSub, subscribed, occ)
1875cleanupCoincidenceSubscribed :: CoincidenceSubscribed x a -> IO ()
1876cleanupCoincidenceSubscribed subscribed = do
1877 unsubscribe $ coincidenceSubscribedOuterParent subscribed
1878 writeIORef (coincidenceSubscribedCachedSubscribed subscribed) Nothing
1880{-# INLINE subscribeCoincidenceSubscribed #-}
1881subscribeCoincidenceSubscribed :: CoincidenceSubscribed x a -> Subscriber x a -> IO WeakBagTicket
1882subscribeCoincidenceSubscribed subscribed sub = WeakBag.insert sub (coincidenceSubscribedSubscribers subscribed) (coincidenceSubscribedWeakSelf subscribed) cleanupCoincidenceSubscribed
1884{-# INLINE mergeG #-}
1885mergeG :: forall k q x v. (HasSpiderTimeline x, GCompare k)
1886 => (forall a. q a -> Event x (v a))
1887 -> DynamicS x (PatchDMap k q) -> Event x (DMap k v)
1888mergeG nt d = cacheEvent (mergeCheap nt d)
1890{-# INLINE mergeWithMove #-}
1891mergeWithMove :: forall k v q x. (HasSpiderTimeline x, GCompare k)
1892 => (forall a. q a -> Event x (v a))
1893 -> DynamicS x (PatchDMapWithMove k q) -> Event x (DMap k v)
1894mergeWithMove nt d = cacheEvent (mergeCheapWithMove nt d)
1896{-# INLINE [1] mergeCheap #-}
1898 :: forall k x q v. (HasSpiderTimeline x, GCompare k)
1899 => (forall a. q a -> Event x (v a))
1900 -> DynamicS x (PatchDMap k q)
1901 -> Event x (DMap k v)
1902mergeCheap nt = mergeGCheap' unMergeSubscribedParent getInitialSubscribers updateMe destroy
1904 updateMe :: MergeUpdateFunc k v x (PatchDMap k q) (MergeSubscribedParent x)
1905 updateMe subscriber heightBagRef oldParents (PatchDMap p) = do
1906 let f (subscriptionsToKill, ps) (k :=> ComposeMaybe me) = do
1907 (mOldSubd, newPs) <- case me of
1908 Nothing -> return $ DMap.updateLookupWithKey (\_ _ -> Nothing) k ps
1910 let s = subscriber $ return k
1911 subscription@(EventSubscription _ subd) <- subscribe (nt e) s
1912 newParentHeight <- liftIO $ getEventSubscribedHeight subd
1913 let newParent = MergeSubscribedParent subscription
1914 liftIO $ modifyIORef' heightBagRef $ heightBagAdd newParentHeight
1915 return $ DMap.insertLookupWithKey' (\_ new _ -> new) k newParent ps
1916 forM_ mOldSubd $ \oldSubd -> do
1917 oldHeight <- liftIO $ getEventSubscribedHeight $
1918 _eventSubscription_subscribed $ unMergeSubscribedParent oldSubd
1920 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
1921 return (maybeToList (unMergeSubscribedParent <$> mOldSubd) ++ subscriptionsToKill, newPs)
1922 foldM f ([], oldParents) $ DMap.toList p
1924 getInitialSubscribers :: MergeInitFunc k v q x (MergeSubscribedParent x)
1925 getInitialSubscribers initialParents subscriber = do
1926 subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
1927 let s = subscriber $ return k
1928 (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead (nt e) s
1929 height <- liftIO $ getEventSubscribedHeight parentSubd
1930 return (fmap (k :=>) parentOcc, height, k :=> MergeSubscribedParent subscription)
1931 return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
1932 , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
1933 , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
1936 destroy :: MergeDestroyFunc k (MergeSubscribedParent x)
1937 destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParent sub) -> unsubscribe sub
1939{-# INLINE [1] mergeCheapWithMove #-}
1940mergeCheapWithMove :: forall k x v q. (HasSpiderTimeline x, GCompare k)
1941 => (forall a. q a -> Event x (v a))
1942 -> DynamicS x (PatchDMapWithMove k q)
1943 -> Event x (DMap k v)
1944mergeCheapWithMove nt = mergeGCheap' _mergeSubscribedParentWithMove_subscription getInitialSubscribers updateMe destroy
1946 updateMe :: MergeUpdateFunc k v x (PatchDMapWithMove k q) (MergeSubscribedParentWithMove x k)
1947 updateMe subscriber heightBagRef oldParents p = do
1948 -- Prepare new parents for insertion
1949 let subscribeParent :: forall a. k a -> Event x (v a) -> EventM x (MergeSubscribedParentWithMove x k a)
1950 subscribeParent k e = do
1951 keyRef <- liftIO $ newIORef k
1952 let s = subscriber $ liftIO $ readIORef keyRef
1953 subscription@(EventSubscription _ subd) <- subscribe e s
1955 newParentHeight <- getEventSubscribedHeight subd
1956 modifyIORef' heightBagRef $ heightBagAdd newParentHeight
1957 return $ MergeSubscribedParentWithMove subscription keyRef
1958 p' <- PatchDMapWithMove.traversePatchDMapWithMoveWithKey (\k q -> subscribeParent k (nt q)) p
1959 -- Collect old parents for deletion and update the keys of moved parents
1960 let moveOrDelete :: forall a. k a -> PatchDMapWithMove.NodeInfo k q a -> MergeSubscribedParentWithMove x k a -> Constant (EventM x (Maybe (EventSubscription x))) a
1961 moveOrDelete _ ni parent = Constant $ case getComposeMaybe $ PatchDMapWithMove._nodeInfo_to ni of
1963 oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $
1964 _mergeSubscribedParentWithMove_subscription parent
1966 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
1967 return $ Just $ _mergeSubscribedParentWithMove_subscription parent
1969 liftIO $ writeIORef (_mergeSubscribedParentWithMove_key parent) $! toKey
1971 toDelete <- fmap catMaybes $ mapM (\(_ :=> v) -> getConstant v) $ DMap.toList $
1972 DMap.intersectionWithKey moveOrDelete (unPatchDMapWithMove p) oldParents
1974 return (toDelete, applyAlways p' oldParents)
1975 getInitialSubscribers :: MergeInitFunc k v q x (MergeSubscribedParentWithMove x k)
1976 getInitialSubscribers initialParents subscriber = do
1977 subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
1978 keyRef <- liftIO $ newIORef k
1979 let s = subscriber $ liftIO $ readIORef keyRef
1980 (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead (nt e) s
1981 height <- liftIO $ getEventSubscribedHeight parentSubd
1982 return (fmap (k :=>) parentOcc, height, k :=> MergeSubscribedParentWithMove subscription keyRef)
1983 return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
1984 , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
1985 , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
1988 destroy :: MergeDestroyFunc k (MergeSubscribedParentWithMove x k)
1989 destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParentWithMove sub _) -> unsubscribe sub
1991type MergeUpdateFunc k v x p s
1992 = (forall a. EventM x (k a) -> Subscriber x (v a))
1996 -> EventM x ([EventSubscription x], DMap k s)
1998type MergeGetSubscription x s = forall a. s a -> EventSubscription x
2000type MergeInitFunc k v q x s
2002 -> (forall a. EventM x (k a) -> Subscriber x (v a))
2003 -> EventM x (DMap k v, [Height], DMap k s)
2005type MergeDestroyFunc k s
2009data Merge x k v s = Merge
2010 { _merge_parentsRef :: {-# UNPACK #-} !(IORef (DMap k s))
2011 , _merge_heightBagRef :: {-# UNPACK #-} !(IORef HeightBag)
2012 , _merge_heightRef :: {-# UNPACK #-} !(IORef Height)
2013 , _merge_sub :: {-# UNPACK #-} !(Subscriber x (DMap k v))
2014 , _merge_accumRef :: {-# UNPACK #-} !(IORef (DMap k v))
2017invalidateMergeHeight :: Merge x k v s -> IO ()
2018invalidateMergeHeight m = invalidateMergeHeight' (_merge_heightRef m) (_merge_sub m)
2020invalidateMergeHeight' :: IORef Height -> Subscriber x a -> IO ()
2021invalidateMergeHeight' heightRef sub = do
2022 oldHeight <- readIORef heightRef
2023 -- If the height used to be valid, it must be invalid now; we should never have *more* heights than we have parents
2024 when (oldHeight /= invalidHeight) $ do
2025 writeIORef heightRef $! invalidHeight
2026 subscriberInvalidateHeight sub oldHeight
2028revalidateMergeHeight :: Merge x k v s -> IO ()
2029revalidateMergeHeight m = do
2030 currentHeight <- readIORef $ _merge_heightRef m
2032 -- revalidateMergeHeight may be called multiple times; perhaps the's a way to finesse it to avoid this check
2033 when (currentHeight == invalidHeight) $ do
2034 heights <- readIORef $ _merge_heightBagRef m
2035 parents <- readIORef $ _merge_parentsRef m
2036 -- When the number of heights in the bag reaches the number of parents, we should have a valid height
2037 case heightBagSize heights `compare` DMap.size parents of
2040 let height = succHeight $ heightBagMax heights
2041 traceInvalidateHeight $ "recalculateSubscriberHeight: height: " <> show height
2042 writeIORef (_merge_heightRef m) $! height
2043 subscriberRecalculateHeight (_merge_sub m) height
2044 GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show (DMap.size parents) <> ") for Merge"
2046scheduleMergeSelf :: HasSpiderTimeline x => Merge x k v s -> Height -> EventM x ()
2047scheduleMergeSelf m height = scheduleMerge' height (_merge_heightRef m) $ do
2048 vals <- liftIO $ readIORef $ _merge_accumRef m
2049 -- Once we're done with this, we can clear it immediately, because if there's a cacheEvent in front of us,
2050 -- it'll handle subsequent subscribers, and if not, we won't get subsequent subscribers
2051 liftIO $ writeIORef (_merge_accumRef m) $! DMap.empty
2052 --TODO: Assert that m is not empty
2053 subscriberPropagate (_merge_sub m) vals
2055checkCycle :: HasSpiderTimeline x => EventSubscribed x -> EventM x ()
2056checkCycle subscribed = liftIO $ do
2057 height <- readIORef (eventSubscribedHeightRef subscribed)
2059 -- currentHeight <- getCurrentHeight
2060 -- when (height <= currentHeight) $ if height /= invalidHeight
2062 -- myStack <- liftIO $ whoCreatedIORef undefined --TODO
2063 -- error $ "Height (" ++ show height ++ ") is not greater than current height (" ++ show currentHeight ++ ")\n" ++ unlines (reverse myStack)
2065 when (height == invalidHeight) $
2068 nodesInvolvedInCycle <- walkInvalidHeightParents subscribed
2069 stacks <- forM nodesInvolvedInCycle whoCreatedEventSubscribed
2070 throwIO (EventLoopException stacks)
2072 throwIO EventLoopException
2076mergeSubscriber :: forall x k v s a. (HasSpiderTimeline x, GCompare k) => EventSubscribed x -> Merge x k v s -> EventM x (k a) -> Subscriber x (v a)
2077mergeSubscriber subscribed m getKey = Subscriber
2078 { subscriberPropagate = \a -> do
2079 oldM <- liftIO $ readIORef $ _merge_accumRef m
2081 let newM = DMap.insertWith (error "Same key fired multiple times for Merge") k a oldM
2082 tracePropagate (Proxy :: Proxy x) $ " DMap.size oldM = " <> show (DMap.size oldM) <> "; DMap.size newM = " <> show (DMap.size newM)
2083 liftIO $ writeIORef (_merge_accumRef m) $! newM
2084 when (DMap.null oldM) $ do -- Only schedule the firing once
2085 height <- liftIO $ readIORef $ _merge_heightRef m
2086 checkCycle subscribed
2088 scheduleMergeSelf m height
2089 , subscriberInvalidateHeight = \old -> do --TODO: When removing a parent doesn't actually change the height, maybe we can avoid invalidating
2090 modifyIORef' (_merge_heightBagRef m) $ heightBagRemove old
2091 invalidateMergeHeight m
2092 , subscriberRecalculateHeight = \new -> do
2093 modifyIORef' (_merge_heightBagRef m) $ heightBagAdd new
2094 revalidateMergeHeight m
2097--TODO: Be able to run as much of this as possible promptly
2098updateMerge :: (HasSpiderTimeline x, GCompare k) => EventSubscribed x -> Merge x k v s -> MergeUpdateFunc k v x p s -> p -> SomeMergeUpdate x
2099updateMerge subscribed m updateFunc p = SomeMergeUpdate updateMe (invalidateMergeHeight m) (revalidateMergeHeight m)
2101 oldParents <- liftIO $ readIORef $ _merge_parentsRef m
2102 (subscriptionsToKill, newParents) <- updateFunc (mergeSubscriber subscribed m) (_merge_heightBagRef m) oldParents p
2103 liftIO $ writeIORef (_merge_parentsRef m) $! newParents
2104 return subscriptionsToKill
2106{-# INLINE mergeGCheap' #-}
2107mergeGCheap' :: forall k v x p s q. (HasSpiderTimeline x, GCompare k, PatchTarget p ~ DMap k q)
2108 => MergeGetSubscription x s -> MergeInitFunc k v q x s -> MergeUpdateFunc k v x p s -> MergeDestroyFunc k s -> DynamicS x p -> Event x (DMap k v)
2109mergeGCheap' getParent getInitialSubscribers updateFunc destroy d = Event $ \sub -> do
2110 initialParents <- readBehaviorUntracked $ dynamicCurrent d
2111 accumRef <- liftIO $ newIORef $ error "merge: accumRef not yet initialized"
2112 heightRef <- liftIO $ newIORef $ error "merge: heightRef not yet initialized"
2113 heightBagRef <- liftIO $ newIORef $ error "merge: heightBagRef not yet initialized"
2114 parentsRef :: IORef (DMap k s) <- liftIO $ newIORef $ error "merge: parentsRef not yet initialized"
2115 changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
2117 let subscribed = EventSubscribed
2118 { eventSubscribedHeightRef = heightRef
2119 , eventSubscribedRetained = toAny (parentsRef, changeSubdRef)
2121 , eventSubscribedGetParents = do
2122 let getParent' (_ :=> v) = _eventSubscription_subscribed (getParent v)
2123 fmap getParent' . DMap.toList <$> readIORef parentsRef
2124 , eventSubscribedHasOwnHeightRef = False
2125 , eventSubscribedWhoCreated = whoCreatedIORef heightRef
2130 { _merge_parentsRef = parentsRef
2131 , _merge_heightBagRef = heightBagRef
2132 , _merge_heightRef = heightRef
2134 , _merge_accumRef = accumRef
2136 (dm, heights, initialParentState) <- getInitialSubscribers initialParents $ mergeSubscriber subscribed m
2137 let myHeightBag = heightBagFromList $ filter (/= invalidHeight) heights
2138 myHeight = if invalidHeight `elem` heights
2140 else succHeight $ heightBagMax myHeightBag
2141 currentHeight <- getCurrentHeight
2142 let (occ, accum) = if currentHeight >= myHeight -- If we should have fired by now
2143 then (if DMap.null dm then Nothing else Just dm, DMap.empty)
2145 unless (DMap.null accum) $ scheduleMergeSelf m myHeight
2146 liftIO $ writeIORef accumRef $! accum
2147 liftIO $ writeIORef heightRef $! myHeight
2148 liftIO $ writeIORef heightBagRef $! myHeightBag
2149 liftIO $ writeIORef parentsRef $! initialParentState
2150 defer $ SomeMergeInit $ do
2151 let changeSubscriber = Subscriber
2152 { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
2153 tracePropagate (Proxy :: Proxy x) "SubscriberMerge/Change"
2154 defer $ updateMerge subscribed m updateFunc a
2155 , subscriberInvalidateHeight = \_ -> return ()
2156 , subscriberRecalculateHeight = \_ -> return ()
2158 (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) changeSubscriber
2159 forM_ change $ \c -> defer $ updateMerge subscribed m updateFunc c
2160 -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
2161 -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
2162 -- its subscription.
2163 liftIO $ writeIORef changeSubdRef (changeSubscriber, changeSubscription)
2164 let unsubscribeAll = destroy =<< readIORef parentsRef
2166 return (EventSubscription unsubscribeAll subscribed, occ)
2169mergeInt :: forall x a. (HasSpiderTimeline x) => DynamicS x (PatchIntMap (Event x a)) -> Event x (IntMap a)
2170mergeInt = cacheEvent . mergeIntCheap
2172{-# INLINABLE mergeIntCheap #-}
2173mergeIntCheap :: forall x a. (HasSpiderTimeline x) => DynamicS x (PatchIntMap (Event x a)) -> Event x (IntMap a)
2174mergeIntCheap d = Event $ \sub -> do
2175 initialParents <- readBehaviorUntracked $ dynamicCurrent d
2176 accum <- liftIO $ FastMutableIntMap.newEmpty
2177 heightRef <- liftIO $ newIORef zeroHeight
2178 heightBagRef <- liftIO $ newIORef heightBagEmpty
2179 parents <- liftIO $ FastMutableIntMap.newEmpty
2180 changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
2181 let subscribed = EventSubscribed
2182 { eventSubscribedHeightRef = heightRef
2183 , eventSubscribedRetained = toAny (parents, changeSubdRef)
2185 , eventSubscribedGetParents = fmap (_eventSubscription_subscribed . snd) <$> FastMutableIntMap.toList parents
2186 , eventSubscribedHasOwnHeightRef = False
2187 , eventSubscribedWhoCreated = whoCreatedIORef heightRef
2190 let scheduleSelf = do
2191 height <- liftIO $ readIORef $ heightRef
2192 scheduleMerge' height heightRef $ do
2193 vals <- liftIO $ FastMutableIntMap.getFrozenAndClear accum
2194 subscriberPropagate sub vals
2195 invalidateMyHeight = invalidateMergeHeight' heightRef sub
2196 recalculateMyHeight = do
2197 currentHeight <- readIORef heightRef
2198 when (currentHeight == invalidHeight) $ do --TODO: This will almost always be true; can we get rid of this check and just proceed to the next one always?
2199 heights <- readIORef heightBagRef
2200 numParents <- FastMutableIntMap.size parents
2201 case heightBagSize heights `compare` numParents of
2204 let height = succHeight $ heightBagMax heights
2205 traceInvalidateHeight $ "recalculateSubscriberHeight: height: " <> show height
2206 writeIORef heightRef $! height
2207 subscriberRecalculateHeight sub height
2208 GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show numParents <> ") for Merge"
2209 mySubscriber k = Subscriber
2210 { subscriberPropagate = \a -> do
2211 checkCycle subscribed
2213 wasEmpty <- liftIO $ FastMutableIntMap.isEmpty accum
2214 liftIO $ FastMutableIntMap.insert accum k a
2215 when wasEmpty scheduleSelf
2216 , subscriberInvalidateHeight = \old -> do
2217 modifyIORef' heightBagRef $ heightBagRemove old
2219 , subscriberRecalculateHeight = \new -> do
2220 modifyIORef' heightBagRef $ heightBagAdd new
2223 forM_ (IntMap.toList initialParents) $ \(k, p) -> do
2224 (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead p $ mySubscriber k
2226 forM_ parentOcc $ FastMutableIntMap.insert accum k
2227 FastMutableIntMap.insert parents k subscription
2228 height <- getEventSubscribedHeight parentSubd
2229 if height == invalidHeight
2230 then writeIORef heightRef invalidHeight
2232 modifyIORef' heightBagRef $ heightBagAdd height
2233 modifyIORef' heightRef $ \oldHeight ->
2234 if oldHeight == invalidHeight
2236 else max (succHeight height) oldHeight
2237 myHeight <- liftIO $ readIORef heightRef
2238 currentHeight <- getCurrentHeight
2239 isEmpty <- liftIO $ FastMutableIntMap.isEmpty accum
2240 occ <- if currentHeight >= myHeight -- If we should have fired by now
2243 else liftIO $ Just <$> FastMutableIntMap.getFrozenAndClear accum
2244 else do when (not isEmpty) scheduleSelf -- We have things accumulated, but we shouldn't have fired them yet
2246 defer $ SomeMergeInit $ do
2247 let updateMe a = SomeMergeUpdate u invalidateMyHeight recalculateMyHeight
2250 let f k newParent = do
2251 subscription@(EventSubscription _ subd) <- subscribe newParent $ mySubscriber k
2252 newParentHeight <- liftIO $ getEventSubscribedHeight subd
2253 liftIO $ modifyIORef' heightBagRef $ heightBagAdd newParentHeight
2255 newSubscriptions <- FastMutableIntMap.traverseIntMapPatchWithKey f a
2256 oldParents <- liftIO $ FastMutableIntMap.applyPatch parents newSubscriptions
2257 liftIO $ for_ oldParents $ \oldParent -> do
2258 oldParentHeight <- getEventSubscribedHeight $ _eventSubscription_subscribed oldParent
2260 print ("updateMe", oldParentHeight)
2261 modifyIORef' heightBagRef $ heightBagRemove oldParentHeight
2262 return $ IntMap.elems oldParents
2263 let changeSubscriber = Subscriber
2264 { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
2265 tracePropagate (Proxy :: Proxy x) $ "SubscriberMergeInt/Change"
2267 , subscriberInvalidateHeight = \_ -> return ()
2268 , subscriberRecalculateHeight = \_ -> return ()
2270 (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) changeSubscriber
2271 forM_ change $ \c -> defer $ updateMe c
2272 -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
2273 -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
2274 -- its subscription.
2275 liftIO $ writeIORef changeSubdRef (changeSubscriber, changeSubscription)
2276 let unsubscribeAll = traverse_ unsubscribe =<< FastMutableIntMap.getFrozenAndClear parents
2279 return (EventSubscription unsubscribeAll subscribed, occ)
2281newtype EventSelector x k = EventSelector { select :: forall a. k a -> Event x a }
2282newtype EventSelectorG x k v = EventSelectorG { selectG :: forall a. k a -> Event x (v a) }
2284fanG :: (HasSpiderTimeline x, GCompare k) => Event x (DMap k v) -> EventSelectorG x k v
2285fanG e = unsafePerformIO $ do
2286 ref <- newIORef Nothing
2289 , fanSubscribed = ref
2291 pure $ EventSelectorG $ \k -> eventFan k f
2293runHoldInits :: HasSpiderTimeline x => IORef [SomeHoldInit x] -> IORef [SomeDynInit x] -> IORef [SomeMergeInit x] -> EventM x ()
2294runHoldInits holdInitRef dynInitRef mergeInitRef = do
2295 holdInits <- liftIO $ readIORef holdInitRef
2296 dynInits <- liftIO $ readIORef dynInitRef
2297 mergeInits <- liftIO $ readIORef mergeInitRef
2298 unless (null holdInits && null dynInits && null mergeInits) $ do
2299 liftIO $ writeIORef holdInitRef []
2300 liftIO $ writeIORef dynInitRef []
2301 liftIO $ writeIORef mergeInitRef []
2302 mapM_ initHold holdInits
2303 mapM_ initDyn dynInits
2304 mapM_ unSomeMergeInit mergeInits
2305 runHoldInits holdInitRef dynInitRef mergeInitRef
2307initHold :: HasSpiderTimeline x => SomeHoldInit x -> EventM x ()
2308initHold (SomeHoldInit h) = void $ getHoldEventSubscription h
2310initDyn :: HasSpiderTimeline x => SomeDynInit x -> EventM x ()
2311initDyn (SomeDynInit d) = void $ getDynHold d
2313newEventEnv :: IO (EventEnv x)
2315 toAssignRef <- newIORef [] -- This should only actually get used when events are firing
2316 holdInitRef <- newIORef []
2317 dynInitRef <- newIORef []
2318 mergeUpdateRef <- newIORef []
2319 mergeInitRef <- newIORef []
2320 heightRef <- newIORef zeroHeight
2321 toClearRef <- newIORef []
2322 toClearIntRef <- newIORef []
2323 toClearRootRef <- newIORef []
2324 coincidenceInfosRef <- newIORef []
2325 delayedRef <- newIORef IntMap.empty
2326 return $ EventEnv toAssignRef holdInitRef dynInitRef mergeUpdateRef mergeInitRef toClearRef toClearIntRef toClearRootRef heightRef coincidenceInfosRef delayedRef
2328clearEventEnv :: EventEnv x -> IO ()
2329clearEventEnv (EventEnv toAssignRef holdInitRef dynInitRef mergeUpdateRef mergeInitRef toClearRef toClearIntRef toClearRootRef heightRef coincidenceInfosRef delayedRef) = do
2330 writeIORef toAssignRef []
2331 writeIORef holdInitRef []
2332 writeIORef dynInitRef []
2333 writeIORef mergeUpdateRef []
2334 writeIORef mergeInitRef []
2335 writeIORef heightRef zeroHeight
2336 writeIORef toClearRef []
2337 writeIORef toClearIntRef []
2338 writeIORef toClearRootRef []
2339 writeIORef coincidenceInfosRef []
2340 writeIORef delayedRef IntMap.empty
2342-- | Run an event action outside of a frame
2343runFrame :: forall x a. HasSpiderTimeline x => EventM x a -> SpiderHost x a --TODO: This function also needs to hold the mutex
2344runFrame a = SpiderHost $ do
2345 let env = _spiderTimeline_eventEnv $ unSTE (spiderTimeline :: SpiderTimelineEnv x)
2348 runHoldInits (eventEnvHoldInits env) (eventEnvDynInits env) (eventEnvMergeInits env) -- This must happen before doing the assignments, in case subscribing a Hold causes existing Holds to be read by the newly-propagated events
2350 result <- runEventM go
2351 toClear <- readIORef $ eventEnvClears env
2352 forM_ toClear $ \(Some (Clear ref)) -> {-# SCC "clear" #-} writeIORef ref Nothing
2353 toClearInt <- readIORef $ eventEnvIntClears env
2354 forM_ toClearInt $ \(Some (IntClear ref)) -> {-# SCC "intClear" #-} writeIORef ref $! IntMap.empty
2355 toClearRoot <- readIORef $ eventEnvRootClears env
2356 forM_ toClearRoot $ \(Some (RootClear ref)) -> {-# SCC "rootClear" #-} writeIORef ref $! DMap.empty
2357 toAssign <- readIORef $ eventEnvAssignments env
2358 toReconnectRef <- newIORef []
2359 coincidenceInfos <- readIORef $ eventEnvResetCoincidences env
2360 forM_ toAssign $ \(SomeAssignment vRef iRef v) -> {-# SCC "assignment" #-} do
2362 traceInvalidate $ "Invalidating Hold"
2363 writeIORef iRef =<< evaluate =<< invalidate toReconnectRef =<< readIORef iRef
2364 mergeUpdates <- readIORef $ eventEnvMergeUpdates env
2365 writeIORef (eventEnvMergeUpdates env) []
2366 tracePropagate (Proxy::Proxy x) $ "Updating merges"
2367 mergeSubscriptionsToKill <- runEventM $ concat <$> mapM _someMergeUpdate_update mergeUpdates
2368 tracePropagate (Proxy::Proxy x) $ "Updating merges done"
2369 toReconnect <- readIORef toReconnectRef
2371 switchSubscriptionsToKill <- forM toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
2372 oldSubscription <- readIORef $ switchSubscribedCurrentParent subscribed
2373 wi <- readIORef $ switchSubscribedOwnWeakInvalidator subscribed
2374 traceInvalidate $ "Finalizing invalidator for Switch" <> showNodeId subscribed
2376 i <- evaluate $ switchSubscribedOwnInvalidator subscribed
2377 wi' <- mkWeakPtrWithDebug i "wi'"
2378 writeIORef (switchSubscribedOwnWeakInvalidator subscribed) $! wi'
2379 writeIORef (switchSubscribedBehaviorParents subscribed) []
2380 writeIORef (eventEnvHoldInits env) [] --TODO: Should we reuse this?
2381 e <- runBehaviorM (readBehaviorTracked (switchSubscribedParent subscribed)) (Just (wi', switchSubscribedBehaviorParents subscribed)) $ eventEnvHoldInits env
2382 runEventM $ runHoldInits (eventEnvHoldInits env) (eventEnvDynInits env) (eventEnvMergeInits env) --TODO: Is this actually OK? It seems like it should be, since we know that no events are firing at this point, but it still seems inelegant
2383 --TODO: Make sure we touch the pieces of the SwitchSubscribed at the appropriate times
2384 sub <- newSubscriberSwitch subscribed
2385 subscription <- unSpiderHost $ runFrame $ {-# SCC "subscribeSwitch" #-} subscribe e sub --TODO: Assert that the event isn't firing --TODO: This should not loop because none of the events should be firing, but still, it is inefficient
2387 stackTrace <- liftIO $ fmap renderStack $ ccsToStrings =<< (getCCSOf $! switchSubscribedParent subscribed)
2388 liftIO $ debugStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
2389 EventRoot _ -> "EventRoot"
2390 EventNever -> "EventNever"
2391 _ -> "something else"
2393 writeIORef (switchSubscribedCurrentParent subscribed) $! subscription
2394 return oldSubscription
2395 liftIO $ mapM_ unsubscribe mergeSubscriptionsToKill
2396 liftIO $ mapM_ unsubscribe switchSubscriptionsToKill
2397 forM_ toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
2398 EventSubscription _ subd' <- readIORef $ switchSubscribedCurrentParent subscribed
2399 parentHeight <- getEventSubscribedHeight subd'
2400 myHeight <- readIORef $ switchSubscribedHeight subscribed
2401 when (parentHeight /= myHeight) $ do
2402 writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
2403 WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight myHeight
2404 mapM_ _someMergeUpdate_invalidateHeight mergeUpdates --TODO: In addition to when the patch is completely empty, we should also not run this if it has some Nothing values, but none of them have actually had any effect; potentially, we could even check for Just values with no effect (e.g. by comparing their IORefs and ignoring them if they are unchanged); actually, we could just check if the new height is different
2405 forM_ coincidenceInfos $ \(SomeResetCoincidence subscription mcs) -> do
2406 unsubscribe subscription
2407 mapM_ invalidateCoincidenceHeight mcs
2408 forM_ coincidenceInfos $ \(SomeResetCoincidence _ mcs) -> mapM_ recalculateCoincidenceHeight mcs
2409 mapM_ _someMergeUpdate_recalculateHeight mergeUpdates
2410 forM_ toReconnect $ \(SomeSwitchSubscribed subscribed) -> do
2411 height <- calculateSwitchHeight subscribed
2412 updateSwitchHeight height subscribed
2415newtype Height = Height { unHeight :: Int } deriving (Show, Read, Eq, Ord, Bounded)
2417{-# INLINE zeroHeight #-}
2419zeroHeight = Height 0
2421{-# INLINE invalidHeight #-}
2422invalidHeight :: Height
2423invalidHeight = Height (-1000)
2426-- | An invalid height that is currently being traversed, e.g. by walkInvalidHeightParents
2427{-# INLINE invalidHeightBeingTraversed #-}
2428invalidHeightBeingTraversed :: Height
2429invalidHeightBeingTraversed = Height (-1001)
2432{-# INLINE succHeight #-}
2433succHeight :: Height -> Height
2434succHeight h@(Height a) =
2435 if h == invalidHeight
2437 else Height $ succ a
2439invalidateCoincidenceHeight :: CoincidenceSubscribed x a -> IO ()
2440invalidateCoincidenceHeight subscribed = do
2441 oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
2442 when (oldHeight /= invalidHeight) $ do
2443 writeIORef (coincidenceSubscribedHeight subscribed) $! invalidHeight
2444 WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
2446updateSwitchHeight :: Height -> SwitchSubscribed x a -> IO ()
2447updateSwitchHeight new subscribed = do
2448 oldHeight <- readIORef $ switchSubscribedHeight subscribed
2449 when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
2450 when (new /= invalidHeight) $ do --TODO: This 'when' should probably be an assertion
2451 writeIORef (switchSubscribedHeight subscribed) $! new
2452 WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
2454recalculateCoincidenceHeight :: CoincidenceSubscribed x a -> IO ()
2455recalculateCoincidenceHeight subscribed = do
2456 oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
2457 when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
2458 height <- calculateCoincidenceHeight subscribed
2459 when (height /= invalidHeight) $ do
2460 writeIORef (coincidenceSubscribedHeight subscribed) $! height
2461 WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
2463calculateSwitchHeight :: SwitchSubscribed x a -> IO Height
2464calculateSwitchHeight subscribed = getEventSubscribedHeight . _eventSubscription_subscribed =<< readIORef (switchSubscribedCurrentParent subscribed)
2466calculateCoincidenceHeight :: CoincidenceSubscribed x a -> IO Height
2467calculateCoincidenceHeight subscribed = do
2468 outerHeight <- getEventSubscribedHeight $ _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
2469 innerHeight <- maybe (return zeroHeight) getEventSubscribedHeight =<< readIORef (coincidenceSubscribedInnerParent subscribed)
2470 return $ if outerHeight == invalidHeight || innerHeight == invalidHeight then invalidHeight else max outerHeight innerHeight
2472data SomeSwitchSubscribed x = forall a. SomeSwitchSubscribed {-# NOUNPACK #-} (SwitchSubscribed x a)
2474invalidate :: IORef [SomeSwitchSubscribed x] -> WeakList (Invalidator x) -> IO (WeakList (Invalidator x))
2475invalidate toReconnectRef wis = do
2476 forM_ wis $ \wi -> do
2480 traceInvalidate "invalidate Dead"
2481 return () --TODO: Should we clean this up here?
2483 finalize wi -- Once something's invalidated, it doesn't need to hang around; this will change when some things are strict
2485 InvalidatorPull p -> do
2486 traceInvalidate $ "invalidate: Pull" <> showNodeId p
2487 mVal <- readIORef $ pullValue p
2488 forM_ mVal $ \val -> do
2489 writeIORef (pullValue p) Nothing
2490 writeIORef (pullSubscribedInvalidators val) =<< evaluate =<< invalidate toReconnectRef =<< readIORef (pullSubscribedInvalidators val)
2491 InvalidatorSwitch subscribed -> do
2492 traceInvalidate $ "invalidate: Switch" <> showNodeId subscribed
2493 modifyIORef' toReconnectRef (SomeSwitchSubscribed subscribed :)
2494 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
2496--------------------------------------------------------------------------------
2497-- Reflex integration
2498--------------------------------------------------------------------------------
2500-- | Designates the default, global Spider timeline
2501data SpiderTimeline x
2502type role SpiderTimeline nominal
2504-- | The default, global Spider environment
2505type Spider = SpiderTimeline Global
2507instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (EventM x) where
2508 {-# INLINABLE sample #-}
2509 sample (SpiderBehavior b) = readBehaviorUntracked b
2511instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (EventM x) where
2512 {-# INLINABLE hold #-}
2513 hold = holdSpiderEventM
2514 {-# INLINABLE holdDyn #-}
2515 holdDyn = holdDynSpiderEventM
2516 {-# INLINABLE holdIncremental #-}
2517 holdIncremental = holdIncrementalSpiderEventM
2518 {-# INLINABLE buildDynamic #-}
2519 buildDynamic = buildDynamicSpiderEventM
2520 {-# INLINABLE headE #-}
2522-- headE (SpiderEvent e) = SpiderEvent <$> Reflex.Spider.Internal.headE e
2523 {-# INLINABLE now #-}
2524 now = nowSpiderEventM
2526instance Reflex.Class.MonadSample (SpiderTimeline x) (SpiderPullM x) where
2527 {-# INLINABLE sample #-}
2528 sample = coerce . readBehaviorTracked . unSpiderBehavior
2530instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderPushM x) where
2531 {-# INLINABLE sample #-}
2532 sample (SpiderBehavior b) = SpiderPushM $ readBehaviorUntracked b
2534instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderPushM x) where
2535 {-# INLINABLE hold #-}
2536 hold v0 e = Reflex.Class.current <$> Reflex.Class.holdDyn v0 e
2537 {-# INLINABLE holdDyn #-}
2538 holdDyn v0 (SpiderEvent e) = SpiderPushM $ fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce e
2539 {-# INLINABLE holdIncremental #-}
2540 holdIncremental v0 (SpiderEvent e) = SpiderPushM $ SpiderIncremental . dynamicHold <$> Reflex.Spider.Internal.hold v0 e
2541 {-# INLINABLE buildDynamic #-}
2542 buildDynamic getV0 (SpiderEvent e) = SpiderPushM $ fmap (SpiderDynamic . dynamicDynIdentity) $ Reflex.Spider.Internal.buildDynamic (coerce getV0) $ coerce e
2543 {-# INLINABLE headE #-}
2545-- headE (SpiderEvent e) = SpiderPushM $ SpiderEvent <$> Reflex.Spider.Internal.headE e
2546 {-# INLINABLE now #-}
2547 now = SpiderPushM nowSpiderEventM
2550instance HasSpiderTimeline x => Monad (Reflex.Class.Dynamic (SpiderTimeline x)) where
2551 {-# INLINE return #-}
2553 {-# INLINE (>>=) #-}
2554 x >>= f = SpiderDynamic $ dynamicDynIdentity $ newJoinDyn $ newMapDyn (unSpiderDynamic . f) $ unSpiderDynamic x
2557#if !MIN_VERSION_base(4,13,0)
2559 fail _ = error "Dynamic does not support 'fail'"
2562{-# INLINABLE newJoinDyn #-}
2563newJoinDyn :: HasSpiderTimeline x => DynamicS x (Identity (DynamicS x (Identity a))) -> Reflex.Spider.Internal.Dyn x (Identity a)
2565 let readV0 = readBehaviorTracked . dynamicCurrent =<< readBehaviorTracked (dynamicCurrent d)
2566 eOuter = Reflex.Spider.Internal.push (fmap (Just . Identity) . readBehaviorUntracked . dynamicCurrent . runIdentity) $ dynamicUpdated d
2567 eInner = Reflex.Spider.Internal.switch $ dynamicUpdated <$> dynamicCurrent d
2568 eBoth = Reflex.Spider.Internal.coincidence $ dynamicUpdated . runIdentity <$> dynamicUpdated d
2569 v' = unSpiderEvent $ Reflex.Class.leftmost $ map SpiderEvent [eBoth, eOuter, eInner]
2570 in Reflex.Spider.Internal.unsafeBuildDynamic readV0 v'
2572instance HasSpiderTimeline x => Functor (Reflex.Class.Dynamic (SpiderTimeline x)) where
2573 fmap = mapDynamicSpider
2574 x <$ d = R.unsafeBuildDynamic (return x) $ x <$ R.updated d
2576mapDynamicSpider :: HasSpiderTimeline x => (a -> b) -> Reflex.Class.Dynamic (SpiderTimeline x) a -> Reflex.Class.Dynamic (SpiderTimeline x) b
2577mapDynamicSpider f = SpiderDynamic . newMapDyn f . unSpiderDynamic
2578{-# INLINE [1] mapDynamicSpider #-}
2580instance HasSpiderTimeline x => Applicative (Reflex.Class.Dynamic (SpiderTimeline x)) where
2581 pure = SpiderDynamic . dynamicConst
2582#if MIN_VERSION_base(4,10,0)
2583 liftA2 f a b = SpiderDynamic $ Reflex.Spider.Internal.zipDynWith f (unSpiderDynamic a) (unSpiderDynamic b)
2585 SpiderDynamic a <*> SpiderDynamic b = SpiderDynamic $ Reflex.Spider.Internal.zipDynWith ($) a b
2586 a *> b = R.unsafeBuildDynamic (R.sample $ R.current b) $ R.leftmost [R.updated b, R.tag (R.current b) $ R.updated a]
2587 (<*) = flip (*>) -- There are no effects, so order doesn't matter
2589holdSpiderEventM :: HasSpiderTimeline x => a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Behavior (SpiderTimeline x) a)
2590holdSpiderEventM v0 e = fmap (SpiderBehavior . behaviorHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
2592holdDynSpiderEventM :: HasSpiderTimeline x => a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Dynamic (SpiderTimeline x) a)
2593holdDynSpiderEventM v0 e = fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
2595holdIncrementalSpiderEventM :: (HasSpiderTimeline x, Patch p) => PatchTarget p -> Reflex.Class.Event (SpiderTimeline x) p -> EventM x (Reflex.Class.Incremental (SpiderTimeline x) p)
2596holdIncrementalSpiderEventM v0 e = fmap (SpiderIncremental . dynamicHold) $ Reflex.Spider.Internal.hold v0 $ unSpiderEvent e
2598buildDynamicSpiderEventM :: HasSpiderTimeline x => SpiderPushM x a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Dynamic (SpiderTimeline x) a)
2599buildDynamicSpiderEventM getV0 e = fmap (SpiderDynamic . dynamicDynIdentity) $ Reflex.Spider.Internal.buildDynamic (coerce getV0) $ coerce $ unSpiderEvent e
2601instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderHost x) where
2602 {-# INLINABLE hold #-}
2603 hold v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.hold v0 e
2604 {-# INLINABLE holdDyn #-}
2605 holdDyn v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.holdDyn v0 e
2606 {-# INLINABLE holdIncremental #-}
2607 holdIncremental v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.holdIncremental v0 e
2608 {-# INLINABLE buildDynamic #-}
2609 buildDynamic getV0 e = runFrame . runSpiderHostFrame $ Reflex.Class.buildDynamic getV0 e
2610 {-# INLINABLE headE #-}
2611 headE e = runFrame . runSpiderHostFrame $ Reflex.Class.headE e
2612 {-# INLINABLE now #-}
2613 now = runFrame . runSpiderHostFrame $ Reflex.Class.now
2616instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHostFrame x) where
2617 sample = SpiderHostFrame . readBehaviorUntracked . unSpiderBehavior --TODO: This can cause problems with laziness, so we should get rid of it if we can
2619instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderHostFrame x) where
2620 {-# INLINABLE hold #-}
2621 hold v0 e = SpiderHostFrame $ fmap (SpiderBehavior . behaviorHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
2622 {-# INLINABLE holdDyn #-}
2623 holdDyn v0 e = SpiderHostFrame $ fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
2624 {-# INLINABLE holdIncremental #-}
2625 holdIncremental v0 e = SpiderHostFrame $ fmap (SpiderIncremental . dynamicHold) $ Reflex.Spider.Internal.hold v0 $ unSpiderEvent e
2626 {-# INLINABLE buildDynamic #-}
2627 buildDynamic getV0 e = SpiderHostFrame $ fmap (SpiderDynamic . dynamicDynIdentity) $ Reflex.Spider.Internal.buildDynamic (coerce getV0) $ coerce $ unSpiderEvent e
2628 {-# INLINABLE headE #-}
2630-- headE (SpiderEvent e) = SpiderHostFrame $ SpiderEvent <$> Reflex.Spider.Internal.headE e
2631 {-# INLINABLE now #-}
2632 now = SpiderHostFrame Reflex.Class.now
2634instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHost x) where
2635 {-# INLINABLE sample #-}
2636 sample = runFrame . readBehaviorUntracked . unSpiderBehavior
2638instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (Reflex.Spider.Internal.ReadPhase x) where
2639 {-# INLINABLE sample #-}
2640 sample = Reflex.Spider.Internal.ReadPhase . Reflex.Class.sample
2642instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Reflex.Spider.Internal.ReadPhase x) where
2643 {-# INLINABLE hold #-}
2644 hold v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.hold v0 e
2645 {-# INLINABLE holdDyn #-}
2646 holdDyn v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.holdDyn v0 e
2647 {-# INLINABLE holdIncremental #-}
2648 holdIncremental v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.holdIncremental v0 e
2649 {-# INLINABLE buildDynamic #-}
2650 buildDynamic getV0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.buildDynamic getV0 e
2651 {-# INLINABLE headE #-}
2652 headE e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.headE e
2653 {-# INLINABLE now #-}
2654 now = Reflex.Spider.Internal.ReadPhase Reflex.Class.now
2656--------------------------------------------------------------------------------
2658--------------------------------------------------------------------------------
2660-- | 'SpiderEnv' is the old name for 'SpiderTimeline'
2661{-# DEPRECATED SpiderEnv "Use 'SpiderTimelineEnv' instead" #-}
2662type SpiderEnv = SpiderTimeline
2663instance HasSpiderTimeline x => Reflex.Host.Class.MonadSubscribeEvent (SpiderTimeline x) (SpiderHostFrame x) where
2664 {-# INLINABLE subscribeEvent #-}
2665 subscribeEvent e = SpiderHostFrame $ do
2666 --TODO: Unsubscribe eventually (manually and/or with weak ref)
2667 val <- liftIO $ newIORef Nothing
2668 subscription <- subscribe (unSpiderEvent e) $ Subscriber
2669 { subscriberPropagate = \a -> do
2670 liftIO $ writeIORef val $ Just a
2672 , subscriberInvalidateHeight = \_ -> return ()
2673 , subscriberRecalculateHeight = \_ -> return ()
2675 return $ SpiderEventHandle
2676 { spiderEventHandleSubscription = subscription
2677 , spiderEventHandleValue = val
2680instance HasSpiderTimeline x => Reflex.Host.Class.ReflexHost (SpiderTimeline x) where
2681 type EventTrigger (SpiderTimeline x) = RootTrigger x
2682 type EventHandle (SpiderTimeline x) = SpiderEventHandle x
2683 type HostFrame (SpiderTimeline x) = SpiderHostFrame x
2685instance HasSpiderTimeline x => Reflex.Host.Class.MonadReadEvent (SpiderTimeline x) (Reflex.Spider.Internal.ReadPhase x) where
2686 {-# NOINLINE readEvent #-}
2687 readEvent h = Reflex.Spider.Internal.ReadPhase $ fmap (fmap return) $ liftIO $ do
2688 result <- readIORef $ spiderEventHandleValue h
2692instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHost x) where
2693 newEventWithTrigger = SpiderHost . fmap SpiderEvent . newEventWithTriggerIO
2694 newFanEventWithTrigger f = SpiderHost $ do
2695 es <- newFanEventWithTriggerIO f
2696 return $ Reflex.Class.EventSelector $ SpiderEvent . Reflex.Spider.Internal.select es
2698instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHostFrame x) where
2699 newEventWithTrigger = SpiderHostFrame . EventM . liftIO . fmap SpiderEvent . newEventWithTriggerIO
2700 newFanEventWithTrigger f = SpiderHostFrame $ EventM $ liftIO $ do
2701 es <- newFanEventWithTriggerIO f
2702 return $ Reflex.Class.EventSelector $ SpiderEvent . Reflex.Spider.Internal.select es
2704instance HasSpiderTimeline x => Reflex.Host.Class.MonadSubscribeEvent (SpiderTimeline x) (SpiderHost x) where
2705 {-# INLINABLE subscribeEvent #-}
2706 subscribeEvent = runFrame . runSpiderHostFrame . Reflex.Host.Class.subscribeEvent
2708instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexHost (SpiderTimeline x) (SpiderHost x) where
2709 type ReadPhase (SpiderHost x) = Reflex.Spider.Internal.ReadPhase x
2710 fireEventsAndRead es (Reflex.Spider.Internal.ReadPhase a) = run es a
2711 runHostFrame = runFrame . runSpiderHostFrame
2713unsafeNewSpiderTimelineEnv :: forall x. IO (SpiderTimelineEnv x)
2714unsafeNewSpiderTimelineEnv = do
2718 depthRef <- newIORef 0
2720 return $ STE $ SpiderTimelineEnv
2721 { _spiderTimeline_lock = lock
2722 , _spiderTimeline_eventEnv = env
2724 , _spiderTimeline_depth = depthRef
2728-- | Create a new SpiderTimelineEnv
2729newSpiderTimeline :: IO (Some SpiderTimelineEnv)
2730newSpiderTimeline = withSpiderTimeline (pure . Some)
2732data LocalSpiderTimeline (x :: Type) s
2734instance Reifies s (SpiderTimelineEnv x) =>
2735 HasSpiderTimeline (LocalSpiderTimeline x s) where
2736 spiderTimeline = localSpiderTimeline Proxy $ reflect (Proxy :: Proxy s)
2740 -> SpiderTimelineEnv x
2741 -> SpiderTimelineEnv (LocalSpiderTimeline x s)
2742localSpiderTimeline _ = coerce
2744-- | Pass a new timeline to the given function.
2745withSpiderTimeline :: (forall x. HasSpiderTimeline x => SpiderTimelineEnv x -> IO r) -> IO r
2746withSpiderTimeline k = do
2747 env <- unsafeNewSpiderTimelineEnv
2748 reify env $ \s -> k $ localSpiderTimeline s env
2750newtype SpiderPullM (x :: Type) a = SpiderPullM (BehaviorM x a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
2752type ComputeM = EventM
2754newtype SpiderPushM (x :: Type) a = SpiderPushM (ComputeM x a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
2756instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
2757 {-# SPECIALIZE instance R.Reflex (SpiderTimeline Global) #-}
2758 newtype Behavior (SpiderTimeline x) a = SpiderBehavior { unSpiderBehavior :: Behavior x a }
2759 newtype Event (SpiderTimeline x) a = SpiderEvent { unSpiderEvent :: Event x a }
2760 newtype Dynamic (SpiderTimeline x) a = SpiderDynamic { unSpiderDynamic :: DynamicS x (Identity a) } -- deriving (Functor, Applicative, Monad)
2761 newtype Incremental (SpiderTimeline x) p = SpiderIncremental { unSpiderIncremental :: DynamicS x p }
2762 type PullM (SpiderTimeline x) = SpiderPullM x
2763 type PushM (SpiderTimeline x) = SpiderPushM x
2764 {-# INLINABLE never #-}
2765 never = SpiderEvent eventNever
2766 {-# INLINABLE constant #-}
2767 constant = SpiderBehavior . behaviorConst
2769 push f = SpiderEvent . push (coerce f) . unSpiderEvent
2770 {-# INLINE pushCheap #-}
2771 pushCheap f = SpiderEvent . pushCheap (coerce f) . unSpiderEvent
2772 {-# INLINABLE pull #-}
2773 pull = SpiderBehavior . pull . coerce
2774 {-# INLINABLE fanG #-}
2775 fanG e = R.EventSelectorG $ SpiderEvent . selectG (fanG (unSpiderEvent e))
2776 {-# INLINABLE mergeG #-}
2778 :: forall k2 (k :: k2 -> *) q (v :: k2 -> *). GCompare k
2779 => (forall a. q a -> R.Event (SpiderTimeline x) (v a))
2781 -> R.Event (SpiderTimeline x) (DMap k v)
2782 mergeG nt = SpiderEvent . mergeG (unSpiderEvent #. nt) . dynamicConst
2783 {-# INLINABLE switch #-}
2784 switch = SpiderEvent . switch . (coerce :: Behavior x (R.Event (SpiderTimeline x) a) -> Behavior x (Event x a)) . unSpiderBehavior
2785 {-# INLINABLE coincidence #-}
2786 coincidence = SpiderEvent . coincidence . (coerce :: Event x (R.Event (SpiderTimeline x) a) -> Event x (Event x a)) . unSpiderEvent
2787 {-# INLINABLE current #-}
2788 current = SpiderBehavior . dynamicCurrent . unSpiderDynamic
2789 {-# INLINABLE updated #-}
2790 updated = SpiderEvent #. dynamicUpdated .# fmap coerce . unSpiderDynamic
2791 {-# INLINABLE unsafeBuildDynamic #-}
2792 unsafeBuildDynamic readV0 v' = SpiderDynamic $ dynamicDynIdentity $ unsafeBuildDynamic (coerce readV0) $ coerce $ unSpiderEvent v'
2793 {-# INLINABLE unsafeBuildIncremental #-}
2794 unsafeBuildIncremental readV0 dv = SpiderIncremental $ dynamicDyn $ unsafeBuildDynamic (coerce readV0) $ unSpiderEvent dv
2795 {-# INLINABLE mergeIncrementalG #-}
2796 mergeIncrementalG nt = SpiderEvent #. mergeG (coerce #. nt) .# unSpiderIncremental
2797 {-# INLINABLE mergeIncrementalWithMoveG #-}
2798 mergeIncrementalWithMoveG nt = SpiderEvent #. mergeWithMove (coerce #. nt) .# unSpiderIncremental
2799 {-# INLINABLE currentIncremental #-}
2800 currentIncremental = SpiderBehavior . dynamicCurrent . unSpiderIncremental
2801 {-# INLINABLE updatedIncremental #-}
2802 updatedIncremental = SpiderEvent . dynamicUpdated . unSpiderIncremental
2803 {-# INLINABLE incrementalToDynamic #-}
2804 incrementalToDynamic (SpiderIncremental i) = SpiderDynamic $ dynamicDynIdentity $ unsafeBuildDynamic (readBehaviorUntracked $ dynamicCurrent i) $ flip push (dynamicUpdated i) $ \p -> do
2805 c <- readBehaviorUntracked $ dynamicCurrent i
2806 return $ Identity <$> apply p c --TODO: Avoid the redundant 'apply'
2807 eventCoercion Coercion = Coercion
2808 behaviorCoercion Coercion = Coercion
2809 dynamicCoercion Coercion = Coercion
2810 incrementalCoercion Coercion Coercion = Coercion
2811 {-# INLINABLE mergeIntIncremental #-}
2812 mergeIntIncremental = SpiderEvent . mergeInt . coerce
2813 {-# INLINABLE fanInt #-}
2814 fanInt e = R.EventSelectorInt $ SpiderEvent . selectInt (fanInt (unSpiderEvent e))
2816data RootTrigger x a = forall k. GCompare k => RootTrigger (WeakBag (Subscriber x a), IORef (DMap k Identity), k a)
2818data SpiderEventHandle x a = SpiderEventHandle
2819 { spiderEventHandleSubscription :: EventSubscription x
2820 , spiderEventHandleValue :: IORef (Maybe a)
2823instance MonadRef (EventM x) where
2824 type Ref (EventM x) = Ref IO
2825 {-# INLINABLE newRef #-}
2826 {-# INLINABLE readRef #-}
2827 {-# INLINABLE writeRef #-}
2828 newRef = liftIO . newRef
2829 readRef = liftIO . readRef
2830 writeRef r a = liftIO $ writeRef r a
2832instance MonadAtomicRef (EventM x) where
2833 {-# INLINABLE atomicModifyRef #-}
2834 atomicModifyRef r f = liftIO $ atomicModifyRef r f
2836-- | The monad for actions that manipulate a Spider timeline identified by @x@
2837newtype SpiderHost (x :: Type) a = SpiderHost { unSpiderHost :: IO a } deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2839instance Monad (SpiderHost x) where
2840 {-# INLINABLE (>>=) #-}
2841 SpiderHost x >>= f = SpiderHost $ x >>= unSpiderHost . f
2842 {-# INLINABLE (>>) #-}
2843 SpiderHost x >> SpiderHost y = SpiderHost $ x >> y
2844 {-# INLINABLE return #-}
2845 return x = SpiderHost $ return x
2846#if !MIN_VERSION_base(4,13,0)
2847 {-# INLINABLE fail #-}
2848 fail = MonadFail.fail
2851instance MonadFail (SpiderHost x) where
2852 {-# INLINABLE fail #-}
2853 fail s = SpiderHost $ MonadFail.fail s
2855-- | Run an action affecting the global Spider timeline; this will be guarded by
2856-- a mutex for that timeline
2857runSpiderHost :: SpiderHost Global a -> IO a
2858runSpiderHost (SpiderHost a) = a
2860-- | Run an action affecting a given Spider timeline; this will be guarded by a
2861-- mutex for that timeline
2862runSpiderHostForTimeline :: SpiderHost x a -> SpiderTimelineEnv x -> IO a
2863runSpiderHostForTimeline (SpiderHost a) _ = a
2865newtype SpiderHostFrame (x :: Type) a = SpiderHostFrame { runSpiderHostFrame :: EventM x a }
2866 deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2868instance Monad (SpiderHostFrame x) where
2869 {-# INLINABLE (>>=) #-}
2870 SpiderHostFrame x >>= f = SpiderHostFrame $ x >>= runSpiderHostFrame . f
2871 {-# INLINABLE (>>) #-}
2872 SpiderHostFrame x >> SpiderHostFrame y = SpiderHostFrame $ x >> y
2873 {-# INLINABLE return #-}
2874 return x = SpiderHostFrame $ return x
2875#if !MIN_VERSION_base(4,13,0)
2876 {-# INLINABLE fail #-}
2877 fail s = SpiderHostFrame $ fail s
2880instance NotReady (SpiderTimeline x) (SpiderHostFrame x) where
2881 notReadyUntil _ = pure ()
2884newEventWithTriggerIO :: forall x a. HasSpiderTimeline x => (RootTrigger x a -> IO (IO ())) -> IO (Event x a)
2885newEventWithTriggerIO f = do
2886 es <- newFanEventWithTriggerIO $ \Refl -> f
2887 return $ select es Refl
2889newFanEventWithTriggerIO :: (HasSpiderTimeline x, GCompare k) => (forall a. k a -> RootTrigger x a -> IO (IO ())) -> IO (EventSelector x k)
2890newFanEventWithTriggerIO f = do
2891 occRef <- newIORef DMap.empty
2892 subscribedRef <- newIORef DMap.empty
2894 { rootOccurrence = occRef
2895 , rootSubscribed = subscribedRef
2898 return $ EventSelector $ \k -> eventRoot k r
2900newtype ReadPhase x a = ReadPhase (ResultM x a) deriving (Functor, Applicative, Monad, MonadFix)
2902instance MonadRef (SpiderHost x) where
2903 type Ref (SpiderHost x) = Ref IO
2904 newRef = SpiderHost . newRef
2905 readRef = SpiderHost . readRef
2906 writeRef r = SpiderHost . writeRef r
2908instance MonadAtomicRef (SpiderHost x) where
2909 atomicModifyRef r = SpiderHost . atomicModifyRef r
2911instance MonadRef (SpiderHostFrame x) where
2912 type Ref (SpiderHostFrame x) = Ref IO
2913 newRef = SpiderHostFrame . newRef
2914 readRef = SpiderHostFrame . readRef
2915 writeRef r = SpiderHostFrame . writeRef r
2917instance MonadAtomicRef (SpiderHostFrame x) where
2918 atomicModifyRef r = SpiderHostFrame . atomicModifyRef r
2920instance PrimMonad (SpiderHostFrame x) where
2921 type PrimState (SpiderHostFrame x) = PrimState IO
2922 primitive = SpiderHostFrame . EventM . primitive
2924instance NotReady (SpiderTimeline x) (SpiderHost x) where
2925 notReadyUntil _ = return ()
2926 notReady = return ()
2928instance HasSpiderTimeline x => NotReady (SpiderTimeline x) (PerformEventT (SpiderTimeline x) (SpiderHost x)) where
2929 notReadyUntil _ = return ()
2930 notReady = return ()
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list