@@ -0,0 +1,2262 @@
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 MagicHash #-}
13+{-# LANGUAGE MultiParamTypeClasses #-}
14+{-# LANGUAGE MultiWayIf #-}
15+{-# LANGUAGE RankNTypes #-}
16+{-# LANGUAGE RoleAnnotations #-}
17+{-# LANGUAGE ScopedTypeVariables #-}
18+{-# LANGUAGE TypeFamilies #-}
19+{-# LANGUAGE TypeOperators #-}
20+{-# LANGUAGE UndecidableInstances #-}
21+-- | This module is the implementation of the 'Spider' 'Reflex' engine. It uses
22+-- a graph traversal algorithm to propagate 'Event's and 'Behavior's.
23+module Reflex.Spider.Internal
33+import Control.Applicative
34+import Control.Concurrent
35+import Control.Exception
36+import Control.Monad hiding (forM, forM_, mapM, mapM_, sequence)
37+import Control.Monad.Exception
38+import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence)
39+import Control.Monad.Primitive
40+import Control.Monad.Reader hiding (forM, forM_, mapM, mapM_, sequence)
41+import Control.Monad.Ref
42+import Control.Monad.State hiding (forM, forM_, mapM, mapM_, sequence)
45+import Data.Dependent.Map (DMap, DSum (..))
46+import qualified Data.Dependent.Map as DMap
47+import Data.Foldable hiding (concat, elem, sequence_)
49+import Data.Functor.Compose
50+import Data.GADT.Compare
51+import Data.IntMap.Strict (IntMap)
52+import qualified Data.IntMap.Strict as IntMap
54+import Data.List hiding (foldl')
55+import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
56+import qualified Data.List.NonEmpty as NonEmpty
58+import Data.Monoid (mempty, (<>))
59+import Data.Some (Some)
60+import qualified Data.Some as Some
62+import Data.Traversable
63+import Data.Tree (Forest, Tree (..), drawForest)
65+import GHC.IORef (IORef (..))
67+import System.IO.Unsafe
68+import System.Mem.Weak
71+import Data.WeakBag (WeakBag, WeakBagTicket)
72+import qualified Data.WeakBag as WeakBag
73+import qualified Reflex.Class as R
74+import qualified Reflex.Host.Class as R
76+-- Note: must come last to silence warnings due to AMP on GHC < 7.10
77+import Prelude hiding (any, concat, mapM, mapM_, sequence)
79+type SubscriberList a = WeakBag (Subscriber a)
80+type SubscriberListTicket a = WeakBagTicket (Subscriber a)
82+debugPropagate :: Bool
84+debugInvalidateHeight :: Bool
86+debugInvalidate :: Bool
94+debugInvalidateHeight = False
96+debugInvalidate = True
98+class HasNodeId a where
99+ getNodeId :: a -> Int
101+instance HasNodeId (Hold p a) where
102+ getNodeId = holdNodeId
104+instance HasNodeId (PushSubscribed a b) where
105+ getNodeId = pushSubscribedNodeId
107+instance HasNodeId (SwitchSubscribed a) where
108+ getNodeId = switchSubscribedNodeId
110+instance HasNodeId (MergeSubscribed a) where
111+ getNodeId = mergeSubscribedNodeId
113+instance HasNodeId (FanSubscribed a) where
114+ getNodeId = fanSubscribedNodeId
116+instance HasNodeId (CoincidenceSubscribed a) where
117+ getNodeId = coincidenceSubscribedNodeId
119+instance HasNodeId (RootSubscribed a) where
120+ getNodeId = rootSubscribedNodeId
122+instance HasNodeId (Pull a) where
123+ getNodeId = pullNodeId
125+{-# INLINE showNodeId #-}
126+showNodeId :: HasNodeId a => a -> String
127+showNodeId = ("#"<>) . show . getNodeId
129+showSubscriberType :: Subscriber a -> String
130+showSubscriberType = \case
131+ SubscriberPush _ _ -> "SubscriberPush"
132+ SubscriberMerge _ _ -> "SubscriberMerge"
133+ SubscriberFan _ -> "SubscriberFan"
134+ SubscriberMergeChange _ -> "SubscriberMergeChange"
135+ SubscriberHold _ -> "SubscriberHold"
136+ SubscriberHoldIdentity _ -> "SubscriberHoldIdentity"
137+ SubscriberSwitch _ -> "SubscriberSwitch"
138+ SubscriberCoincidenceOuter _ -> "SubscriberCoincidenceOuter"
139+ SubscriberCoincidenceInner _ -> "SubscriberCoincidenceInner"
140+ SubscriberHandle -> "SubscriberHandle"
142+showEventType :: Event a -> String
143+showEventType = \case
144+ EventRoot _ _ -> "EventRoot"
145+ EventNever -> "EventNever"
146+ EventPush _ -> "EventPush"
147+ EventMerge _ -> "EventMerge"
148+ EventFan _ _ -> "EventFan"
149+ EventSwitch _ -> "EventSwitch"
150+ EventCoincidence _ -> "EventCoincidence"
151+ EventHold _ -> "EventHold"
152+ EventDyn _ -> "EventDyn"
153+ EventHoldIdentity _ -> "EventHoldIdentity"
154+ EventDynIdentity _ -> "EventDynIdentity"
158+debugPropagate = False
160+debugInvalidateHeight = False
162+debugInvalidate = False
164+-- This must be inline, or error messages will cause memory leaks due to retaining the node in question
165+{-# INLINE showNodeId #-}
166+showNodeId :: a -> String
172+{-# NOINLINE nextNodeIdRef #-}
173+nextNodeIdRef :: IORef Int
174+nextNodeIdRef = unsafePerformIO $ newIORef 1
177+newNodeId = atomicModifyIORef' nextNodeIdRef $ \n -> (succ n, n)
179+{-# NOINLINE unsafeNodeId #-}
180+unsafeNodeId :: a -> Int
181+unsafeNodeId a = unsafePerformIO $ do
186+--TODO: Figure out why certain things are not 'representational', then make them representational so we can use coerce
187+--type role Hold representational
189+ = Hold { holdValue :: !(IORef a)
190+ , holdInvalidators :: !(IORef [Weak Invalidator])
191+ , holdParent :: !(IORef (Either (Event (p a)) (EventSubscription (p a)))) -- Keeps its parent alive (will be undefined until the hold is initialized) --TODO: Probably shouldn't be an IORef
198+ = EventEnv { eventEnvSpiderEnv :: !(SpiderEnv x)
199+ , eventEnvAssignments :: !(IORef [SomeAssignment]) -- Needed for Subscribe
200+ , eventEnvHoldInits :: !(IORef [SomeHoldInit]) -- Needed for Subscribe
201+ , eventEnvMergeUpdates :: !(IORef [SomeMergeUpdate])
202+ , eventEnvMergeInits :: !(IORef [SomeMergeInit]) -- Needed for Subscribe
203+ , eventEnvClears :: !(IORef [SomeClear]) -- Needed for Subscribe
204+ , eventEnvRootClears :: !(IORef [SomeRootClear])
205+ , eventEnvCurrentHeight :: !(IORef Height) -- Needed for Subscribe
206+ , eventEnvResetCoincidences :: !(IORef [SomeResetCoincidence]) -- Needed for Subscribe
207+ , eventEnvDelayedMerges :: !(IORef (IntMap [DelayedMerge]))
210+{-# INLINE runEventM #-}
211+runEventM :: EventM x a -> EventEnv x -> IO a
212+runEventM = runReaderT . unEventM
214+class MonadIO m => Defer a m where
215+ getDeferralQueue :: m (IORef [a])
218+defer :: Defer a m => a -> m ()
220+ q <- getDeferralQueue
221+ liftIO $ modifyIORef' q (a:)
223+instance Defer SomeAssignment (EventM x) where
224+ {-# INLINE getDeferralQueue #-}
225+ getDeferralQueue = EventM $ asks eventEnvAssignments
227+instance Defer SomeHoldInit (EventM x) where
228+ {-# INLINE getDeferralQueue #-}
229+ getDeferralQueue = EventM $ asks eventEnvHoldInits
231+instance Defer SomeHoldInit BehaviorM where
232+ {-# INLINE getDeferralQueue #-}
233+ getDeferralQueue = BehaviorM $ asks snd
235+instance Defer SomeMergeUpdate (EventM x) where
236+ {-# INLINE getDeferralQueue #-}
237+ getDeferralQueue = EventM $ asks eventEnvMergeUpdates
239+instance Defer SomeMergeInit (EventM x) where
240+ {-# INLINE getDeferralQueue #-}
241+ getDeferralQueue = EventM $ asks eventEnvMergeInits
243+class HasCurrentHeight m where
244+ getCurrentHeight :: m Height
245+ scheduleMerge :: Height -> MergeSubscribed a -> m ()
247+instance HasCurrentHeight (EventM x) where
248+ {-# INLINE getCurrentHeight #-}
249+ getCurrentHeight = EventM $ do
250+ heightRef <- asks eventEnvCurrentHeight
251+ liftIO $ readIORef heightRef
252+ {-# INLINE scheduleMerge #-}
253+ scheduleMerge height subscribed = EventM $ do
254+ delayedRef <- asks eventEnvDelayedMerges
255+ liftIO $ modifyIORef' delayedRef $ IntMap.insertWith (++) (unHeight height) [DelayedMerge subscribed]
257+class HasSpiderEnv x m | m -> x where
258+ -- | Retrieve the current SpiderEnv
259+ askSpiderEnv :: m (SpiderEnv x)
261+instance HasSpiderEnv x (EventM x) where
262+ {-# INLINE askSpiderEnv #-}
263+ askSpiderEnv = EventM $ asks eventEnvSpiderEnv
265+instance HasSpiderEnv x (SpiderHost x) where
266+ {-# INLINE askSpiderEnv #-}
267+ askSpiderEnv = SpiderHost ask
269+putCurrentHeight :: Height -> EventM x ()
270+putCurrentHeight h = EventM $ do
271+ heightRef <- asks eventEnvCurrentHeight
272+ liftIO $ writeIORef heightRef $! h
274+instance Defer SomeClear (EventM x) where
275+ {-# INLINE getDeferralQueue #-}
276+ getDeferralQueue = EventM $ asks eventEnvClears
278+{-# INLINE scheduleClear #-}
279+scheduleClear :: Defer SomeClear m => IORef (Maybe a) -> m ()
280+scheduleClear r = defer $ SomeClear r
282+instance Defer SomeRootClear (EventM x) where
283+ {-# INLINE getDeferralQueue #-}
284+ getDeferralQueue = EventM $ asks eventEnvRootClears
286+{-# INLINE scheduleRootClear #-}
287+scheduleRootClear :: Defer SomeRootClear m => IORef (DMap k Identity) -> m ()
288+scheduleRootClear r = defer $ SomeRootClear r
290+instance Defer SomeResetCoincidence (EventM x) where
291+ {-# INLINE getDeferralQueue #-}
292+ getDeferralQueue = EventM $ asks eventEnvResetCoincidences
294+-- Note: hold cannot examine its event until after the phase is over
295+{-# SPECIALIZE hold :: R.Patch p => a -> Event (p a) -> EventM x (Hold p a) #-}
296+{-# SPECIALIZE hold :: R.Patch p => a -> Event (p a) -> ComputeM (Hold p a) #-}
297+hold :: (R.Patch p, Defer SomeHoldInit m) => a -> Event (p a) -> m (Hold p a)
299+ valRef <- liftIO $ newIORef v0
300+ invsRef <- liftIO $ newIORef []
301+ parentRef <- liftIO $ newIORef $ Left e
303+ nodeId <- liftIO newNodeId
306+ { holdValue = valRef
307+ , holdInvalidators = invsRef
308+ , holdParent = parentRef
310+ , holdNodeId = nodeId
313+ defer $ SomeHoldInit h
316+{-# INLINE getHoldEventSubscription #-}
317+getHoldEventSubscription :: forall m p a x. (Defer SomeAssignment m, Defer SomeHoldInit m, Defer SomeClear m, R.Patch p, HasCurrentHeight m, Defer SomeMergeInit m, Defer SomeResetCoincidence m, HasSpiderEnv x m) => Hold p a -> m (EventSubscription (p a))
318+getHoldEventSubscription h = do
319+ ep <- liftIO $ readIORef $ holdParent h
321+ Right subd -> return subd
323+ subscriptionRef <- liftIO $ newIORef $ error "getHoldEventSubscription: subdRef uninitialized"
324+ subscription@(EventSubscription _ subd) <- subscribe e =<< liftIO (newSubscriberHold h)
325+ liftIO $ writeIORef subscriptionRef $! subscription
326+ occ <- liftIO $ readEventSubscribed subd
328+ Nothing -> return ()
330+ old <- liftIO $ readIORef $ holdValue h
331+ case R.apply o old of
332+ Nothing -> return ()
334+ -- Need to evaluate these so that we don't retain the Hold itself
335+ v <- liftIO $ evaluate $ holdValue h
336+ i <- liftIO $ evaluate $ holdInvalidators h
337+ defer $ SomeAssignment v i new
338+ liftIO $ writeIORef (holdParent h) $ Right subscription
341+type BehaviorEnv = (Maybe (Weak Invalidator, IORef [SomeBehaviorSubscribed]), IORef [SomeHoldInit])
343+--type role BehaviorM representational
344+-- BehaviorM can sample behaviors
345+newtype BehaviorM a = BehaviorM { unBehaviorM :: ReaderT BehaviorEnv IO a } deriving (Functor, Applicative, MonadIO, MonadFix)
347+instance Monad BehaviorM where
348+ {-# INLINE (>>=) #-}
349+ BehaviorM x >>= f = BehaviorM $ x >>= unBehaviorM . f
351+ BehaviorM x >> BehaviorM y = BehaviorM $ x >> y
352+ {-# INLINE return #-}
353+ return x = BehaviorM $ return x
355+ fail s = BehaviorM $ fail s
357+data BehaviorSubscribed a
358+ = forall p. BehaviorSubscribedHold (Hold p a)
359+ | BehaviorSubscribedPull (PullSubscribed a)
361+data SomeBehaviorSubscribed = forall a. SomeBehaviorSubscribed (BehaviorSubscribed a)
363+--type role PullSubscribed representational
364+data PullSubscribed a
365+ = PullSubscribed { pullSubscribedValue :: !a
366+ , pullSubscribedInvalidators :: !(IORef [Weak Invalidator])
367+ , pullSubscribedOwnInvalidator :: !Invalidator
368+ , pullSubscribedParents :: ![SomeBehaviorSubscribed] -- Need to keep parent behaviors alive, or they won't let us know when they're invalidated
371+--type role Pull representational
373+ = Pull { pullValue :: !(IORef (Maybe (PullSubscribed a)))
374+ , pullCompute :: !(BehaviorM a)
381+ = forall a. InvalidatorPull (Pull a)
382+ | forall a. InvalidatorSwitch (SwitchSubscribed a)
384+data RootSubscribed a = forall k. GCompare k => RootSubscribed
385+ { rootSubscribedKey :: !(k a)
386+ , rootSubscribedCachedSubscribed :: !(IORef (DMap k RootSubscribed)) -- From the original Root
387+ , rootSubscribedSubscribers :: !(SubscriberList a)
388+ , rootSubscribedOccurrence :: !(IO (Maybe a)) -- Lookup from rootOccurrence
389+ , rootSubscribedUninit :: IO ()
390+ , rootSubscribedWeakSelf :: !(IORef (Weak (RootSubscribed a))) --TODO: Can we make this a lazy non-IORef and then force it manually to avoid an indirection each time we use it?
392+ , rootSubscribedNodeId :: Int
396+data Root (k :: * -> *)
397+ = Root { rootOccurrence :: !(IORef (DMap k Identity)) -- The currently-firing occurrence of this event
398+ , rootSubscribed :: !(IORef (DMap k RootSubscribed))
399+ , rootInit :: !(forall a. k a -> RootTrigger a -> IO (IO ()))
402+data SomeHoldInit = forall p a. R.Patch p => SomeHoldInit !(Hold p a)
404+data SomeMergeUpdate = forall k. GCompare k => SomeMergeUpdate (R.PatchDMap (DMap k Event)) (MergeSubscribed k)
406+data SomeMergeInit = forall k. GCompare k => SomeMergeInit !(MergeSubscribed k) !(Event (R.PatchDMap (DMap k Event)))
408+data SomeEventSubscription = forall a. SomeEventSubscription (EventSubscription a)
410+-- EventM can do everything BehaviorM can, plus create holds
411+newtype EventM x a = EventM { unEventM :: ReaderT (EventEnv x) IO a } deriving (Functor, Applicative, Monad, MonadIO, MonadFix, MonadException, MonadAsyncException) -- The environment should be Nothing if we are not in a frame, and Just if we are - in which case it is a list of assignments to be done after the frame is over
413+data PushSubscribed a b
414+ = PushSubscribed { pushSubscribedCachedSubscribed :: !(IORef (Maybe (PushSubscribed a b)))
415+ , pushSubscribedOccurrence :: !(IORef (Maybe b)) -- If the current height is less than our height, this should always be Nothing; during our height, this will get filled in at some point, always before our children are notified; after our height, this will be filled in with the correct value (Nothing if we are not firing, Just if we are)
416+ , pushSubscribedHeight :: !(IORef Height)
417+ , pushSubscribedSubscribers :: !(SubscriberList b)
418+ , pushSubscribedSelf :: !(Subscriber a) -- Hold this in memory to ensure our WeakReferences don't die --TODO: Probably unneeded now
419+ , pushSubscribedWeakSelf :: !(IORef (Weak (PushSubscribed a b)))
420+ , pushSubscribedParent :: !(EventSubscription a)
422+ , pushSubscribedNodeId :: Int
426+newtype ComputeM a = ComputeM (ReaderT (IORef [SomeHoldInit]) IO a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
428+instance Defer SomeHoldInit ComputeM where
429+ getDeferralQueue = ComputeM ask
431+{-# SPECIALIZE runComputeM :: ComputeM a -> EventM x a #-}
432+runComputeM :: Defer SomeHoldInit m => ComputeM a -> m a
433+runComputeM (ComputeM a) = liftIO . runReaderT a =<< getDeferralQueue
436+ = Push { pushCompute :: !(a -> ComputeM (Maybe b)) -- Compute the current firing value; assumes that its parent has been computed --TODO: This only uses Defer SomeHoldInit EventM; perhaps only the hold init queue should be passed in (also, perhaps those hold inits can be accelerated - can there be a loop we would need to worry about?)
437+ , pushParent :: !(Event a)
438+ , pushSubscribed :: !(IORef (Maybe (PushSubscribed a b))) --TODO: Can we replace this with an unsafePerformIO thunk?
441+data MergeSubscribedParent k a = MergeSubscribedParent !(EventSubscription a) !(Subscriber a)
443+mergeSubscribedParentSubscription :: MergeSubscribedParent k a -> EventSubscription a
444+mergeSubscribedParentSubscription (MergeSubscribedParent es _) = es
446+data HeightBag = HeightBag
447+ { _heightBag_size :: {-# UNPACK #-} !Int
448+ , _heightBag_contents :: !(IntMap Word) -- Number of excess in each bucket
450+ deriving (Show, Read, Eq, Ord)
452+heightBagEmpty :: HeightBag
453+heightBagEmpty = heightBagVerify $ HeightBag 0 IntMap.empty
455+heightBagSize :: HeightBag -> Int
456+heightBagSize = _heightBag_size
458+heightBagFromList :: [Height] -> HeightBag
459+heightBagFromList heights = heightBagVerify $ foldl' (flip heightBagAdd) heightBagEmpty heights
461+heightBagAdd :: Height -> HeightBag -> HeightBag
462+heightBagAdd (Height h) (HeightBag s c) = heightBagVerify $ HeightBag (succ s) $ IntMap.insertWithKey (\_ _ old -> succ old) h 0 c
464+heightBagRemove :: Height -> HeightBag -> HeightBag
465+heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.lookup h c of
466+ Nothing -> error $ "heightBagRemove: Height " <> show h <> " not present in bag " <> show b
467+ Just old -> HeightBag (pred s) $ case old of
468+ 0 -> IntMap.delete h c
469+ _ -> IntMap.insert h (pred old) c
471+heightBagMax :: HeightBag -> Height
472+heightBagMax (HeightBag _ c) = case IntMap.maxViewWithKey c of
473+ Just ((h, _), _) -> Height h
474+ Nothing -> zeroHeight
476+heightBagVerify :: HeightBag -> HeightBag
478+heightBagVerify b@(HeightBag s c) = if
479+ | s /= IntMap.size c + fromIntegral (sum (IntMap.elems c))
480+ -> error $ "heightBagVerify: size doesn't match: " <> show b
481+ | unHeight invalidHeight `IntMap.member` c
482+ -> error $ "heightBagVerify: contains invalid height: " <> show b
488+data MergeSubscribed k
489+ = MergeSubscribed { mergeSubscribedCachedSubscribed :: !(IORef (Maybe (MergeSubscribed k))) -- From the original merge
490+ , mergeSubscribedOccurrence :: !(IORef (Maybe (DMap k Identity)))
491+ , mergeSubscribedAccum :: !(IORef (DMap k Identity)) -- This will accumulate occurrences until our height is reached, at which point it will be transferred to mergeSubscribedOccurrence
492+ , mergeSubscribedHeight :: !(IORef Height)
493+ , mergeSubscribedHeightBag :: !(IORef HeightBag)
494+ , mergeSubscribedSubscribers :: !(SubscriberList (DMap k Identity))
495+ , mergeSubscribedChange :: !(IORef (Subscriber (R.PatchDMap (DMap k Event)), EventSubscribed (R.PatchDMap (DMap k Event))))
496+ , mergeSubscribedParents :: !(IORef (DMap k (MergeSubscribedParent k)))
497+ , mergeSubscribedWeakSelf :: !(IORef (Weak (MergeSubscribed k)))
499+ , mergeSubscribedNodeId :: Int
503+--TODO: DMap sucks; we should really write something better (with a functor for the value as well as the key)
505+ = Merge { mergeParents :: !(Dynamic R.PatchDMap (DMap k Event))
506+ , mergeSubscribed :: !(IORef (Maybe (MergeSubscribed k)))
509+data FanSubscribedChildren k a = FanSubscribedChildren
510+ { _fanSubscribedChildren_list :: !(SubscriberList a)
511+ , _fanSubscribedChildren_self :: {-# NOUNPACK #-} !(k a, FanSubscribed k)
512+ , _fanSubscribedChildren_weakSelf :: !(IORef (Weak (k a, FanSubscribed k)))
516+ = FanSubscribed { fanSubscribedCachedSubscribed :: !(IORef (Maybe (FanSubscribed k)))
517+ , fanSubscribedSubscribers :: !(IORef (DMap k (FanSubscribedChildren k))) -- This DMap should never be empty
518+ , fanSubscribedParent :: !(EventSubscription (DMap k Identity))
520+ , fanSubscribedNodeId :: Int
525+ = Fan { fanParent :: !(Event (DMap k Identity))
526+ , fanSubscribed :: !(IORef (Maybe (FanSubscribed k)))
529+data SwitchSubscribed a
530+ = SwitchSubscribed { switchSubscribedCachedSubscribed :: !(IORef (Maybe (SwitchSubscribed a)))
531+ , switchSubscribedOccurrence :: !(IORef (Maybe a))
532+ , switchSubscribedHeight :: !(IORef Height)
533+ , switchSubscribedSubscribers :: !(SubscriberList a)
534+ , switchSubscribedOwnInvalidator :: {-# NOUNPACK #-} !Invalidator
535+ , switchSubscribedOwnWeakInvalidator :: !(IORef (Weak Invalidator))
536+ , switchSubscribedBehaviorParents :: !(IORef [SomeBehaviorSubscribed])
537+ , switchSubscribedParent :: !(Behavior (Event a))
538+ , switchSubscribedCurrentParent :: !(IORef (EventSubscription a))
539+ , switchSubscribedWeakSelf :: !(IORef (Weak (SwitchSubscribed a)))
541+ , switchSubscribedNodeId :: Int
546+ = Switch { switchParent :: !(Behavior (Event a))
547+ , switchSubscribed :: !(IORef (Maybe (SwitchSubscribed a)))
550+{-# ANN CoincidenceSubscribed "HLint: ignore Redundant bracket" #-}
551+data CoincidenceSubscribed a
552+ = CoincidenceSubscribed { coincidenceSubscribedCachedSubscribed :: !(IORef (Maybe (CoincidenceSubscribed a)))
553+ , coincidenceSubscribedOccurrence :: !(IORef (Maybe a))
554+ , coincidenceSubscribedSubscribers :: !(SubscriberList a)
555+ , coincidenceSubscribedHeight :: !(IORef Height)
556+ , coincidenceSubscribedOuter :: {-# NOUNPACK #-} (Subscriber (Event a))
557+ , coincidenceSubscribedOuterParent :: !(EventSubscription (Event a))
558+ , coincidenceSubscribedInnerParent :: !(IORef (Maybe (EventSubscribed a)))
559+ , coincidenceSubscribedWeakSelf :: !(IORef (Weak (CoincidenceSubscribed a)))
561+ , coincidenceSubscribedNodeId :: Int
566+ = Coincidence { coincidenceParent :: !(Event (Event a))
567+ , coincidenceSubscribed :: !(IORef (Maybe (CoincidenceSubscribed a)))
571+ = forall b. SubscriberPush (a -> ComputeM (Maybe b)) (PushSubscribed a b) --TODO: Why does this have the pushCompute in it?
572+ | forall k. GCompare k => SubscriberMerge !(k a) (MergeSubscribed k) --TODO: Can we inline the GCompare?
573+ | forall k. (a ~ R.PatchDMap (DMap k Event), GCompare k) => SubscriberMergeChange (MergeSubscribed k)
574+ | forall k. (GCompare k, a ~ DMap k Identity) => SubscriberFan (FanSubscribed k)
575+ | forall p b. (a ~ p b, R.Patch p) => SubscriberHold !(Hold p b)
576+ | forall b. (a ~ Identity b) => SubscriberHoldIdentity !(Hold Identity b)
577+ | SubscriberSwitch (SwitchSubscribed a)
578+ | forall b. a ~ Event b => SubscriberCoincidenceOuter (CoincidenceSubscribed b)
579+ | SubscriberCoincidenceInner (CoincidenceSubscribed a)
583+ = forall k. GCompare k => EventRoot !(k a) !(Root k)
585+ | forall b. EventPush !(Push b a)
586+ | forall k. (GCompare k, a ~ DMap k Identity) => EventMerge !(Merge k)
587+ | forall k. GCompare k => EventFan !(k a) !(Fan k)
588+ | EventSwitch !(Switch a)
589+ | EventCoincidence !(Coincidence a)
590+ | forall p b. (a ~ p b, R.Patch p) => EventHold !(Hold p b)
591+ | forall p b. (a ~ p b, R.Patch p) => EventDyn !(Dyn p b)
592+ | forall b. (a ~ Identity b) => EventHoldIdentity !(Hold Identity b)
593+ | forall b. (a ~ Identity b) => EventDynIdentity !(Dyn Identity b)
595+data EventSubscription a = EventSubscription
596+ { _eventSubscription_ticket :: !(Maybe (SubscriberListTicket a))
597+ , _eventSubscription_subscribed :: !(EventSubscribed a)
600+data EventSubscribed a
601+ = EventSubscribedRoot {-# NOUNPACK #-} (RootSubscribed a)
602+ | EventSubscribedNever
603+ | forall b. EventSubscribedPush !(PushSubscribed b a)
604+ | forall k. (GCompare k, a ~ DMap k Identity) => EventSubscribedMerge !(MergeSubscribed k)
605+ | forall k. GCompare k => EventSubscribedFan !(k a) !(FanSubscribed k)
606+ | EventSubscribedSwitch !(SwitchSubscribed a)
607+ | EventSubscribedCoincidence !(CoincidenceSubscribed a)
609+unsubscribe :: EventSubscription a -> IO ()
610+unsubscribe (EventSubscription msln _) = forM_ msln $ \sln -> WeakBag.remove sln
612+-- These function are constructor functions that are marked NOINLINE so they are
613+-- opaque to GHC. If we do not do this, then GHC will sometimes fuse the constructor away
614+-- so any weak references that are attached to the constructors will have their
615+-- finalizer run. Using the opaque constructor, does not see the
616+-- constructor application, so it behaves like an IORef and cannot be fused away.
618+-- The result is also evaluated to WHNF, since forcing a thunk invalidates
619+-- the weak pointer to it in some cases.
621+--TODO: I think all of these noinlines are now unnecessary
622+{-# NOINLINE newSubscriberPush #-}
623+newSubscriberPush :: (a -> ComputeM (Maybe b)) -> PushSubscribed a b -> IO (Subscriber a)
624+newSubscriberPush compute subd = return $! SubscriberPush compute subd
627+ "newSubscriberHold/Identity" forall h. newSubscriberHold h = newSubscriberHoldIdentity h
629+{-# NOINLINE newSubscriberHold #-}
630+newSubscriberHold :: R.Patch p => Hold p a -> IO (Subscriber (p a))
631+newSubscriberHold h = return $! SubscriberHold h
633+{-# NOINLINE newSubscriberHoldIdentity #-}
634+newSubscriberHoldIdentity :: Hold Identity a -> IO (Subscriber (Identity a))
635+newSubscriberHoldIdentity h = return $! SubscriberHoldIdentity h
637+{-# NOINLINE newSubscriberMerge #-}
638+newSubscriberMerge :: GCompare k => k a -> MergeSubscribed k -> IO (Subscriber a)
639+newSubscriberMerge k subd = return $! SubscriberMerge k subd
641+{-# NOINLINE newSubscriberMergeChange #-}
642+newSubscriberMergeChange :: GCompare k => MergeSubscribed k -> IO (Subscriber (R.PatchDMap (DMap k Event)))
643+newSubscriberMergeChange subd = return $! SubscriberMergeChange subd
645+{-# NOINLINE newSubscriberFan #-}
646+newSubscriberFan :: GCompare k => FanSubscribed k -> IO (Subscriber (DMap k Identity))
647+newSubscriberFan subd = return $! SubscriberFan subd
649+{-# NOINLINE newSubscriberSwitch #-}
650+newSubscriberSwitch :: SwitchSubscribed a -> IO (Subscriber a)
651+newSubscriberSwitch subd = return $! SubscriberSwitch subd
653+{-# NOINLINE newSubscriberCoincidenceOuter #-}
654+newSubscriberCoincidenceOuter :: CoincidenceSubscribed b -> IO (Subscriber (Event b))
655+newSubscriberCoincidenceOuter subd = return $! SubscriberCoincidenceOuter subd
657+{-# NOINLINE newSubscriberCoincidenceInner #-}
658+newSubscriberCoincidenceInner :: CoincidenceSubscribed a -> IO (Subscriber a)
659+newSubscriberCoincidenceInner subd = return $! SubscriberCoincidenceInner subd
661+{-# NOINLINE newInvalidatorSwitch #-}
662+newInvalidatorSwitch :: SwitchSubscribed a -> IO Invalidator
663+newInvalidatorSwitch subd = return $! InvalidatorSwitch subd
665+{-# NOINLINE newInvalidatorPull #-}
666+newInvalidatorPull :: Pull a -> IO Invalidator
667+newInvalidatorPull p = return $! InvalidatorPull p
670+ = DynamicHold !(Hold p a)
671+ | p ~ Identity => DynamicHoldIdentity !(Hold Identity a)
673+ | DynamicDyn !(Dyn p a)
674+ | p ~ Identity => DynamicDynIdentity !(Dyn Identity a)
676+{-# INLINE current #-}
677+current :: R.Patch p => Dynamic p a -> Behavior a
679+ DynamicHold h -> BehaviorHold h
680+ DynamicHoldIdentity h -> BehaviorHoldIdentity h
681+ DynamicConst a -> BehaviorConst a
682+ DynamicDyn d -> BehaviorDyn d
683+ DynamicDynIdentity d -> BehaviorDynIdentity d
685+--TODO: If you only need updated, not current, can we avoid actually constructing the Hold?
686+{-# INLINE updated #-}
687+updated :: R.Patch p => Dynamic p a -> Event (p a)
689+ DynamicHold h -> EventHold h
690+ DynamicHoldIdentity h -> EventHoldIdentity h
691+ DynamicConst _ -> EventNever
692+ DynamicDyn d -> EventDyn d
693+ DynamicDynIdentity d -> EventDynIdentity d
695+newMapDyn :: (a -> b) -> Dynamic Identity a -> Dynamic Identity b
696+newMapDyn f d = DynamicDynIdentity $ unsafeDyn (fmap f $ readBehaviorTracked $ current d) (Identity . f . runIdentity <$> updated d)
698+instance Functor (Dynamic Identity) where
701+instance Applicative (Dynamic Identity) where
703+ (<*>) = zipDynWith ($)
707+instance R.FunctorMaybe Event where
708+ fmapMaybe f = push $ return . f
710+instance Align Event where
712+ align ea eb = R.fmapMaybe R.dmapToThese $ merge $ DynamicConst $ DMap.fromList [R.LeftTag :=> ea, R.RightTag :=> eb]
714+--TODO: Avoid the duplication between this and R.zipDynWith
715+zipDynWith :: (a -> b -> c) -> Dynamic Identity a -> Dynamic Identity b -> Dynamic Identity c
717+ let eab = align (updated da) (updated db)
718+ ec = flip push eab $ \o -> do
720+ This (Identity a) -> do
721+ b <- readBehaviorUntracked $ current db
723+ That (Identity b) -> do
724+ a <- readBehaviorUntracked $ current da
726+ These (Identity a) (Identity b) -> return (a, b)
727+ return $ Just $ Identity $ f a b
728+ in DynamicDynIdentity $ unsafeDyn (f <$> readBehaviorUntracked (current da) <*> readBehaviorUntracked (current db)) ec
730+instance Monad (Dynamic Identity) where
731+ {-# INLINE return #-}
733+ {-# INLINE (>>=) #-}
734+ x >>= f = DynamicDynIdentity $ newJoinDyn $ newMapDyn f x --TODO: (>>), fail
738+ fail _ = error "Dynamic does not support 'fail'"
740+newtype Dyn p a = Dyn { unDyn :: IORef (Either (BehaviorM a, Event (p a)) (Hold p a)) }
742+unsafeDyn :: BehaviorM a -> Event (p a) -> Dyn p a
743+unsafeDyn readV0 v' = Dyn $ unsafeNewIORef x $ Left x
744+ where x = (readV0, v')
746+newJoinDyn :: Dynamic Identity (Dynamic Identity a) -> Dyn Identity a
748+ let readV0 = readBehaviorTracked . current =<< readBehaviorTracked (current d)
749+ eOuter = push (fmap (Just . Identity) . readBehaviorUntracked . current . runIdentity) $ updated d
750+ eInner = switch $ updated <$> current d
751+ eBoth = coincidence $ updated . runIdentity <$> updated d
752+ v' = unSpiderEvent $ R.leftmost $ map SpiderEvent [eBoth, eOuter, eInner]
753+ in unsafeDyn readV0 v'
755+--type role Behavior representational
757+ = forall p. BehaviorHold !(Hold p a)
758+ | BehaviorHoldIdentity !(Hold Identity a)
760+ | BehaviorPull !(Pull a)
761+ | BehaviorDynIdentity !(Dyn Identity a)
762+ | forall p. R.Patch p => BehaviorDyn !(Dyn p a)
764+-- ResultM can read behaviors and events
765+type ResultM = EventM
767+{-# NOINLINE unsafeNewIORef #-}
768+unsafeNewIORef :: a -> b -> IORef b
769+unsafeNewIORef _ b = unsafePerformIO $ newIORef b
771+instance Functor Event where
772+ fmap f = push $ return . Just . f
774+instance Functor Behavior where
775+ fmap f = pull . fmap f . readBehaviorTracked
777+{-# NOINLINE push #-} --TODO: If this is helpful, we can get rid of the unsafeNewIORef and use unsafePerformIO directly
778+push :: forall a b. (a -> ComputeM (Maybe b)) -> Event a -> Event b
779+push f e = EventPush $ Push
782+ , pushSubscribed = unsafeNewIORef (f, e) Nothing --TODO: Does the use of the tuple here create unnecessary overhead?
784+-- DISABLED: {- RULES "push/push" forall f g e. push f (push g e) = push (maybe (return Nothing) f <=< g) e #-}
786+{-# NOINLINE pull #-}
787+pull :: BehaviorM a -> Behavior a
788+pull a = BehaviorPull $ Pull
790+ , pullValue = unsafeNewIORef a Nothing
792+ , pullNodeId = unsafeNodeId a
796+{-# NOINLINE switch #-}
797+switch :: Behavior (Event a) -> Event a
798+switch a = EventSwitch $ Switch
800+ , switchSubscribed = unsafeNewIORef a Nothing
803+coincidence :: Event (Event a) -> Event a
804+coincidence a = EventCoincidence $ Coincidence
805+ { coincidenceParent = a
806+ , coincidenceSubscribed = unsafeNewIORef a Nothing
809+propagateAndUpdateSubscribersRef :: SubscriberList a -> a -> EventM x ()
810+propagateAndUpdateSubscribersRef subscribersRef a = do
811+ propagate a subscribersRef
813+-- Propagate the given event occurrence; before cleaning up, run the given action, which may read the state of events and behaviors
814+run :: [DSum RootTrigger Identity] -> ResultM x b -> SpiderHost x b
816+ tracePropagate $ "Running an event frame with " <> show (length roots) <> " events"
817+ spiderEnv <- SpiderHost ask
818+ result <- SpiderHost $ lift $ withMVar (_spiderEnv_lock spiderEnv) $ \_ -> flip runReaderT spiderEnv $ unSpiderHost $ runFrame $ do
819+ rootsToPropagate <- forM roots $ \r@(RootTrigger (_, occRef, k) :=> a) -> do
820+ occBefore <- liftIO $ do
821+ occBefore <- readIORef occRef
822+ writeIORef occRef $! DMap.insert k a occBefore
824+ if DMap.null occBefore
825+ then do scheduleRootClear occRef
828+ forM_ (catMaybes rootsToPropagate) $ \(RootTrigger (subscribersRef, _, _) :=> Identity a) -> do
829+ propagateAndUpdateSubscribersRef subscribersRef a
830+ delayedRef <- EventM $ asks eventEnvDelayedMerges
832+ delayed <- liftIO $ readIORef delayedRef
833+ case IntMap.minViewWithKey delayed of
834+ Nothing -> return ()
835+ Just ((currentHeight, cur), future) -> do
836+ tracePropagate $ "Running height " ++ show currentHeight
837+ putCurrentHeight $ Height currentHeight
838+ liftIO $ writeIORef delayedRef $! future
839+ forM_ cur $ \d -> case d of
840+ DelayedMerge subscribed -> do
841+ height <- liftIO $ readIORef $ mergeSubscribedHeight subscribed
842+ case height `compare` Height currentHeight of
843+ LT -> error "Somehow a merge's height has been decreased after it was scheduled"
844+ GT -> scheduleMerge height subscribed -- The height has been increased (by a coincidence event; TODO: is this the only way?)
846+ m <- liftIO $ readIORef $ mergeSubscribedAccum subscribed
847+ liftIO $ writeIORef (mergeSubscribedAccum subscribed) $! DMap.empty
848+ --TODO: Assert that m is not empty
849+ liftIO $ writeIORef (mergeSubscribedOccurrence subscribed) $ Just m
850+ scheduleClear $ mergeSubscribedOccurrence subscribed
851+ propagateAndUpdateSubscribersRef (mergeSubscribedSubscribers subscribed) m
854+ putCurrentHeight maxBound
856+ tracePropagate "Done running an event frame"
859+data SomeClear = forall a. SomeClear (IORef (Maybe a))
861+data SomeRootClear = forall k. SomeRootClear (IORef (DMap k Identity))
863+data SomeAssignment = forall a. SomeAssignment {-# UNPACK #-} !(IORef a) {-# UNPACK #-} !(IORef [Weak Invalidator]) a
865+data DelayedMerge = forall k. DelayedMerge (MergeSubscribed k)
867+debugFinalize :: Bool
868+debugFinalize = False
870+mkWeakPtrWithDebug :: a -> String -> IO (Weak a)
871+mkWeakPtrWithDebug x debugNote = do
875+ then Just $ putStrLn $ "finalizing: " ++ debugNote
878+type WeakList a = [Weak a]
880+{-# INLINE withIncreasedDepth #-}
882+withIncreasedDepth :: CanTrace x m => m a -> m a
883+withIncreasedDepth a = do
884+ spiderEnv <- askSpiderEnv
885+ liftIO $ modifyIORef' (_spiderEnv_depth spiderEnv) succ
887+ liftIO $ modifyIORef' (_spiderEnv_depth spiderEnv) pred
890+withIncreasedDepth :: m a -> m a
891+withIncreasedDepth = id
894+type CanTrace x m = (HasSpiderEnv x m, MonadIO m)
896+{-# INLINE tracePropagate #-}
897+tracePropagate :: (CanTrace x m) => String -> m ()
898+tracePropagate = traceWhen debugPropagate
900+{-# INLINE traceSubscribe #-}
901+traceSubscribe :: String -> IO ()
902+traceSubscribe = when debugSubscribe . liftIO . putStrLn
904+{-# INLINE traceInvalidate #-}
905+traceInvalidate :: String -> IO ()
906+traceInvalidate = when debugInvalidate . liftIO . putStrLn
908+{-# INLINE traceWhen #-}
909+traceWhen :: (CanTrace x m) => Bool -> String -> m ()
910+traceWhen b message = traceMWhen b $ return message
912+{-# INLINE traceMWhen #-}
913+traceMWhen :: (CanTrace x m) => Bool -> m String -> m ()
914+traceMWhen b getMessage = when b $ do
915+ message <- getMessage
917+ spiderEnv <- askSpiderEnv
918+ d <- liftIO $ readIORef $ _spiderEnv_depth spiderEnv
922+ liftIO $ putStrLn $ replicate d ' ' <> message
924+whoCreatedIORef :: IORef a -> IO [String]
925+whoCreatedIORef (IORef a) = whoCreated $! a
927+whoCreatedEventSubscribed :: EventSubscribed a -> IO [String]
928+whoCreatedEventSubscribed = \case
929+ EventSubscribedRoot _ -> return ["root"]
930+ EventSubscribedNever -> return ["never"]
931+ EventSubscribedPush subscribed -> whoCreatedIORef $ pushSubscribedCachedSubscribed subscribed
932+ EventSubscribedFan _ subscribed -> whoCreatedIORef $ fanSubscribedCachedSubscribed subscribed
933+ EventSubscribedMerge subscribed -> whoCreatedIORef $ mergeSubscribedCachedSubscribed subscribed
934+ EventSubscribedSwitch subscribed -> whoCreatedIORef $ switchSubscribedCachedSubscribed subscribed
935+ EventSubscribedCoincidence subscribed -> whoCreatedIORef $ coincidenceSubscribedCachedSubscribed subscribed
937+walkInvalidHeightParents :: EventSubscribed a -> IO [Some EventSubscribed]
938+walkInvalidHeightParents s0 = do
939+ subscribers <- flip execStateT mempty $ ($ Some.This s0) $ fix $ \loop (Some.This s) -> do
940+ h <- liftIO $ readIORef $ eventSubscribedHeightRef s
941+ when (h == invalidHeight) $ do
942+ when (eventSubscribedHasOwnHeightRef s) $ liftIO $ writeIORef (eventSubscribedHeightRef s) $! invalidHeightBeingTraversed
943+ modify (Some.This s :)
944+ mapM_ loop =<< liftIO (eventSubscribedGetParents s)
945+ forM_ subscribers $ \(Some.This s) -> writeIORef (eventSubscribedHeightRef s) $! invalidHeight
948+groupByHead :: Eq a => [NonEmpty a] -> [(a, NonEmpty [a])]
951+ (x :| xs) : t -> case groupByHead t of
952+ [] -> [(x, xs :| [])]
954+ | x == y -> (x, xs `NonEmpty.cons` yss) : t'
955+ | otherwise -> (x, xs :| []) : l
957+listsToForest :: Eq a => [[a]] -> Forest a
958+listsToForest l = fmap (\(a, l') -> Node a $ listsToForest $ toList l') $ groupByHead $ catMaybes $ fmap nonEmpty l
960+-- | Propagate everything at the current height
961+propagate :: a -> SubscriberList a -> EventM x ()
962+propagate a subscribers = withIncreasedDepth $ do
963+ -- 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
964+ --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
965+ WeakBag.traverse subscribers $ \s -> case s of
966+ SubscriberPush compute subscribed -> {-# SCC "traversePush" #-} do
967+ tracePropagate $ "SubscriberPush" <> showNodeId subscribed
968+ occ <- runComputeM $ compute a
970+ Nothing -> return () -- No need to write a Nothing back into the Ref
972+ liftIO $ writeIORef (pushSubscribedOccurrence subscribed) occ
973+ scheduleClear $ pushSubscribedOccurrence subscribed
974+ propagate o $ pushSubscribedSubscribers subscribed
975+ SubscriberMerge k subscribed -> {-# SCC "traverseMerge" #-} do
976+ tracePropagate $ "SubscriberMerge" <> showNodeId subscribed
977+ oldM <- liftIO $ readIORef $ mergeSubscribedAccum subscribed
978+ let newM = DMap.insertWith (error $ "Same key fired multiple times for Merge" <> showNodeId subscribed) k (Identity a) oldM
979+ tracePropagate $ " DMap.size oldM = " <> show (DMap.size oldM) <> "; DMap.size newM = " <> show (DMap.size newM)
980+ liftIO $ writeIORef (mergeSubscribedAccum subscribed) $! newM
981+ when (DMap.null oldM) $ do -- Only schedule the firing once
982+ height <- liftIO $ readIORef $ mergeSubscribedHeight subscribed
983+ --TODO: assertions about height
984+ currentHeight <- getCurrentHeight
985+ when (height <= currentHeight) $ do
986+ myStack <- liftIO $ whoCreatedIORef $ mergeSubscribedCachedSubscribed subscribed
987+ if height /= invalidHeight
988+ then error $ "Height (" ++ show height ++ ") is not greater than current height (" ++ show currentHeight ++ ")\n" ++ unlines (reverse myStack)
990+ nodesInvolvedInCycle <- walkInvalidHeightParents $ EventSubscribedMerge subscribed
991+ stacks <- forM nodesInvolvedInCycle $ \(Some.This es) -> whoCreatedEventSubscribed es
992+ error $ "Causality loop found:\n" <> drawForest (listsToForest stacks)
993+ scheduleMerge height subscribed
994+ SubscriberMergeChange subscribed -> {-# SCC "traverseMergeChange" #-} do
995+ tracePropagate $ "SubscriberMerge" <> showNodeId subscribed
996+ defer $ SomeMergeUpdate a subscribed
997+ SubscriberFan subscribed -> {-# SCC "traverseFan" #-} do
998+ subs <- liftIO $ readIORef $ fanSubscribedSubscribers subscribed
999+ tracePropagate $ "SubscriberFan" <> showNodeId subscribed <> ": " ++ show (DMap.size subs) ++ " keys subscribed, " ++ show (DMap.size a) ++ " keys firing"
1000+ --TODO: We need a better DMap intersection; here, we are assuming that the number of firing keys is small and the number of subscribers is large
1001+ forM_ (DMap.toList a) $ \(k :=> Identity v) -> {-# SCC "SubscriberFan" #-} case DMap.lookup k subs of
1003+ tracePropagate "No subscriber for key"
1006+ propagate v $ _fanSubscribedChildren_list subsubs
1008+ SubscriberHold h -> {-# SCC "traverseHold" #-} propagateSubscriberHold h a
1009+ SubscriberHoldIdentity h -> {-# SCC "traverseHoldIdentity" #-} propagateSubscriberHold h a
1010+ SubscriberSwitch subscribed -> {-# SCC "traverseSwitch" #-} do
1011+ tracePropagate $ "SubscriberSwitch" <> showNodeId subscribed
1012+ liftIO $ writeIORef (switchSubscribedOccurrence subscribed) $ Just a
1013+ scheduleClear $ switchSubscribedOccurrence subscribed
1014+ propagate a $ switchSubscribedSubscribers subscribed
1015+ SubscriberCoincidenceOuter subscribed -> {-# SCC "traverseCoincidenceOuter" #-} do
1016+ tracePropagate $ "SubscriberCoincidenceOuter" <> showNodeId subscribed
1017+ outerHeight <- liftIO $ readIORef $ coincidenceSubscribedHeight subscribed
1018+ tracePropagate $ " outerHeight = " <> show outerHeight
1019+ (occ, innerHeight, innerSubd) <- subscribeCoincidenceInner a outerHeight subscribed
1020+ tracePropagate $ " isJust occ = " <> show (isJust occ)
1021+ tracePropagate $ " innerHeight = " <> show innerHeight
1022+ liftIO $ writeIORef (coincidenceSubscribedInnerParent subscribed) $ Just innerSubd
1023+ scheduleClear $ coincidenceSubscribedInnerParent subscribed
1026+ when (innerHeight > outerHeight) $ liftIO $ do -- If the event fires, it will fire at a later height
1027+ writeIORef (coincidenceSubscribedHeight subscribed) $! innerHeight
1028+ WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight outerHeight
1029+ WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight innerHeight
1030+ Just o -> do -- Since it's already firing, no need to adjust height
1031+ liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) occ
1032+ scheduleClear $ coincidenceSubscribedOccurrence subscribed
1033+ propagate o $ coincidenceSubscribedSubscribers subscribed
1034+ SubscriberCoincidenceInner subscribed -> {-# SCC "traverseCoincidenceInner" #-} do
1035+ tracePropagate $ "SubscriberCoincidenceInner" <> showNodeId subscribed
1036+ occ <- liftIO $ readIORef $ coincidenceSubscribedOccurrence subscribed
1038+ Just _ -> return () -- SubscriberCoincidenceOuter must have already propagated this event
1040+ liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) $ Just a
1041+ scheduleClear $ coincidenceSubscribedOccurrence subscribed
1042+ propagate a $ coincidenceSubscribedSubscribers subscribed
1043+ SubscriberHandle -> {-# SCC "traverseHandle" #-} tracePropagate "SubscriberHandle"
1045+{-# INLINE propagateSubscriberHold #-}
1046+propagateSubscriberHold :: R.Patch p => Hold p a -> p a -> EventM x ()
1047+propagateSubscriberHold h a = do
1048+ {-# SCC "trace" #-} traceMWhen debugPropagate $ liftIO $ do
1049+ invalidators <- liftIO $ readIORef $ holdInvalidators h
1050+ return $ "SubscriberHold" <> showNodeId h <> ": " ++ show (length invalidators)
1051+ v <- {-# SCC "read" #-} liftIO $ readIORef $ holdValue h
1052+ case {-# SCC "apply" #-} R.apply a v of
1053+ Nothing -> return ()
1055+ {-# SCC "trace2" #-} withIncreasedDepth $ tracePropagate $ "propagateSubscriberHold: assigning Hold" <> showNodeId h
1056+ vRef <- {-# SCC "vRef" #-} liftIO $ evaluate $ holdValue h
1057+ iRef <- {-# SCC "iRef" #-} liftIO $ evaluate $ holdInvalidators h
1058+ defer $ {-# SCC "assignment" #-} SomeAssignment vRef iRef v'
1060+data SomeResetCoincidence = forall a. SomeResetCoincidence !(EventSubscription a) !(Maybe (CoincidenceSubscribed a)) -- The CoincidenceSubscriber will be present only if heights need to be reset
1062+{-# INLINE subscribeCoincidenceInner #-}
1063+subscribeCoincidenceInner :: CanSubscribe x m => Event a -> Height -> CoincidenceSubscribed a -> m (Maybe a, Height, EventSubscribed a)
1064+subscribeCoincidenceInner o outerHeight subscribedUnsafe = do
1065+ subInner <- liftIO $ newSubscriberCoincidenceInner subscribedUnsafe
1066+ subscription@(EventSubscription _ innerSubd) <- subscribe o subInner
1067+ innerOcc <- liftIO $ readEventSubscribed innerSubd
1068+ innerHeight <- liftIO $ readIORef $ eventSubscribedHeightRef innerSubd
1069+ let height = max innerHeight outerHeight
1070+ defer $ SomeResetCoincidence subscription $ if height > outerHeight then Just subscribedUnsafe else Nothing
1071+ return (innerOcc, height, innerSubd)
1073+{-# SPECIALIZE readBehaviorUntracked :: Behavior a -> BehaviorM a #-}
1074+{-# SPECIALIZE readBehaviorUntracked :: Behavior a -> EventM x a #-}
1075+readBehaviorUntracked :: Defer SomeHoldInit m => Behavior a -> m a
1076+readBehaviorUntracked b = do
1077+ holdInits <- getDeferralQueue
1078+ liftIO $ runBehaviorM (readBehaviorTracked b) Nothing holdInits --TODO: Specialize readBehaviorTracked to the Nothing and Just cases
1080+runBehaviorM :: BehaviorM a -> Maybe (Weak Invalidator, IORef [SomeBehaviorSubscribed]) -> IORef [SomeHoldInit] -> IO a
1081+runBehaviorM a mwi holdInits = runReaderT (unBehaviorM a) (mwi, holdInits)
1083+askInvalidator :: BehaviorM (Maybe (Weak Invalidator))
1085+ (!m, _) <- BehaviorM ask
1087+ Nothing -> return Nothing
1088+ Just (!wi, _) -> return $ Just wi
1090+askParentsRef :: BehaviorM (Maybe (IORef [SomeBehaviorSubscribed]))
1092+ (!m, _) <- BehaviorM ask
1094+ Nothing -> return Nothing
1095+ Just (_, !p) -> return $ Just p
1097+askBehaviorHoldInits :: BehaviorM (IORef [SomeHoldInit])
1098+askBehaviorHoldInits = do
1099+ (_, !his) <- BehaviorM ask
1102+readBehaviorTracked :: Behavior a -> BehaviorM a
1103+readBehaviorTracked b = case b of
1104+ BehaviorHold h -> readHoldTracked h
1105+ BehaviorHoldIdentity h -> readHoldTracked h
1106+ BehaviorConst a -> return a
1107+ BehaviorPull p -> do
1108+ val <- liftIO $ readIORef $ pullValue p
1110+ Just subscribed -> do
1111+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
1112+ askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (pullSubscribedInvalidators subscribed) (wi:))
1113+ liftIO $ touch $ pullSubscribedOwnInvalidator subscribed
1114+ return $ pullSubscribedValue subscribed
1116+ i <- liftIO $ newInvalidatorPull p
1117+ wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorPull"
1118+ parentsRef <- liftIO $ newIORef []
1119+ holdInits <- askBehaviorHoldInits
1120+ a <- liftIO $ runReaderT (unBehaviorM $ pullCompute p) (Just (wi, parentsRef), holdInits)
1121+ invsRef <- liftIO . newIORef . maybeToList =<< askInvalidator
1122+ parents <- liftIO $ readIORef parentsRef
1123+ let subscribed = PullSubscribed
1124+ { pullSubscribedValue = a
1125+ , pullSubscribedInvalidators = invsRef
1126+ , pullSubscribedOwnInvalidator = i
1127+ , pullSubscribedParents = parents
1129+ liftIO $ writeIORef (pullValue p) $ Just subscribed
1130+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
1132+ BehaviorDyn d -> readHoldTracked =<< getDynHold d
1133+ BehaviorDynIdentity d -> readHoldTracked =<< getDynHold d
1135+{-# INLINE readHoldTracked #-}
1136+readHoldTracked :: Hold p a -> BehaviorM a
1137+readHoldTracked h = do
1138+ result <- liftIO $ readIORef $ holdValue h
1139+ askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (holdInvalidators h) (wi:))
1140+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedHold h) :))
1143+{-# INLINE getDynHold #-}
1144+getDynHold :: (Defer SomeHoldInit m, R.Patch p) => Dyn p a -> m (Hold p a)
1146+ mh <- liftIO $ readIORef $ unDyn d
1148+ Right h -> return h
1149+ Left (readV0, v') -> do
1150+ holdInits <- getDeferralQueue
1151+ v0 <- liftIO $ runBehaviorM readV0 Nothing holdInits
1153+ liftIO $ writeIORef (unDyn d) $ Right h
1156+readEventSubscribed :: EventSubscribed a -> IO (Maybe a)
1157+readEventSubscribed = \case
1158+ EventSubscribedRoot rs -> readRootSubscribed rs
1159+ EventSubscribedNever -> return Nothing
1160+ EventSubscribedPush ps -> readPushSubscribed ps
1161+ EventSubscribedMerge ms -> readMergeSubscribed ms
1162+ EventSubscribedFan k fs -> readFanSubscribed k fs
1163+ EventSubscribedSwitch ss -> readSwitchSubscribed ss
1164+ EventSubscribedCoincidence cs -> readCoincidenceSubscribed cs
1166+readRootSubscribed :: RootSubscribed a -> IO (Maybe a)
1167+readRootSubscribed = rootSubscribedOccurrence
1169+readPushSubscribed :: PushSubscribed b a -> IO (Maybe a)
1170+readPushSubscribed subscribed = do
1171+ result <- readIORef $ pushSubscribedOccurrence subscribed -- Since ResultM is always called after the final height is reached, this will always be valid
1172+ touch $ pushSubscribedSelf subscribed
1175+readMergeSubscribed :: MergeSubscribed k -> IO (Maybe (DMap k Identity))
1176+readMergeSubscribed subscribed = do
1177+ result <- readIORef $ mergeSubscribedOccurrence subscribed
1178+ touch $ mergeSubscribedParents subscribed
1181+readFanSubscribed :: GCompare k => k a -> FanSubscribed k -> IO (Maybe a)
1182+readFanSubscribed k fs = do
1183+ parentOcc <- readEventSubscribed $ _eventSubscription_subscribed $ fanSubscribedParent fs
1184+ return $ coerce $ DMap.lookup k =<< parentOcc
1186+readSwitchSubscribed :: SwitchSubscribed a -> IO (Maybe a)
1187+readSwitchSubscribed subscribed = do
1188+ result <- readIORef $ switchSubscribedOccurrence subscribed
1189+ touch $ switchSubscribedOwnInvalidator subscribed
1192+readCoincidenceSubscribed :: CoincidenceSubscribed a -> IO (Maybe a)
1193+readCoincidenceSubscribed subscribed = do
1194+ result <- readIORef $ coincidenceSubscribedOccurrence subscribed
1195+ touch $ coincidenceSubscribedOuter subscribed
1196+ --TODO: do we need to touch the inner subscriber?
1199+-- Always refers to 0
1200+{-# NOINLINE zeroRef #-}
1201+zeroRef :: IORef Height
1202+zeroRef = unsafePerformIO $ newIORef zeroHeight
1204+{-# SPECIALIZE subscribe :: Event a -> Subscriber a -> EventM x (EventSubscription a) #-}
1205+subscribe :: forall x m a. CanSubscribe x m => Event a -> Subscriber a -> m (EventSubscription a)
1206+subscribe e sub = case e of
1207+ EventRoot k r -> wrap EventSubscribedRoot $ liftIO . getRootSubscribed k r
1208+ EventNever -> return $ EventSubscription Nothing EventSubscribedNever
1209+ EventPush p -> wrap EventSubscribedPush $ getPushSubscribed p
1210+ EventFan k f -> wrap (EventSubscribedFan k) $ getFanSubscribed k f
1211+ EventMerge m -> wrap EventSubscribedMerge $ getMergeSubscribed m
1212+ EventSwitch s -> wrap EventSubscribedSwitch $ getSwitchSubscribed s
1213+ EventCoincidence c -> wrap EventSubscribedCoincidence $ getCoincidenceSubscribed c
1214+ EventHold h -> subscribeHoldEvent h sub
1215+ EventDyn j -> getDynHold j >>= \h -> subscribeHoldEvent h sub
1216+ EventHoldIdentity h -> subscribeHoldEvent h sub
1217+ EventDynIdentity j -> getDynHold j >>= \h -> subscribeHoldEvent h sub
1219+ wrap :: (t -> EventSubscribed a) -> (Subscriber a -> m (SubscriberListTicket a, t)) -> m (EventSubscription a)
1220+ wrap tag getSpecificSubscribed = do
1221+ (sln, subd) <- getSpecificSubscribed sub
1222+ return $ EventSubscription (Just sln) $ tag subd
1224+{-# INLINE subscribeHoldEvent #-}
1225+subscribeHoldEvent :: (CanSubscribe x m, R.Patch p) => Hold p a -> Subscriber (p a) -> m (EventSubscription (p a))
1226+subscribeHoldEvent h sub = do
1227+ EventSubscription _ subd <- getHoldEventSubscription h
1228+ sln <- liftIO $ subscribeEventSubscribed subd sub
1229+ return $ EventSubscription sln subd
1231+{-# INLINE debugSubscribe #-}
1232+debugSubscribe :: Bool
1233+debugSubscribe = False
1235+{-# INLINE subscribeEventSubscribed #-}
1236+subscribeEventSubscribed :: EventSubscribed a -> Subscriber a -> IO (Maybe (SubscriberListTicket a))
1237+subscribeEventSubscribed es sub = case es of
1238+ EventSubscribedRoot r -> do
1239+ traceSubscribe $ "subscribeEventSubscribed Root"
1240+ Just <$> subscribeRootSubscribed r sub
1241+ EventSubscribedNever -> do
1242+ traceSubscribe $ "subscribeEventSubscribed Never"
1244+ EventSubscribedPush subscribed -> do
1245+ traceSubscribe $ "subscribeEventSubscribed Push"
1246+ Just <$> subscribePushSubscribed subscribed sub
1247+ EventSubscribedFan k subscribed -> do
1248+ traceSubscribe $ "subscribeEventSubscribed Fan"
1249+ Just <$> subscribeFanSubscribed k subscribed sub
1250+ EventSubscribedMerge subscribed -> do
1251+ traceSubscribe $ "subscribeEventSubscribed Merge"
1252+ Just <$> subscribeMergeSubscribed subscribed sub
1253+ EventSubscribedSwitch subscribed -> do
1254+ traceSubscribe $ "subscribeEventSubscribed Switch"
1255+ Just <$> subscribeSwitchSubscribed subscribed sub
1256+ EventSubscribedCoincidence subscribed -> do
1257+ traceSubscribe $ "subscribeEventSubscribed Coincidence"
1258+ Just <$> subscribeCoincidenceSubscribed subscribed sub
1260+{-# INLINE eventSubscribedHeightRef #-}
1261+eventSubscribedHeightRef :: EventSubscribed a -> IORef Height
1262+eventSubscribedHeightRef = \case
1263+ EventSubscribedRoot _ -> zeroRef
1264+ EventSubscribedNever -> zeroRef
1265+ EventSubscribedPush subscribed -> pushSubscribedHeight subscribed
1266+ EventSubscribedFan _ subscribed -> eventSubscribedHeightRef $ _eventSubscription_subscribed $ fanSubscribedParent subscribed
1267+ EventSubscribedMerge subscribed -> mergeSubscribedHeight subscribed
1268+ EventSubscribedSwitch subscribed -> switchSubscribedHeight subscribed
1269+ EventSubscribedCoincidence subscribed -> coincidenceSubscribedHeight subscribed
1271+{-# INLINE eventSubscribedHasOwnHeightRef #-}
1272+eventSubscribedHasOwnHeightRef :: EventSubscribed a -> Bool
1273+eventSubscribedHasOwnHeightRef = \case
1274+ EventSubscribedRoot _ -> False
1275+ EventSubscribedNever -> False
1276+ EventSubscribedPush _ -> False
1277+ EventSubscribedFan _ _ -> False
1278+ EventSubscribedMerge _ -> True
1279+ EventSubscribedSwitch _ -> True
1280+ EventSubscribedCoincidence _ -> True
1282+{-# INLINE eventSubscribedGetParents #-}
1283+eventSubscribedGetParents :: EventSubscribed a -> IO [Some EventSubscribed]
1284+eventSubscribedGetParents = \case
1285+ EventSubscribedRoot _ -> return []
1286+ EventSubscribedNever -> return []
1287+ EventSubscribedPush subscribed -> return [Some.This $ _eventSubscription_subscribed $ pushSubscribedParent subscribed]
1288+ EventSubscribedFan _ subscribed -> return [Some.This $ _eventSubscription_subscribed $ fanSubscribedParent subscribed]
1289+ EventSubscribedMerge subscribed -> do
1290+ ps <- readIORef $ mergeSubscribedParents subscribed
1291+ return $ R.ffor (DMap.toList ps) $ \(_ :=> v) -> Some.This $ _eventSubscription_subscribed $ mergeSubscribedParentSubscription v
1292+ EventSubscribedSwitch subscribed -> do
1293+ s <- readIORef $ switchSubscribedCurrentParent subscribed
1294+ return [Some.This $ _eventSubscription_subscribed s]
1295+ EventSubscribedCoincidence subscribed -> do
1296+ innerSubscription <- readIORef $ coincidenceSubscribedInnerParent subscribed
1297+ let outerParent = Some.This $ _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
1298+ innerParents = maybeToList $ fmap Some.This innerSubscription
1299+ return $ outerParent : innerParents
1301+type CanSubscribe x m =
1303+ , HasCurrentHeight m
1304+ , Defer SomeHoldInit m, Defer SomeMergeInit m -- The things we need to lazily initialize state
1305+ , Defer SomeClear m -- Wiping out event firings
1306+ , Defer SomeAssignment m -- Updating state
1307+ , Defer SomeResetCoincidence m
1310+getRootSubscribed :: GCompare k => k a -> Root k -> Subscriber a -> IO (SubscriberListTicket a, RootSubscribed a)
1311+getRootSubscribed k r sub = do
1312+ mSubscribed <- readIORef $ rootSubscribed r
1313+ case DMap.lookup k mSubscribed of
1314+ Just subscribed -> {-# SCC "hitRoot" #-} do
1315+ sln <- subscribeRootSubscribed subscribed sub
1316+ return (sln, subscribed)
1317+ Nothing -> {-# SCC "missRoot" #-} do
1318+ weakSelf <- newIORef $ error "getRootSubscribed: weakSelfRef not initialized"
1319+ let !cached = rootSubscribed r
1320+ uninitRef <- newIORef $ error "getRootsubscribed: uninitRef not initialized"
1321+ (subs, sln) <- WeakBag.singleton sub weakSelf cleanupRootSubscribed
1322+ when debugPropagate $ putStrLn $ "getRootSubscribed: calling rootInit"
1323+ uninit <- rootInit r k $ RootTrigger (subs, rootOccurrence r, k)
1324+ writeIORef uninitRef $! uninit
1325+ let subscribed = RootSubscribed
1326+ { rootSubscribedKey = k
1327+ , rootSubscribedCachedSubscribed = cached
1328+ , rootSubscribedOccurrence = fmap (coerce . DMap.lookup k) $ readIORef $ rootOccurrence r
1329+ , rootSubscribedSubscribers = subs
1330+ , rootSubscribedUninit = uninit
1331+ , rootSubscribedWeakSelf = weakSelf
1332+#ifdef DEBUG_NODEIDS
1333+ , rootSubscribedNodeId = unsafeNodeId (k, r, subs)
1336+ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "RootSubscribed"
1337+ 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
1338+ return (sln, subscribed)
1340+{-# ANN cleanupRootSubscribed "HLint: ignore Redundant bracket" #-}
1341+cleanupRootSubscribed :: RootSubscribed a -> IO ()
1342+cleanupRootSubscribed self@(RootSubscribed { rootSubscribedKey = k, rootSubscribedCachedSubscribed = cached }) = do
1343+ rootSubscribedUninit self
1344+ modifyIORef' cached $ DMap.delete k
1346+{-# INLINE subscribeRootSubscribed #-}
1347+subscribeRootSubscribed :: RootSubscribed a -> Subscriber a -> IO (SubscriberListTicket a)
1348+subscribeRootSubscribed subscribed sub = WeakBag.insert sub (rootSubscribedSubscribers subscribed) (rootSubscribedWeakSelf subscribed) cleanupRootSubscribed
1350+-- When getPushSubscribed returns, the PushSubscribed returned will have a fully filled-in
1351+{-# SPECIALIZE getPushSubscribed :: Push a b -> Subscriber b -> EventM x (SubscriberListTicket b, PushSubscribed a b) #-}
1352+getPushSubscribed :: CanSubscribe x m => Push a b -> Subscriber b -> m (SubscriberListTicket b, PushSubscribed a b)
1353+getPushSubscribed p sub = do
1354+ mSubscribed <- liftIO $ readIORef $ pushSubscribed p
1355+ case mSubscribed of
1356+ Just subscribed -> {-# SCC "hitPush" #-} do
1357+ sln <- liftIO $ subscribePushSubscribed subscribed sub
1358+ return (sln, subscribed)
1359+ Nothing -> {-# SCC "missPush" #-} do -- Not yet subscribed
1360+ subscribedRef <- liftIO $ newIORef $ error "getPushSubscribed: subscribed not yet intialized"
1361+ subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1362+ s <- liftIO $ newSubscriberPush (pushCompute p) subscribedUnsafe
1363+ subscription@(EventSubscription _ subd) <- subscribe (pushParent p) s
1364+ parentOcc <- liftIO $ readEventSubscribed subd
1365+ occ <- runComputeM $ join <$> mapM (pushCompute p) parentOcc
1366+ occRef <- liftIO $ newIORef occ
1367+ when (isJust occ) $ scheduleClear occRef
1368+ weakSelf <- liftIO $ newIORef $ error "getPushSubscribed: weakSelf not initialized"
1369+ let !cached = pushSubscribed p
1370+ (subs, sln) <- liftIO $ WeakBag.singleton sub weakSelf cleanupPushSubscribed
1371+ let subscribed = PushSubscribed
1372+ { pushSubscribedCachedSubscribed = cached
1373+ , pushSubscribedOccurrence = occRef
1374+ , pushSubscribedHeight = eventSubscribedHeightRef subd -- Since pushes have the same height as their parents, share the ref
1375+ , pushSubscribedSubscribers = subs
1376+ , pushSubscribedSelf = s
1377+ , pushSubscribedWeakSelf = weakSelf
1378+ , pushSubscribedParent = subscription
1379+#ifdef DEBUG_NODEIDS
1380+ , pushSubscribedNodeId = unsafeNodeId p
1383+ liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "PushSubscribed"
1384+ liftIO $ writeIORef subscribedRef $! subscribed
1385+ liftIO $ writeIORef (pushSubscribed p) $ Just subscribed
1386+ return (sln, subscribed)
1388+cleanupPushSubscribed :: PushSubscribed a b -> IO ()
1389+cleanupPushSubscribed self = do
1390+ unsubscribe $ pushSubscribedParent self
1391+ writeIORef (pushSubscribedCachedSubscribed self) $ Nothing
1393+{-# INLINE subscribePushSubscribed #-}
1394+subscribePushSubscribed :: PushSubscribed a b -> Subscriber b -> IO (SubscriberListTicket b)
1395+subscribePushSubscribed subscribed sub = WeakBag.insert sub (pushSubscribedSubscribers subscribed) (pushSubscribedWeakSelf subscribed) cleanupPushSubscribed
1397+{-# SPECIALIZE getMergeSubscribed :: GCompare k => Merge k -> Subscriber (DMap k Identity) -> EventM x (SubscriberListTicket (DMap k Identity), MergeSubscribed k) #-}
1398+getMergeSubscribed :: forall x k m. (CanSubscribe x m, GCompare k) => Merge k -> Subscriber (DMap k Identity) -> m (SubscriberListTicket (DMap k Identity), MergeSubscribed k)
1399+getMergeSubscribed m sub = do
1400+ mSubscribed <- liftIO $ readIORef $ mergeSubscribed m
1401+ case mSubscribed of
1402+ Just subscribed -> {-# SCC "hitMerge" #-} do
1403+ sln <- liftIO $ subscribeMergeSubscribed subscribed sub
1404+ return (sln, subscribed)
1405+ Nothing -> {-# SCC "missMerge" #-} do
1406+ subscribedRef <- liftIO $ newIORef $ error "getMergeSubscribed: subscribedRef not yet initialized"
1407+ subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1408+ initialParents <- readBehaviorUntracked $ current $ mergeParents m
1409+ subscribers :: [(Maybe (DSum k Identity), Height, DSum k (MergeSubscribedParent k))] <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
1410+ s <- liftIO $ newSubscriberMerge k subscribedUnsafe
1411+ subscription@(EventSubscription _ parentSubd) <- subscribe e s
1412+ parentOcc <- liftIO $ readEventSubscribed parentSubd
1413+ height <- liftIO $ readIORef $ eventSubscribedHeightRef parentSubd
1414+ return $ (fmap (\x -> k :=> Identity x) parentOcc, height, k :=> MergeSubscribedParent subscription s)
1415+ let dm = DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
1416+ heights = fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
1417+ myHeightBag = heightBagFromList $ filter (/= invalidHeight) heights
1418+ myHeight = if invalidHeight `elem` heights
1420+ else succHeight $ heightBagMax myHeightBag
1421+ currentHeight <- getCurrentHeight
1422+ let (occ, accum) = if currentHeight >= myHeight -- If we should have fired by now
1423+ then (if DMap.null dm then Nothing else Just dm, DMap.empty)
1425+ unless (DMap.null accum) $ do
1426+ scheduleMerge myHeight subscribedUnsafe
1427+ occRef <- liftIO $ newIORef occ
1428+ when (isJust occ) $ scheduleClear occRef
1429+ accumRef <- liftIO $ newIORef accum
1430+ heightRef <- liftIO $ newIORef myHeight
1431+ heightMapRef <- liftIO $ newIORef myHeightBag
1432+ weakSelf <- liftIO $ newIORef $ error "getMergeSubscribed: weakSelf not yet initialized"
1433+ (subs, sln) <- liftIO $ WeakBag.singleton sub weakSelf cleanupMergeSubscribed
1434+ changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
1435+ parentsRef <- liftIO $ newIORef $ DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
1436+ let !subscribed = MergeSubscribed
1437+ { mergeSubscribedCachedSubscribed = mergeSubscribed m
1438+ , mergeSubscribedOccurrence = occRef
1439+ , mergeSubscribedAccum = accumRef
1440+ , mergeSubscribedHeight = heightRef
1441+ , mergeSubscribedHeightBag = heightMapRef
1442+ , mergeSubscribedSubscribers = subs
1443+ , mergeSubscribedChange = changeSubdRef
1444+ , mergeSubscribedParents = parentsRef
1445+ , mergeSubscribedWeakSelf = weakSelf
1446+#ifdef DEBUG_NODEIDS
1447+ , mergeSubscribedNodeId = unsafeNodeId m
1450+ defer $ SomeMergeInit subscribed $ updated $ mergeParents m
1451+ liftIO $ writeIORef subscribedRef $! subscribed
1452+ liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "MergeSubscribed"
1453+ liftIO $ writeIORef (mergeSubscribed m) $ Just subscribed
1454+ return (sln, subscribed)
1456+cleanupMergeSubscribed :: MergeSubscribed k -> IO ()
1457+cleanupMergeSubscribed subscribed = do
1458+ parents <- readIORef $ mergeSubscribedParents subscribed
1459+ forM_ (DMap.toList parents) $ \(_ :=> msp) -> unsubscribe $ mergeSubscribedParentSubscription msp
1460+ -- Not necessary, because this whole MergeSubscribed is dead: writeIORef (mergeSubscribedParents subscribed) DMap.empty
1461+ writeIORef (mergeSubscribedCachedSubscribed subscribed) $ Nothing -- Get rid of the cached subscribed
1463+{-# INLINE subscribeMergeSubscribed #-}
1464+subscribeMergeSubscribed :: MergeSubscribed k -> Subscriber (DMap k Identity) -> IO (SubscriberListTicket (DMap k Identity))
1465+subscribeMergeSubscribed subscribed sub = WeakBag.insert sub (mergeSubscribedSubscribers subscribed) (mergeSubscribedWeakSelf subscribed) cleanupMergeSubscribed
1467+{-# SPECIALIZE getFanSubscribed :: GCompare k => k a -> Fan k -> Subscriber a -> EventM x (SubscriberListTicket a, FanSubscribed k) #-}
1468+getFanSubscribed :: (Defer SomeAssignment m, Defer SomeHoldInit m, Defer SomeMergeInit m, Defer SomeClear m, HasCurrentHeight m, Defer SomeResetCoincidence m, HasSpiderEnv x m, GCompare k) => k a -> Fan k -> Subscriber a -> m (SubscriberListTicket a, FanSubscribed k)
1469+getFanSubscribed k f sub = do
1470+ mSubscribed <- liftIO $ readIORef $ fanSubscribed f
1471+ case mSubscribed of
1472+ Just subscribed -> {-# SCC "hitFan" #-} do
1473+ sln <- liftIO $ subscribeFanSubscribed k subscribed sub
1474+ return (sln, subscribed)
1475+ Nothing -> {-# SCC "missFan" #-} do
1476+ subscribedRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribedRef not yet initialized"
1477+ subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1478+ s <- liftIO $ newSubscriberFan subscribedUnsafe
1479+ subscription <- subscribe (fanParent f) s
1480+ weakSelf <- liftIO $ newIORef $ error "getFanSubscribed: weakSelf not yet initialized"
1481+ (subsForK, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupFanSubscribed
1482+ subscribersRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribersRef not yet initialized"
1483+ let subscribed = FanSubscribed
1484+ { fanSubscribedCachedSubscribed = fanSubscribed f
1485+ , fanSubscribedParent = subscription
1486+ , fanSubscribedSubscribers = subscribersRef
1487+#ifdef DEBUG_NODEIDS
1488+ , fanSubscribedNodeId = unsafeNodeId f
1491+ let !self = (k, subscribed)
1492+ liftIO $ writeIORef subscribersRef $! DMap.singleton k $ FanSubscribedChildren subsForK self weakSelf
1493+ liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug self "FanSubscribed"
1494+ liftIO $ writeIORef subscribedRef $! subscribed
1495+ liftIO $ writeIORef (fanSubscribed f) $ Just subscribed
1496+ return (slnForSub, subscribed)
1498+cleanupFanSubscribed :: GCompare k => (k a, FanSubscribed k) -> IO ()
1499+cleanupFanSubscribed (k, subscribed) = do
1500+ subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1501+ let reducedSubscribers = DMap.delete k subscribers
1502+ if DMap.null reducedSubscribers
1504+ unsubscribe $ fanSubscribedParent subscribed
1505+ -- Not necessary in this case, because this whole FanSubscribed is dead: writeIORef (fanSubscribedSubscribers subscribed) reducedSubscribers
1506+ writeIORef (fanSubscribedCachedSubscribed subscribed) Nothing
1507+ else writeIORef (fanSubscribedSubscribers subscribed) $! reducedSubscribers
1509+{-# INLINE subscribeFanSubscribed #-}
1510+subscribeFanSubscribed :: GCompare k => k a -> FanSubscribed k -> Subscriber a -> IO (SubscriberListTicket a)
1511+subscribeFanSubscribed k subscribed sub = do
1512+ subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1513+ case DMap.lookup k subscribers of
1514+ Nothing -> {-# SCC "missSubscribeFanSubscribed" #-} do
1515+ let !self = (k, subscribed)
1516+ weakSelf <- newIORef =<< mkWeakPtrWithDebug self "FanSubscribed"
1517+ (list, sln) <- WeakBag.singleton sub weakSelf cleanupFanSubscribed
1518+ writeIORef (fanSubscribedSubscribers subscribed) $! DMap.insertWith (error "subscribeEventSubscribed: key that we just failed to find is present - should be impossible") k (FanSubscribedChildren list self weakSelf) subscribers
1520+ Just (FanSubscribedChildren list _ weakSelf) -> {-# SCC "hitSubscribeFanSubscribed" #-} WeakBag.insert sub list weakSelf cleanupFanSubscribed
1522+{-# SPECIALIZE getSwitchSubscribed :: Switch a -> Subscriber a -> EventM x (SubscriberListTicket a, SwitchSubscribed a) #-}
1523+getSwitchSubscribed :: (Defer SomeHoldInit m, Defer SomeAssignment m, Defer SomeMergeInit m, Defer SomeClear m, Defer SomeResetCoincidence m, HasCurrentHeight m, HasSpiderEnv x m) => Switch a -> Subscriber a -> m (SubscriberListTicket a, SwitchSubscribed a)
1524+getSwitchSubscribed s sub = do
1525+ mSubscribed <- liftIO $ readIORef $ switchSubscribed s
1526+ case mSubscribed of
1527+ Just subscribed -> {-# SCC "hitSwitch" #-} do
1528+ sln <- liftIO $ subscribeSwitchSubscribed subscribed sub
1529+ return (sln, subscribed)
1530+ Nothing -> {-# SCC "missSwitch" #-} do
1531+ subscribedRef <- liftIO $ newIORef $ error "getSwitchSubscribed: subscribed has not yet been created"
1532+ subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1533+ i <- liftIO $ newInvalidatorSwitch subscribedUnsafe
1534+ mySub <- liftIO $ newSubscriberSwitch subscribedUnsafe
1535+ wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorSwitch"
1536+ wiRef <- liftIO $ newIORef wi
1537+ parentsRef <- liftIO $ newIORef [] --TODO: This should be unnecessary, because it will always be filled with just the single parent behavior
1538+ holdInits <- getDeferralQueue
1539+ e <- liftIO $ runBehaviorM (readBehaviorTracked (switchParent s)) (Just (wi, parentsRef)) holdInits
1540+ subscription@(EventSubscription _ subd) <- subscribe e mySub
1541+ subscriptionRef <- liftIO $ newIORef subscription
1542+ parentOcc <- liftIO $ readEventSubscribed subd
1543+ occRef <- liftIO $ newIORef parentOcc
1544+ when (isJust parentOcc) $ scheduleClear occRef
1545+ heightRef <- liftIO $ newIORef =<< readIORef (eventSubscribedHeightRef subd)
1546+ weakSelf <- liftIO $ newIORef $ error "getSwitchSubscribed: weakSelf not yet initialized"
1547+ (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupSwitchSubscribed
1548+ let !subscribed = SwitchSubscribed
1549+ { switchSubscribedCachedSubscribed = switchSubscribed s
1550+ , switchSubscribedOccurrence = occRef
1551+ , switchSubscribedHeight = heightRef
1552+ , switchSubscribedSubscribers = subs
1553+ , switchSubscribedOwnInvalidator = i
1554+ , switchSubscribedOwnWeakInvalidator = wiRef
1555+ , switchSubscribedBehaviorParents = parentsRef
1556+ , switchSubscribedParent = switchParent s
1557+ , switchSubscribedCurrentParent = subscriptionRef
1558+ , switchSubscribedWeakSelf = weakSelf
1559+#ifdef DEBUG_NODEIDS
1560+ , switchSubscribedNodeId = unsafeNodeId s
1563+ liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "switchSubscribedWeakSelf"
1564+ liftIO $ writeIORef subscribedRef $! subscribed
1565+ liftIO $ writeIORef (switchSubscribed s) $ Just subscribed
1566+ return (slnForSub, subscribed)
1568+cleanupSwitchSubscribed :: SwitchSubscribed a -> IO ()
1569+cleanupSwitchSubscribed subscribed = do
1570+ unsubscribe =<< readIORef (switchSubscribedCurrentParent subscribed)
1571+ finalize =<< readIORef (switchSubscribedOwnWeakInvalidator subscribed) -- We don't need to get invalidated if we're dead
1572+ writeIORef (switchSubscribedCachedSubscribed subscribed) Nothing
1574+{-# INLINE subscribeSwitchSubscribed #-}
1575+subscribeSwitchSubscribed :: SwitchSubscribed a -> Subscriber a -> IO (SubscriberListTicket a)
1576+subscribeSwitchSubscribed subscribed sub = WeakBag.insert sub (switchSubscribedSubscribers subscribed) (switchSubscribedWeakSelf subscribed) cleanupSwitchSubscribed
1578+{-# SPECIALIZE getCoincidenceSubscribed :: Coincidence a -> Subscriber a -> EventM x (SubscriberListTicket a, CoincidenceSubscribed a) #-}
1579+getCoincidenceSubscribed :: forall x a m. (Defer SomeAssignment m, Defer SomeHoldInit m, Defer SomeMergeInit m, Defer SomeClear m, HasCurrentHeight m, Defer SomeResetCoincidence m, HasSpiderEnv x m) => Coincidence a -> Subscriber a -> m (SubscriberListTicket a, CoincidenceSubscribed a)
1580+getCoincidenceSubscribed c sub = do
1581+ mSubscribed <- liftIO $ readIORef $ coincidenceSubscribed c
1582+ case mSubscribed of
1583+ Just subscribed -> {-# SCC "hitCoincidence" #-} do
1584+ sln <- liftIO $ subscribeCoincidenceSubscribed subscribed sub
1585+ return (sln, subscribed)
1586+ Nothing -> {-# SCC "missCoincidence" #-} do
1587+ subscribedRef <- liftIO $ newIORef $ error "getCoincidenceSubscribed: subscribed has not yet been created"
1588+ subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1589+ subOuter <- liftIO $ newSubscriberCoincidenceOuter subscribedUnsafe
1590+ outerSubscription@(EventSubscription _ outerSubd) <- subscribe (coincidenceParent c) subOuter
1591+ outerOcc <- liftIO $ readEventSubscribed outerSubd
1592+ outerHeight <- liftIO $ readIORef $ eventSubscribedHeightRef outerSubd
1593+ (occ, height, mInnerSubd) <- case outerOcc of
1594+ Nothing -> return (Nothing, outerHeight, Nothing)
1596+ (occ, height, innerSubd) <- subscribeCoincidenceInner o outerHeight subscribedUnsafe
1597+ return (occ, height, Just innerSubd)
1598+ occRef <- liftIO $ newIORef occ
1599+ when (isJust occ) $ scheduleClear occRef
1600+ heightRef <- liftIO $ newIORef height
1601+ innerSubdRef <- liftIO $ newIORef mInnerSubd
1602+ scheduleClear innerSubdRef
1603+ weakSelf <- liftIO $ newIORef $ error "getCoincidenceSubscribed: weakSelf not yet implemented"
1604+ (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupCoincidenceSubscribed
1605+ let subscribed = CoincidenceSubscribed
1606+ { coincidenceSubscribedCachedSubscribed = coincidenceSubscribed c
1607+ , coincidenceSubscribedOccurrence = occRef
1608+ , coincidenceSubscribedHeight = heightRef
1609+ , coincidenceSubscribedSubscribers = subs
1610+ , coincidenceSubscribedOuter = subOuter
1611+ , coincidenceSubscribedOuterParent = outerSubscription
1612+ , coincidenceSubscribedInnerParent = innerSubdRef
1613+ , coincidenceSubscribedWeakSelf = weakSelf
1614+#ifdef DEBUG_NODEIDS
1615+ , coincidenceSubscribedNodeId = unsafeNodeId c
1618+ liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "CoincidenceSubscribed"
1619+ liftIO $ writeIORef subscribedRef $! subscribed
1620+ liftIO $ writeIORef (coincidenceSubscribed c) $ Just subscribed
1621+ return (slnForSub, subscribed)
1623+cleanupCoincidenceSubscribed :: CoincidenceSubscribed a -> IO ()
1624+cleanupCoincidenceSubscribed subscribed = do
1625+ unsubscribe $ coincidenceSubscribedOuterParent subscribed
1626+ writeIORef (coincidenceSubscribedCachedSubscribed subscribed) Nothing
1628+{-# INLINE subscribeCoincidenceSubscribed #-}
1629+subscribeCoincidenceSubscribed :: CoincidenceSubscribed a -> Subscriber a -> IO (SubscriberListTicket a)
1630+subscribeCoincidenceSubscribed subscribed sub = WeakBag.insert sub (coincidenceSubscribedSubscribers subscribed) (coincidenceSubscribedWeakSelf subscribed) cleanupCoincidenceSubscribed
1632+{-# INLINE merge #-}
1633+merge :: GCompare k => Dynamic R.PatchDMap (DMap k Event) -> Event (DMap k Identity)
1634+merge m = EventMerge $ Merge
1636+ , mergeSubscribed = unsafeNewIORef m Nothing
1639+newtype EventSelector k = EventSelector { select :: forall a. k a -> Event a }
1641+fan :: GCompare k => Event (DMap k Identity) -> EventSelector k
1645+ , fanSubscribed = unsafeNewIORef e Nothing
1647+ in EventSelector $ \k -> EventFan k f
1649+runHoldInits :: IORef [SomeHoldInit] -> IORef [SomeMergeInit] -> EventM x ()
1650+runHoldInits holdInitRef mergeInitRef = do
1651+ holdInits <- liftIO $ readIORef holdInitRef
1652+ mergeInits <- liftIO $ readIORef mergeInitRef
1653+ unless (null holdInits && null mergeInits) $ do
1654+ liftIO $ writeIORef holdInitRef []
1655+ liftIO $ writeIORef mergeInitRef []
1656+ mapM_ initHold holdInits
1657+ mapM_ initMerge mergeInits
1658+ runHoldInits holdInitRef mergeInitRef
1660+initHold :: SomeHoldInit -> EventM x ()
1661+initHold (SomeHoldInit h) = void $ getHoldEventSubscription h
1663+initMerge :: SomeMergeInit -> EventM x ()
1664+initMerge (SomeMergeInit subscribed changed) = do
1665+ changeSub <- liftIO $ newSubscriberMergeChange subscribed
1666+ EventSubscription _ changeSubd <- subscribe changed changeSub
1667+ change <- liftIO $ readEventSubscribed changeSubd
1668+ forM_ change $ \c -> defer $ SomeMergeUpdate c subscribed
1669+ liftIO $ writeIORef (mergeSubscribedChange subscribed) (changeSub, changeSubd)
1671+-- | Run an event action outside of a frame
1672+runFrame :: EventM x a -> SpiderHost x a --TODO: This function also needs to hold the mutex
1673+runFrame a = SpiderHost $ ask >>= \spiderEnv -> lift $ do
1674+ -- Clear out pending unsubscriptions; these will need to happen eventually anyway, and might cause us a lot of extra work during the frame, so get rid of them now
1675+ pendingCleanups <- atomicModifyIORef (_spiderEnv_cleanups spiderEnv) $ \x -> ([], x)
1676+ {-# SCC "cleanups" #-} sequence_ pendingCleanups
1677+ toAssignRef <- newIORef [] -- This should only actually get used when events are firing
1678+ holdInitRef <- newIORef []
1679+ mergeUpdateRef <- newIORef []
1680+ mergeInitRef <- newIORef []
1681+ heightRef <- newIORef zeroHeight
1682+ toClearRef <- newIORef []
1683+ toClearRootRef <- newIORef []
1684+ coincidenceInfosRef <- newIORef []
1685+ delayedRef <- liftIO $ newIORef IntMap.empty
1686+ let env = EventEnv spiderEnv toAssignRef holdInitRef mergeUpdateRef mergeInitRef toClearRef toClearRootRef heightRef coincidenceInfosRef delayedRef
1689+ runHoldInits holdInitRef mergeInitRef -- This must happen before doing the assignments, in case subscribing a Hold causes existing Holds to be read by the newly-propagated events
1691+ result <- runEventM go env
1692+ toClear <- readIORef toClearRef
1693+ forM_ toClear $ \(SomeClear ref) -> {-# SCC "clear" #-} writeIORef ref Nothing
1694+ toClearRoot <- readIORef toClearRootRef
1695+ forM_ toClearRoot $ \(SomeRootClear ref) -> {-# SCC "rootClear" #-} writeIORef ref $! DMap.empty
1696+ toAssign <- readIORef toAssignRef
1697+ toReconnectRef <- newIORef []
1698+ coincidenceInfos <- readIORef coincidenceInfosRef
1699+ forM_ toAssign $ \(SomeAssignment vRef iRef v) -> {-# SCC "assignment" #-} do
1701+ when debugInvalidate $ putStrLn $ "Invalidating Hold"
1702+ writeIORef iRef =<< evaluate =<< invalidate toReconnectRef =<< readIORef iRef
1703+ mergeUpdates <- readIORef mergeUpdateRef
1704+ writeIORef mergeUpdateRef []
1705+ let updateMerge :: SomeMergeUpdate -> IO [SomeEventSubscription]
1706+ updateMerge (SomeMergeUpdate (R.PatchDMap p :: R.PatchDMap (DMap k Event)) m) = do
1707+ oldParents <- readIORef $ mergeSubscribedParents m
1708+ let f (subscriptionsToKill, ps) (k :=> Compose me) = do
1709+ (mOldSubd, newPs) <- case me of
1710+ Nothing -> return $ DMap.updateLookupWithKey (\_ _ -> Nothing) k ps
1712+ s <- liftIO $ newSubscriberMerge k m
1713+ subscription@(EventSubscription _ subd) <- subscribe e s
1714+ let newParent = MergeSubscribedParent subscription s
1715+ newParentHeight <- liftIO $ getEventSubscribedHeight subd
1716+ liftIO $ addMergeHeight newParentHeight m
1717+ return $ DMap.insertLookupWithKey' (\_ new _ -> new) k newParent ps
1718+ forM_ mOldSubd $ \oldSubd -> do
1719+ oldHeight <- liftIO $ readIORef $ eventSubscribedHeightRef $ _eventSubscription_subscribed $ mergeSubscribedParentSubscription oldSubd
1720+ liftIO $ removeMergeHeight oldHeight m
1721+ return (maybeToList (SomeEventSubscription . mergeSubscribedParentSubscription <$> mOldSubd) ++ subscriptionsToKill, newPs)
1722+ (subscriptionsToKill, newParents) <- flip runEventM env $ foldM f ([], oldParents) $ DMap.toList p --TODO: I think this runEventM is OK, since no events are firing at this time, but it might not be
1723+ writeIORef (mergeSubscribedParents m) $! newParents
1724+ return subscriptionsToKill
1725+ when debugPropagate $ putStrLn "Updating merges"
1726+ mergeSubscriptionsToKill <- concat <$> mapM updateMerge mergeUpdates
1727+ when debugPropagate $ putStrLn "Updating merges done"
1728+ toReconnect <- readIORef toReconnectRef
1729+ switchSubscriptionsToKill <- forM toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
1730+ oldSubscription <- readIORef $ switchSubscribedCurrentParent subscribed
1731+ wi <- readIORef $ switchSubscribedOwnWeakInvalidator subscribed
1732+ when debugInvalidate $ putStrLn $ "Finalizing invalidator for Switch" <> showNodeId subscribed
1734+ i <- evaluate $ switchSubscribedOwnInvalidator subscribed
1735+ wi' <- mkWeakPtrWithDebug i "wi'"
1736+ writeIORef (switchSubscribedOwnWeakInvalidator subscribed) $! wi'
1737+ writeIORef (switchSubscribedBehaviorParents subscribed) []
1738+ writeIORef holdInitRef [] --TODO: Should we reuse this?
1739+ e <- runBehaviorM (readBehaviorTracked (switchSubscribedParent subscribed)) (Just (wi', switchSubscribedBehaviorParents subscribed)) holdInitRef
1740+ runEventM (runHoldInits holdInitRef mergeInitRef) 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
1741+ --TODO: Make sure we touch the pieces of the SwitchSubscribed at the appropriate times
1742+ sub <- newSubscriberSwitch subscribed
1743+ subscription <- runReaderT (unSpiderHost (runFrame ({-# SCC "subscribeSwitch" #-} subscribe e sub))) spiderEnv --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
1745+ stackTrace <- liftIO $ fmap renderStack $ ccsToStrings =<< (getCCSOf $! switchSubscribedParent subscribed)
1746+ liftIO $ putStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
1747+ EventRoot _ -> "EventRoot"
1748+ EventNever -> "EventNever"
1749+ _ -> "something else"
1751+ writeIORef (switchSubscribedCurrentParent subscribed) $! subscription
1752+ return $ SomeEventSubscription oldSubscription
1753+ forM_ mergeSubscriptionsToKill $ \(SomeEventSubscription oldSubscription) -> liftIO $ unsubscribe oldSubscription
1754+ forM_ switchSubscriptionsToKill $ \(SomeEventSubscription oldSubscription) -> liftIO $ unsubscribe oldSubscription
1755+ forM_ toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
1756+ EventSubscription _ subd' <- readIORef $ switchSubscribedCurrentParent subscribed
1757+ parentHeight <- readIORef $ eventSubscribedHeightRef subd'
1758+ myHeight <- readIORef $ switchSubscribedHeight subscribed
1759+ when (parentHeight /= myHeight) $ do
1760+ writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
1761+ WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight myHeight
1762+ forM_ mergeUpdates $ \(SomeMergeUpdate _ m) -> do
1763+ invalidateMergeHeight m --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
1764+ forM_ coincidenceInfos $ \(SomeResetCoincidence subscription mcs) -> do
1765+ unsubscribe subscription
1766+ mapM_ invalidateCoincidenceHeight mcs
1767+ forM_ coincidenceInfos $ \(SomeResetCoincidence _ mcs) -> mapM_ recalculateCoincidenceHeight mcs
1768+ forM_ mergeUpdates $ \(SomeMergeUpdate _ m) -> revalidateMergeHeight m
1769+ forM_ toReconnect $ \(SomeSwitchSubscribed subscribed) -> do
1770+ height <- calculateSwitchHeight subscribed
1771+ updateSwitchHeight height subscribed
1774+newtype Height = Height { unHeight :: Int } deriving (Show, Read, Eq, Ord, Bounded)
1776+{-# INLINE zeroHeight #-}
1777+zeroHeight :: Height
1778+zeroHeight = Height 0
1780+{-# INLINE invalidHeight #-}
1781+invalidHeight :: Height
1782+invalidHeight = Height (-1000)
1784+-- | An invalid height that is currently being traversed, e.g. by walkInvalidHeightParents
1785+{-# INLINE invalidHeightBeingTraversed #-}
1786+invalidHeightBeingTraversed :: Height
1787+invalidHeightBeingTraversed = Height (-1001)
1789+{-# INLINE succHeight #-}
1790+succHeight :: Height -> Height
1791+succHeight h@(Height a) =
1792+ if h == invalidHeight
1794+ else Height $ succ a
1796+invalidateSubscriberHeight :: Height -> Subscriber a -> IO ()
1797+invalidateSubscriberHeight old s = case s of
1798+ SubscriberPush _ subscribed -> do
1799+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberPush" <> showNodeId subscribed
1800+ WeakBag.traverse (pushSubscribedSubscribers subscribed) $ invalidateSubscriberHeight old
1801+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberPush" <> showNodeId subscribed <> " done"
1802+ SubscriberMerge _ subscribed -> do
1803+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed
1804+ removeMergeHeight old subscribed
1805+ invalidateMergeHeight subscribed
1806+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed <> " done"
1807+ SubscriberMergeChange _ -> return () -- Doesn't affect the height of the merge, because its changes are delayed
1808+ SubscriberFan subscribed -> do
1809+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
1810+ subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1811+ forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ invalidateSubscriberHeight old
1812+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
1813+ SubscriberHold _ -> return ()
1814+ SubscriberHoldIdentity _ -> return ()
1815+ SubscriberSwitch subscribed -> do
1816+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
1817+ oldHeight <- readIORef $ switchSubscribedHeight subscribed
1818+ when (oldHeight /= invalidHeight) $ do
1819+ writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
1820+ WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
1821+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
1822+ SubscriberCoincidenceOuter subscribed -> do
1823+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
1824+ invalidateCoincidenceHeight subscribed
1825+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
1826+ SubscriberCoincidenceInner subscribed -> do
1827+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
1828+ invalidateCoincidenceHeight subscribed
1829+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
1830+ SubscriberHandle -> return ()
1832+removeMergeHeight :: Height -> MergeSubscribed k -> IO ()
1833+removeMergeHeight oldParentHeight subscribed = do
1834+ when debugInvalidateHeight $ putStrLn $ "removeMergeHeight: " <> show oldParentHeight <> " Merge" <> showNodeId subscribed
1835+ oldHeights <- readIORef $ mergeSubscribedHeightBag subscribed
1836+ let newHeights = heightBagRemove oldParentHeight oldHeights
1837+ writeIORef (mergeSubscribedHeightBag subscribed) $! newHeights
1839+invalidateMergeHeight :: MergeSubscribed k -> IO ()
1840+invalidateMergeHeight subscribed = do
1841+ oldHeight <- readIORef $ mergeSubscribedHeight subscribed
1842+ -- If the height used to be valid, it must be invalid now; we should never have *more* heights than we have parents
1843+ when (oldHeight /= invalidHeight) $ do
1844+ writeIORef (mergeSubscribedHeight subscribed) $! invalidHeight
1845+ WeakBag.traverse (mergeSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
1847+addMergeHeight :: Height -> MergeSubscribed k -> IO ()
1848+addMergeHeight newParentHeight subscribed = do
1849+ when debugInvalidateHeight $ putStrLn $ "addMergeHeight: " <> show newParentHeight <> " Merge" <> showNodeId subscribed
1850+ oldHeights <- readIORef $ mergeSubscribedHeightBag subscribed
1851+ let newHeights = heightBagAdd newParentHeight oldHeights
1852+ writeIORef (mergeSubscribedHeightBag subscribed) $! newHeights
1854+revalidateMergeHeight :: MergeSubscribed k -> IO ()
1855+revalidateMergeHeight subscribed = do
1856+ currentHeight <- readIORef $ mergeSubscribedHeight subscribed
1857+ when (currentHeight == invalidHeight) $ do -- revalidateMergeHeight may be called multiple times; perhaps the's a way to finesse it to avoid this check
1858+ heights <- readIORef $ mergeSubscribedHeightBag subscribed
1859+ parents <- readIORef $ mergeSubscribedParents subscribed
1860+ -- When the number of heights in the bag reaches the number of parents, we should have a valid height
1861+ case heightBagSize heights `compare` DMap.size parents of
1864+ let height = succHeight $ heightBagMax heights
1865+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
1866+ writeIORef (mergeSubscribedHeight subscribed) $! height
1867+ WeakBag.traverse (mergeSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
1868+ GT -> error $ "revalidateMergeHeight: more heights than parents for Merge" <> showNodeId subscribed
1870+invalidateCoincidenceHeight :: CoincidenceSubscribed a -> IO ()
1871+invalidateCoincidenceHeight subscribed = do
1872+ oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
1873+ when (oldHeight /= invalidHeight) $ do
1874+ writeIORef (coincidenceSubscribedHeight subscribed) $! invalidHeight
1875+ WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
1877+recalculateSubscriberHeight :: Height -> Subscriber a -> IO ()
1878+recalculateSubscriberHeight new s = case s of
1879+ SubscriberPush _ subscribed -> do
1880+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberPush" <> showNodeId subscribed
1881+ WeakBag.traverse (pushSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
1882+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberPush" <> showNodeId subscribed <> " done"
1883+ SubscriberMerge _ subscribed -> do
1884+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed
1885+ addMergeHeight new subscribed
1886+ revalidateMergeHeight subscribed
1887+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed <> " done"
1888+ SubscriberMergeChange _ -> return ()
1889+ SubscriberFan subscribed -> do
1890+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
1891+ subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1892+ forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ recalculateSubscriberHeight new
1893+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
1894+ SubscriberHold _ -> return ()
1895+ SubscriberHoldIdentity _ -> return ()
1896+ SubscriberSwitch subscribed -> do
1897+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
1898+ updateSwitchHeight new subscribed
1899+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
1900+ SubscriberCoincidenceOuter subscribed -> do
1901+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
1902+ recalculateCoincidenceHeight subscribed
1903+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
1904+ SubscriberCoincidenceInner subscribed -> do
1905+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
1906+ recalculateCoincidenceHeight subscribed
1907+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
1908+ SubscriberHandle -> return ()
1910+updateSwitchHeight :: Height -> SwitchSubscribed a -> IO ()
1911+updateSwitchHeight new subscribed = do
1912+ oldHeight <- readIORef $ switchSubscribedHeight subscribed
1913+ when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
1914+ when (new /= invalidHeight) $ do --TODO: This 'when' should probably be an assertion
1915+ writeIORef (switchSubscribedHeight subscribed) $! new
1916+ WeakBag.traverse (switchSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
1918+recalculateCoincidenceHeight :: CoincidenceSubscribed a -> IO ()
1919+recalculateCoincidenceHeight subscribed = do
1920+ oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
1921+ when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
1922+ height <- calculateCoincidenceHeight subscribed
1923+ when (height /= invalidHeight) $ do
1924+ writeIORef (coincidenceSubscribedHeight subscribed) $! height
1925+ WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
1927+getEventSubscribedHeight :: EventSubscribed a -> IO Height
1928+getEventSubscribedHeight es = readIORef $ eventSubscribedHeightRef es
1930+calculateSwitchHeight :: SwitchSubscribed a -> IO Height
1931+calculateSwitchHeight subscribed = readIORef . eventSubscribedHeightRef . _eventSubscription_subscribed =<< readIORef (switchSubscribedCurrentParent subscribed)
1933+calculateCoincidenceHeight :: CoincidenceSubscribed a -> IO Height
1934+calculateCoincidenceHeight subscribed = do
1935+ outerHeight <- readIORef $ eventSubscribedHeightRef $ _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
1936+ innerHeight <- maybe (return zeroHeight) (readIORef . eventSubscribedHeightRef) =<< readIORef (coincidenceSubscribedInnerParent subscribed)
1937+ return $ if outerHeight == invalidHeight || innerHeight == invalidHeight then invalidHeight else max outerHeight innerHeight
1939+data SomeSwitchSubscribed = forall a. SomeSwitchSubscribed {-# NOUNPACK #-} (SwitchSubscribed a)
1941+invalidate :: IORef [SomeSwitchSubscribed] -> WeakList Invalidator -> IO (WeakList Invalidator)
1942+invalidate toReconnectRef wis = do
1943+ forM_ wis $ \wi -> do
1947+ traceInvalidate "invalidate Dead"
1948+ return () --TODO: Should we clean this up here?
1950+ finalize wi -- Once something's invalidated, it doesn't need to hang around; this will change when some things are strict
1952+ InvalidatorPull p -> do
1953+ traceInvalidate $ "invalidate: Pull" <> showNodeId p
1954+ mVal <- readIORef $ pullValue p
1955+ forM_ mVal $ \val -> do
1956+ writeIORef (pullValue p) Nothing
1957+ writeIORef (pullSubscribedInvalidators val) =<< evaluate =<< invalidate toReconnectRef =<< readIORef (pullSubscribedInvalidators val)
1958+ InvalidatorSwitch subscribed -> do
1959+ traceInvalidate $ "invalidate: Switch" <> showNodeId subscribed
1960+ modifyIORef' toReconnectRef (SomeSwitchSubscribed subscribed :)
1961+ 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
1963+--------------------------------------------------------------------------------
1964+-- Reflex integration
1965+--------------------------------------------------------------------------------
1967+-- | The default, global Spider environment
1968+type Spider = SpiderEnv Global
1970+-- | Designates the default, global Spider timeline
1973+{-# NOINLINE globalSpiderEnv #-}
1974+globalSpiderEnv :: SpiderEnv Global
1975+globalSpiderEnv = unsafePerformIO unsafeNewSpiderEnv
1977+-- | Stores all global data relevant to a particular Spider timeline; only one
1978+-- value should exist for each type @x@
1979+data SpiderEnv x = SpiderEnv
1980+ { _spiderEnv_toUnsubscribe :: !(IORef [SomeEventSubscription])
1981+ , _spiderEnv_lock :: !(MVar ())
1982+ , _spiderEnv_cleanups :: !(IORef [IO ()])
1984+ , _spiderEnv_depth :: !(IORef Int)
1987+type role SpiderEnv nominal
1989+instance GEq SpiderEnv where
1990+ a `geq` b = if _spiderEnv_toUnsubscribe a == _spiderEnv_toUnsubscribe b
1991+ then Just $ unsafeCoerce Refl -- This unsafeCoerce is safe because the same SpiderEnv can't have two different 'x' arguments
1994+unsafeNewSpiderEnv :: forall x. IO (SpiderEnv x)
1995+unsafeNewSpiderEnv = do
1996+ toUnsubscribe <- newIORef []
1998+ cleanups <- newIORef []
2000+ depthRef <- newIORef 0
2003+ { _spiderEnv_toUnsubscribe = toUnsubscribe
2004+ , _spiderEnv_lock = lock
2005+ , _spiderEnv_cleanups = cleanups
2007+ , _spiderEnv_depth = depthRef
2011+-- | Create a new SpiderEnv
2012+newSpiderEnv :: IO (Some SpiderEnv)
2013+newSpiderEnv = Some.This <$> unsafeNewSpiderEnv
2015+newtype SpiderPullM x a = SpiderPullM (BehaviorM a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
2017+newtype SpiderPushM x a = SpiderPushM (ComputeM a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
2019+instance R.Reflex (SpiderEnv x) where
2020+ newtype Behavior (SpiderEnv x) a = SpiderBehavior { unSpiderBehavior :: Behavior a }
2021+ newtype Event (SpiderEnv x) a = SpiderEvent { unSpiderEvent :: Event a }
2022+ newtype Dynamic (SpiderEnv x) a = SpiderDynamic { unSpiderDynamic :: Dynamic Identity a } deriving (Functor, Applicative, Monad)
2023+ newtype Incremental (SpiderEnv x) p a = SpiderIncremental { unSpiderIncremental :: Dynamic p a }
2024+ type PullM (SpiderEnv x) = SpiderPullM x
2025+ type PushM (SpiderEnv x) = SpiderPushM x
2026+ {-# INLINABLE never #-}
2027+ never = SpiderEvent EventNever
2028+ {-# INLINABLE constant #-}
2029+ constant = SpiderBehavior . BehaviorConst
2030+ {-# INLINABLE push #-}
2031+ push f = SpiderEvent . push (coerce f) . unSpiderEvent
2032+ {-# INLINABLE pull #-}
2033+ pull = SpiderBehavior . pull . coerce
2034+ {-# INLINABLE merge #-}
2035+ merge = SpiderEvent . merge . DynamicConst . (unsafeCoerce :: DMap k (R.Event (SpiderEnv x)) -> DMap k Event)
2036+ {-# INLINABLE fan #-}
2037+ fan e = R.EventSelector $ SpiderEvent . select (fan (unSpiderEvent e))
2038+ {-# INLINABLE switch #-}
2039+ switch = SpiderEvent . switch . (unsafeCoerce :: Behavior (R.Event (SpiderEnv x) a) -> Behavior (Event a)) . unSpiderBehavior
2040+ {-# INLINABLE coincidence #-}
2041+ coincidence = SpiderEvent . coincidence . (unsafeCoerce :: Event (R.Event (SpiderEnv x) a) -> Event (Event a)) . unSpiderEvent
2042+ {-# INLINABLE current #-}
2043+ current = SpiderBehavior . current . unSpiderDynamic
2044+ {-# INLINABLE updated #-}
2045+ updated = SpiderEvent . fmap runIdentity . updated . unSpiderDynamic
2046+ {-# INLINABLE unsafeBuildDynamic #-}
2047+ unsafeBuildDynamic readV0 v' = SpiderDynamic $ DynamicDynIdentity $ unsafeDyn (coerce readV0) $ addIdentity $ unSpiderEvent v'
2048+ {-# INLINABLE unsafeBuildIncremental #-}
2049+ unsafeBuildIncremental readV0 dv = SpiderIncremental $ DynamicDyn $ unsafeDyn (coerce readV0) $ unSpiderEvent dv
2050+ {-# INLINABLE mergeIncremental #-}
2051+ mergeIncremental = SpiderEvent . merge . (unsafeCoerce :: Dynamic R.PatchDMap (DMap k (R.Event (SpiderEnv x))) -> Dynamic R.PatchDMap (DMap k Event)) . unSpiderIncremental
2052+ {-# INLINABLE currentIncremental #-}
2053+ currentIncremental = SpiderBehavior . current . unSpiderIncremental
2054+ {-# INLINABLE updatedIncremental #-}
2055+ updatedIncremental = SpiderEvent . updated . unSpiderIncremental
2056+ {-# INLINABLE incrementalToDynamic #-}
2057+ incrementalToDynamic (SpiderIncremental i) = SpiderDynamic $ DynamicDynIdentity $ unsafeDyn (readBehaviorUntracked $ current i) $ flip push (updated i) $ \p -> do
2058+ c <- readBehaviorUntracked $ current i
2059+ return $ Identity <$> R.apply p c --TODO: Avoid the redundant 'apply'
2061+instance R.MonadSample (SpiderEnv x) (EventM x) where
2062+ {-# INLINABLE sample #-}
2063+ sample (SpiderBehavior b) = readBehaviorUntracked b
2065+instance R.MonadHold (SpiderEnv x) (EventM x) where
2066+ {-# INLINABLE hold #-}
2067+ hold = holdSpiderEventM
2068+ {-# INLINABLE holdDyn #-}
2069+ holdDyn = holdDynSpiderEventM
2070+ {-# INLINABLE holdIncremental #-}
2071+ holdIncremental = holdIncrementalSpiderEventM
2073+holdSpiderEventM :: a -> R.Event (SpiderEnv x) a -> EventM x (R.Behavior (SpiderEnv x) a)
2074+holdSpiderEventM v0 e = fmap (SpiderBehavior . BehaviorHoldIdentity) $ hold v0 $ addIdentity $ unSpiderEvent e
2076+holdDynSpiderEventM :: a -> R.Event (SpiderEnv x) a -> EventM x (R.Dynamic (SpiderEnv x) a)
2077+holdDynSpiderEventM v0 e = fmap (SpiderDynamic . DynamicHoldIdentity) $ hold v0 $ addIdentity $ unSpiderEvent e
2079+holdIncrementalSpiderEventM :: R.Patch p => a -> R.Event (SpiderEnv x) (p a) -> EventM x (R.Incremental (SpiderEnv x) p a)
2080+holdIncrementalSpiderEventM v0 e = fmap (SpiderIncremental . DynamicHold) $ hold v0 $ unSpiderEvent e
2082+instance R.MonadHold (SpiderEnv x) (SpiderHost x) where
2083+ {-# INLINABLE hold #-}
2084+ hold v0 e = R.runHostFrame $ R.hold v0 e
2085+ {-# INLINABLE holdDyn #-}
2086+ holdDyn v0 e = R.runHostFrame $ R.holdDyn v0 e
2087+ {-# INLINABLE holdIncremental #-}
2088+ holdIncremental v0 e = R.runHostFrame $ R.holdIncremental v0 e
2090+instance R.MonadSample (SpiderEnv x) (SpiderHost x) where
2091+ {-# INLINABLE sample #-}
2092+ sample = runFrame . readBehaviorUntracked . unSpiderBehavior
2094+instance R.MonadSample (SpiderEnv x) (SpiderPullM x) where
2095+ {-# INLINABLE sample #-}
2096+ sample = coerce . readBehaviorTracked . unSpiderBehavior
2098+instance R.MonadSample (SpiderEnv x) (SpiderPushM x) where
2099+ {-# INLINABLE sample #-}
2100+ sample (SpiderBehavior b) = SpiderPushM $ readBehaviorUntracked b
2102+instance R.MonadHold (SpiderEnv x) (SpiderPushM x) where
2103+ {-# INLINABLE hold #-}
2104+ hold v0 e = R.current <$> R.holdDyn v0 e
2105+ {-# INLINABLE holdDyn #-}
2106+ holdDyn v0 (SpiderEvent e) = SpiderPushM $ fmap (SpiderDynamic . DynamicHoldIdentity) $ hold v0 $ addIdentity e
2107+ {-# INLINABLE holdIncremental #-}
2108+ holdIncremental v0 (SpiderEvent e) = SpiderPushM $ SpiderIncremental . DynamicHold <$> hold v0 e
2110+data RootTrigger a = forall k. GCompare k => RootTrigger (SubscriberList a, IORef (DMap k Identity), k a)
2111+newtype SpiderEventHandle a = SpiderEventHandle { unSpiderEventHandle :: EventSubscription a }
2113+instance R.MonadSubscribeEvent (SpiderEnv x) (SpiderHostFrame x) where
2114+ {-# INLINABLE subscribeEvent #-}
2115+ subscribeEvent e = SpiderHostFrame $ do
2116+ subscription <- subscribe (unSpiderEvent e) SubscriberHandle --TODO: Unsubscribe eventually (manually and/or with weak ref)
2117+ return $ SpiderEventHandle subscription
2119+instance R.ReflexHost (SpiderEnv x) where
2120+ type EventTrigger (SpiderEnv x) = RootTrigger
2121+ type EventHandle (SpiderEnv x) = SpiderEventHandle
2122+ type HostFrame (SpiderEnv x) = SpiderHostFrame x
2124+instance R.MonadReadEvent (SpiderEnv x) (ReadPhase x) where
2125+ {-# INLINABLE readEvent #-}
2126+ readEvent h = ReadPhase $ fmap (fmap return) $ liftIO $ do
2127+ let EventSubscription sln subscribed = unSpiderEventHandle h
2128+ result <- readEventSubscribed subscribed
2132+instance MonadRef (EventM x) where
2133+ type Ref (EventM x) = Ref IO
2134+ {-# INLINABLE newRef #-}
2135+ {-# INLINABLE readRef #-}
2136+ {-# INLINABLE writeRef #-}
2137+ newRef = liftIO . newRef
2138+ readRef = liftIO . readRef
2139+ writeRef r a = liftIO $ writeRef r a
2141+instance MonadAtomicRef (EventM x) where
2142+ {-# INLINABLE atomicModifyRef #-}
2143+ atomicModifyRef r f = liftIO $ atomicModifyRef r f
2145+-- | The monad for actions that manipulate a Spider timeline identified by @x@
2146+newtype SpiderHost x a = SpiderHost { unSpiderHost :: ReaderT (SpiderEnv x) IO a } deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2148+instance Monad (SpiderHost x) where
2149+ {-# INLINABLE (>>=) #-}
2150+ SpiderHost x >>= f = SpiderHost $ x >>= unSpiderHost . f
2151+ {-# INLINABLE (>>) #-}
2152+ SpiderHost x >> SpiderHost y = SpiderHost $ x >> y
2153+ {-# INLINABLE return #-}
2154+ return x = SpiderHost $ return x
2155+ {-# INLINABLE fail #-}
2156+ fail s = SpiderHost $ fail s
2158+-- | Run an action affecting the global Spider timeline; this will be guarded by
2159+-- a mutex for that timeline
2160+runSpiderHost :: SpiderHost Global a -> IO a
2161+runSpiderHost (SpiderHost a) = runReaderT a globalSpiderEnv
2163+newtype SpiderHostFrame x a = SpiderHostFrame { runSpiderHostFrame :: EventM x a } deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2165+instance Monad (SpiderHostFrame x) where
2166+ {-# INLINABLE (>>=) #-}
2167+ SpiderHostFrame x >>= f = SpiderHostFrame $ x >>= runSpiderHostFrame . f
2168+ {-# INLINABLE (>>) #-}
2169+ SpiderHostFrame x >> SpiderHostFrame y = SpiderHostFrame $ x >> y
2170+ {-# INLINABLE return #-}
2171+ return x = SpiderHostFrame $ return x
2172+ {-# INLINABLE fail #-}
2173+ fail s = SpiderHostFrame $ fail s
2175+instance R.MonadSample (SpiderEnv x) (SpiderHostFrame x) where
2176+ sample = SpiderHostFrame . readBehaviorUntracked . unSpiderBehavior --TODO: This can cause problems with laziness, so we should get rid of it if we can
2178+addIdentity :: Event a -> Event (Identity a)
2179+--addIdentity = fmap Identity
2180+addIdentity = unsafeCoerce
2182+instance R.MonadHold (SpiderEnv x) (SpiderHostFrame x) where
2183+ {-# INLINABLE hold #-}
2184+ hold v0 e = SpiderHostFrame $ fmap (SpiderBehavior . BehaviorHoldIdentity) $ hold v0 $ addIdentity $ unSpiderEvent e
2185+ {-# INLINABLE holdDyn #-}
2186+ holdDyn v0 e = SpiderHostFrame $ fmap (SpiderDynamic . DynamicHoldIdentity) $ hold v0 $ addIdentity $ unSpiderEvent e
2187+ {-# INLINABLE holdIncremental #-}
2188+ holdIncremental v0 e = SpiderHostFrame $ fmap (SpiderIncremental . DynamicHold) $ hold v0 $ unSpiderEvent e
2190+newEventWithTriggerIO :: forall a. (RootTrigger a -> IO (IO ())) -> IO (Event a)
2191+newEventWithTriggerIO f = do
2192+ es <- newFanEventWithTriggerIO $ \Refl -> f
2193+ return $ select es Refl
2195+newFanEventWithTriggerIO :: GCompare k => (forall a. k a -> RootTrigger a -> IO (IO ())) -> IO (EventSelector k)
2196+newFanEventWithTriggerIO f = do
2197+ occRef <- newIORef DMap.empty
2198+ subscribedRef <- newIORef DMap.empty
2200+ { rootOccurrence = occRef
2201+ , rootSubscribed = subscribedRef
2204+ return $ EventSelector $ \k -> EventRoot k r
2206+instance R.MonadReflexCreateTrigger (SpiderEnv x) (SpiderHost x) where
2207+ newEventWithTrigger = SpiderHost . lift . fmap SpiderEvent . newEventWithTriggerIO
2208+ newFanEventWithTrigger f = SpiderHost $ lift $ do
2209+ es <- newFanEventWithTriggerIO f
2210+ return $ R.EventSelector $ SpiderEvent . select es
2212+instance R.MonadReflexCreateTrigger (SpiderEnv x) (SpiderHostFrame x) where
2213+ newEventWithTrigger = SpiderHostFrame . EventM . liftIO . fmap SpiderEvent . newEventWithTriggerIO
2214+ newFanEventWithTrigger f = SpiderHostFrame $ EventM $ liftIO $ do
2215+ es <- newFanEventWithTriggerIO f
2216+ return $ R.EventSelector $ SpiderEvent . select es
2218+instance R.MonadSubscribeEvent (SpiderEnv x) (SpiderHost x) where
2219+ {-# INLINABLE subscribeEvent #-}
2220+ subscribeEvent = subscribeEventSpiderHost
2222+subscribeEventSpiderHost :: R.Event (SpiderEnv x) a -> SpiderHost x (R.EventHandle (SpiderEnv x) a)
2223+subscribeEventSpiderHost e = do
2224+ subscription <- runFrame $ subscribe (unSpiderEvent e) SubscriberHandle --TODO: Unsubscribe eventually (manually and/or with weak ref)
2225+ return $ SpiderEventHandle subscription
2227+newtype ReadPhase x a = ReadPhase (ResultM x a) deriving (Functor, Applicative, Monad, MonadFix)
2229+instance R.MonadSample (SpiderEnv x) (ReadPhase x) where
2230+ {-# INLINABLE sample #-}
2231+ sample = ReadPhase . R.sample
2233+instance R.MonadHold (SpiderEnv x) (ReadPhase x) where
2234+ {-# INLINABLE hold #-}
2235+ hold v0 e = ReadPhase $ R.hold v0 e
2236+ {-# INLINABLE holdDyn #-}
2237+ holdDyn v0 e = ReadPhase $ R.holdDyn v0 e
2238+ {-# INLINABLE holdIncremental #-}
2239+ holdIncremental v0 e = ReadPhase $ R.holdIncremental v0 e
2241+instance R.MonadReflexHost (SpiderEnv x) (SpiderHost x) where
2242+ type ReadPhase (SpiderHost x) = ReadPhase x
2243+ fireEventsAndRead es (ReadPhase a) = run es a
2244+ runHostFrame = runFrame . runSpiderHostFrame
2246+instance MonadRef (SpiderHost x) where
2247+ type Ref (SpiderHost x) = Ref IO
2248+ newRef = SpiderHost . newRef
2249+ readRef = SpiderHost . readRef
2250+ writeRef r = SpiderHost . writeRef r
2252+instance MonadAtomicRef (SpiderHost x) where
2253+ atomicModifyRef r = SpiderHost . atomicModifyRef r
2255+instance MonadRef (SpiderHostFrame x) where
2256+ type Ref (SpiderHostFrame x) = Ref IO
2257+ newRef = SpiderHostFrame . newRef
2258+ readRef = SpiderHostFrame . readRef
2259+ writeRef r = SpiderHostFrame . writeRef r
2261+instance MonadAtomicRef (SpiderHostFrame x) where
2262+ atomicModifyRef r = SpiderHostFrame . atomicModifyRef r