@@ -0,0 +1,2288 @@
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
1157+readEvent :: Event a -> ResultM (Maybe a)
1158+readEvent e = case e of
1159+ EventRoot k r -> liftIO . fmap (coerce . DMap.lookup k) . readIORef $ rootOccurrence r
1160+ EventNever -> return Nothing
1162+ subscribed <- getPushSubscribed p
1163+ liftIO $ readPushSubscribed subscribed
1165+ subscribed <- getMergeSubscribed m
1166+ liftIO $ readMergeSubscribed subscribed
1168+ subscribed <- getFanSubscribed f
1169+ liftIO $ readFanSubscribed k subscribed
1170+ EventSwitch s -> do
1171+ subscribed <- getSwitchSubscribed s
1172+ liftIO $ readSwitchSubscribed subscribed
1173+ EventCoincidence c -> do
1174+ subscribed <- getCoincidenceSubscribed c
1175+ liftIO $ readCoincidenceSubscribed subscribed
1176+ EventHold h -> liftIO . readEventSubscribed =<< getHoldEventSubscription h
1177+ EventDyn d -> liftIO . readEventSubscribed =<< getHoldEventSubscription =<< getDynHold d
1178+ EventHoldIdentity h -> liftIO . readEventSubscribed =<< getHoldEventSubscription h
1179+ EventDynIdentity d -> liftIO . readEventSubscribed =<< getHoldEventSubscription =<< getDynHold d
1182+readEventSubscribed :: EventSubscribed a -> IO (Maybe a)
1183+readEventSubscribed = \case
1184+ EventSubscribedRoot rs -> readRootSubscribed rs
1185+ EventSubscribedNever -> return Nothing
1186+ EventSubscribedPush ps -> readPushSubscribed ps
1187+ EventSubscribedMerge ms -> readMergeSubscribed ms
1188+ EventSubscribedFan k fs -> readFanSubscribed k fs
1189+ EventSubscribedSwitch ss -> readSwitchSubscribed ss
1190+ EventSubscribedCoincidence cs -> readCoincidenceSubscribed cs
1192+readRootSubscribed :: RootSubscribed a -> IO (Maybe a)
1193+readRootSubscribed = rootSubscribedOccurrence
1195+readPushSubscribed :: PushSubscribed b a -> IO (Maybe a)
1196+readPushSubscribed subscribed = do
1197+ result <- readIORef $ pushSubscribedOccurrence subscribed -- Since ResultM is always called after the final height is reached, this will always be valid
1198+ touch $ pushSubscribedSelf subscribed
1201+readMergeSubscribed :: MergeSubscribed k -> IO (Maybe (DMap k Identity))
1202+readMergeSubscribed subscribed = do
1203+ result <- readIORef $ mergeSubscribedOccurrence subscribed
1204+ touch $ mergeSubscribedParents subscribed
1207+readFanSubscribed :: GCompare k => k a -> FanSubscribed k -> IO (Maybe a)
1208+readFanSubscribed k fs = do
1209+ parentOcc <- readEventSubscribed $ _eventSubscription_subscribed $ fanSubscribedParent fs
1210+ return $ coerce $ DMap.lookup k =<< parentOcc
1212+readSwitchSubscribed :: SwitchSubscribed a -> IO (Maybe a)
1213+readSwitchSubscribed subscribed = do
1214+ result <- readIORef $ switchSubscribedOccurrence subscribed
1215+ touch $ switchSubscribedOwnInvalidator subscribed
1218+readCoincidenceSubscribed :: CoincidenceSubscribed a -> IO (Maybe a)
1219+readCoincidenceSubscribed subscribed = do
1220+ result <- readIORef $ coincidenceSubscribedOccurrence subscribed
1221+ touch $ coincidenceSubscribedOuter subscribed
1222+ --TODO: do we need to touch the inner subscriber?
1225+-- Always refers to 0
1226+{-# NOINLINE zeroRef #-}
1227+zeroRef :: IORef Height
1228+zeroRef = unsafePerformIO $ newIORef zeroHeight
1230+{-# SPECIALIZE subscribe :: Event a -> Subscriber a -> EventM x (EventSubscription a) #-}
1231+subscribe :: forall x m a. CanSubscribe x m => Event a -> Subscriber a -> m (EventSubscription a)
1232+subscribe e sub = case e of
1233+ EventRoot k r -> wrap EventSubscribedRoot $ liftIO . getRootSubscribed k r
1234+ EventNever -> return $ EventSubscription Nothing EventSubscribedNever
1235+ EventPush p -> wrap EventSubscribedPush $ getPushSubscribed p
1236+ EventFan k f -> wrap (EventSubscribedFan k) $ getFanSubscribed k f
1237+ EventMerge m -> wrap EventSubscribedMerge $ getMergeSubscribed m
1238+ EventSwitch s -> wrap EventSubscribedSwitch $ getSwitchSubscribed s
1239+ EventCoincidence c -> wrap EventSubscribedCoincidence $ getCoincidenceSubscribed c
1240+ EventHold h -> subscribeHoldEvent h sub
1241+ EventDyn j -> getDynHold j >>= \h -> subscribeHoldEvent h sub
1242+ EventHoldIdentity h -> subscribeHoldEvent h sub
1243+ EventDynIdentity j -> getDynHold j >>= \h -> subscribeHoldEvent h sub
1245+ wrap :: (t -> EventSubscribed a) -> (Subscriber a -> m (SubscriberListTicket a, t)) -> m (EventSubscription a)
1246+ wrap tag getSpecificSubscribed = do
1247+ (sln, subd) <- getSpecificSubscribed sub
1248+ return $ EventSubscription (Just sln) $ tag subd
1250+{-# INLINE subscribeHoldEvent #-}
1251+subscribeHoldEvent :: (CanSubscribe x m, R.Patch p) => Hold p a -> Subscriber (p a) -> m (EventSubscription (p a))
1252+subscribeHoldEvent h sub = do
1253+ EventSubscription _ subd <- getHoldEventSubscription h
1254+ sln <- liftIO $ subscribeEventSubscribed subd sub
1255+ return $ EventSubscription sln subd
1257+{-# INLINE debugSubscribe #-}
1258+debugSubscribe :: Bool
1259+debugSubscribe = False
1261+{-# INLINE subscribeEventSubscribed #-}
1262+subscribeEventSubscribed :: EventSubscribed a -> Subscriber a -> IO (Maybe (SubscriberListTicket a))
1263+subscribeEventSubscribed es sub = case es of
1264+ EventSubscribedRoot r -> do
1265+ traceSubscribe $ "subscribeEventSubscribed Root"
1266+ Just <$> subscribeRootSubscribed r sub
1267+ EventSubscribedNever -> do
1268+ traceSubscribe $ "subscribeEventSubscribed Never"
1270+ EventSubscribedPush subscribed -> do
1271+ traceSubscribe $ "subscribeEventSubscribed Push"
1272+ Just <$> subscribePushSubscribed subscribed sub
1273+ EventSubscribedFan k subscribed -> do
1274+ traceSubscribe $ "subscribeEventSubscribed Fan"
1275+ Just <$> subscribeFanSubscribed k subscribed sub
1276+ EventSubscribedMerge subscribed -> do
1277+ traceSubscribe $ "subscribeEventSubscribed Merge"
1278+ Just <$> subscribeMergeSubscribed subscribed sub
1279+ EventSubscribedSwitch subscribed -> do
1280+ traceSubscribe $ "subscribeEventSubscribed Switch"
1281+ Just <$> subscribeSwitchSubscribed subscribed sub
1282+ EventSubscribedCoincidence subscribed -> do
1283+ traceSubscribe $ "subscribeEventSubscribed Coincidence"
1284+ Just <$> subscribeCoincidenceSubscribed subscribed sub
1286+{-# INLINE eventSubscribedHeightRef #-}
1287+eventSubscribedHeightRef :: EventSubscribed a -> IORef Height
1288+eventSubscribedHeightRef = \case
1289+ EventSubscribedRoot _ -> zeroRef
1290+ EventSubscribedNever -> zeroRef
1291+ EventSubscribedPush subscribed -> pushSubscribedHeight subscribed
1292+ EventSubscribedFan _ subscribed -> eventSubscribedHeightRef $ _eventSubscription_subscribed $ fanSubscribedParent subscribed
1293+ EventSubscribedMerge subscribed -> mergeSubscribedHeight subscribed
1294+ EventSubscribedSwitch subscribed -> switchSubscribedHeight subscribed
1295+ EventSubscribedCoincidence subscribed -> coincidenceSubscribedHeight subscribed
1297+{-# INLINE eventSubscribedHasOwnHeightRef #-}
1298+eventSubscribedHasOwnHeightRef :: EventSubscribed a -> Bool
1299+eventSubscribedHasOwnHeightRef = \case
1300+ EventSubscribedRoot _ -> False
1301+ EventSubscribedNever -> False
1302+ EventSubscribedPush _ -> False
1303+ EventSubscribedFan _ _ -> False
1304+ EventSubscribedMerge _ -> True
1305+ EventSubscribedSwitch _ -> True
1306+ EventSubscribedCoincidence _ -> True
1308+{-# INLINE eventSubscribedGetParents #-}
1309+eventSubscribedGetParents :: EventSubscribed a -> IO [Some EventSubscribed]
1310+eventSubscribedGetParents = \case
1311+ EventSubscribedRoot _ -> return []
1312+ EventSubscribedNever -> return []
1313+ EventSubscribedPush subscribed -> return [Some.This $ _eventSubscription_subscribed $ pushSubscribedParent subscribed]
1314+ EventSubscribedFan _ subscribed -> return [Some.This $ _eventSubscription_subscribed $ fanSubscribedParent subscribed]
1315+ EventSubscribedMerge subscribed -> do
1316+ ps <- readIORef $ mergeSubscribedParents subscribed
1317+ return $ R.ffor (DMap.toList ps) $ \(_ :=> v) -> Some.This $ _eventSubscription_subscribed $ mergeSubscribedParentSubscription v
1318+ EventSubscribedSwitch subscribed -> do
1319+ s <- readIORef $ switchSubscribedCurrentParent subscribed
1320+ return [Some.This $ _eventSubscription_subscribed s]
1321+ EventSubscribedCoincidence subscribed -> do
1322+ innerSubscription <- readIORef $ coincidenceSubscribedInnerParent subscribed
1323+ let outerParent = Some.This $ _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
1324+ innerParents = maybeToList $ fmap Some.This innerSubscription
1325+ return $ outerParent : innerParents
1327+type CanSubscribe x m =
1329+ , HasCurrentHeight m
1330+ , Defer SomeHoldInit m, Defer SomeMergeInit m -- The things we need to lazily initialize state
1331+ , Defer SomeClear m -- Wiping out event firings
1332+ , Defer SomeAssignment m -- Updating state
1333+ , Defer SomeResetCoincidence m
1336+getRootSubscribed :: GCompare k => k a -> Root k -> Subscriber a -> IO (SubscriberListTicket a, RootSubscribed a)
1337+getRootSubscribed k r sub = do
1338+ mSubscribed <- readIORef $ rootSubscribed r
1339+ case DMap.lookup k mSubscribed of
1340+ Just subscribed -> {-# SCC "hitRoot" #-} do
1341+ sln <- subscribeRootSubscribed subscribed sub
1342+ return (sln, subscribed)
1343+ Nothing -> {-# SCC "missRoot" #-} do
1344+ weakSelf <- newIORef $ error "getRootSubscribed: weakSelfRef not initialized"
1345+ let !cached = rootSubscribed r
1346+ uninitRef <- newIORef $ error "getRootsubscribed: uninitRef not initialized"
1347+ (subs, sln) <- WeakBag.singleton sub weakSelf cleanupRootSubscribed
1348+ when debugPropagate $ putStrLn $ "getRootSubscribed: calling rootInit"
1349+ uninit <- rootInit r k $ RootTrigger (subs, rootOccurrence r, k)
1350+ writeIORef uninitRef $! uninit
1351+ let subscribed = RootSubscribed
1352+ { rootSubscribedKey = k
1353+ , rootSubscribedCachedSubscribed = cached
1354+ , rootSubscribedOccurrence = fmap (coerce . DMap.lookup k) $ readIORef $ rootOccurrence r
1355+ , rootSubscribedSubscribers = subs
1356+ , rootSubscribedUninit = uninit
1357+ , rootSubscribedWeakSelf = weakSelf
1358+#ifdef DEBUG_NODEIDS
1359+ , rootSubscribedNodeId = unsafeNodeId (k, r, subs)
1362+ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "RootSubscribed"
1363+ 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
1364+ return (sln, subscribed)
1366+{-# ANN cleanupRootSubscribed "HLint: ignore Redundant bracket" #-}
1367+cleanupRootSubscribed :: RootSubscribed a -> IO ()
1368+cleanupRootSubscribed self@(RootSubscribed { rootSubscribedKey = k, rootSubscribedCachedSubscribed = cached }) = do
1369+ rootSubscribedUninit self
1370+ modifyIORef' cached $ DMap.delete k
1372+{-# INLINE subscribeRootSubscribed #-}
1373+subscribeRootSubscribed :: RootSubscribed a -> Subscriber a -> IO (SubscriberListTicket a)
1374+subscribeRootSubscribed subscribed sub = WeakBag.insert sub (rootSubscribedSubscribers subscribed) (rootSubscribedWeakSelf subscribed) cleanupRootSubscribed
1376+-- When getPushSubscribed returns, the PushSubscribed returned will have a fully filled-in
1377+{-# SPECIALIZE getPushSubscribed :: Push a b -> Subscriber b -> EventM x (SubscriberListTicket b, PushSubscribed a b) #-}
1378+getPushSubscribed :: CanSubscribe x m => Push a b -> Subscriber b -> m (SubscriberListTicket b, PushSubscribed a b)
1379+getPushSubscribed p sub = do
1380+ mSubscribed <- liftIO $ readIORef $ pushSubscribed p
1381+ case mSubscribed of
1382+ Just subscribed -> {-# SCC "hitPush" #-} do
1383+ sln <- liftIO $ subscribePushSubscribed subscribed sub
1384+ return (sln, subscribed)
1385+ Nothing -> {-# SCC "missPush" #-} do -- Not yet subscribed
1386+ subscribedRef <- liftIO $ newIORef $ error "getPushSubscribed: subscribed not yet intialized"
1387+ subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1388+ s <- liftIO $ newSubscriberPush (pushCompute p) subscribedUnsafe
1389+ subscription@(EventSubscription _ subd) <- subscribe (pushParent p) s
1390+ parentOcc <- liftIO $ readEventSubscribed subd
1391+ occ <- runComputeM $ join <$> mapM (pushCompute p) parentOcc
1392+ occRef <- liftIO $ newIORef occ
1393+ when (isJust occ) $ scheduleClear occRef
1394+ weakSelf <- liftIO $ newIORef $ error "getPushSubscribed: weakSelf not initialized"
1395+ let !cached = pushSubscribed p
1396+ (subs, sln) <- liftIO $ WeakBag.singleton sub weakSelf cleanupPushSubscribed
1397+ let subscribed = PushSubscribed
1398+ { pushSubscribedCachedSubscribed = cached
1399+ , pushSubscribedOccurrence = occRef
1400+ , pushSubscribedHeight = eventSubscribedHeightRef subd -- Since pushes have the same height as their parents, share the ref
1401+ , pushSubscribedSubscribers = subs
1402+ , pushSubscribedSelf = s
1403+ , pushSubscribedWeakSelf = weakSelf
1404+ , pushSubscribedParent = subscription
1405+#ifdef DEBUG_NODEIDS
1406+ , pushSubscribedNodeId = unsafeNodeId p
1409+ liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "PushSubscribed"
1410+ liftIO $ writeIORef subscribedRef $! subscribed
1411+ liftIO $ writeIORef (pushSubscribed p) $ Just subscribed
1412+ return (sln, subscribed)
1414+cleanupPushSubscribed :: PushSubscribed a b -> IO ()
1415+cleanupPushSubscribed self = do
1416+ unsubscribe $ pushSubscribedParent self
1417+ writeIORef (pushSubscribedCachedSubscribed self) $ Nothing
1419+{-# INLINE subscribePushSubscribed #-}
1420+subscribePushSubscribed :: PushSubscribed a b -> Subscriber b -> IO (SubscriberListTicket b)
1421+subscribePushSubscribed subscribed sub = WeakBag.insert sub (pushSubscribedSubscribers subscribed) (pushSubscribedWeakSelf subscribed) cleanupPushSubscribed
1423+{-# SPECIALIZE getMergeSubscribed :: GCompare k => Merge k -> Subscriber (DMap k Identity) -> EventM x (SubscriberListTicket (DMap k Identity), MergeSubscribed k) #-}
1424+getMergeSubscribed :: forall x k m. (CanSubscribe x m, GCompare k) => Merge k -> Subscriber (DMap k Identity) -> m (SubscriberListTicket (DMap k Identity), MergeSubscribed k)
1425+getMergeSubscribed m sub = do
1426+ mSubscribed <- liftIO $ readIORef $ mergeSubscribed m
1427+ case mSubscribed of
1428+ Just subscribed -> {-# SCC "hitMerge" #-} do
1429+ sln <- liftIO $ subscribeMergeSubscribed subscribed sub
1430+ return (sln, subscribed)
1431+ Nothing -> {-# SCC "missMerge" #-} do
1432+ subscribedRef <- liftIO $ newIORef $ error "getMergeSubscribed: subscribedRef not yet initialized"
1433+ subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1434+ initialParents <- readBehaviorUntracked $ current $ mergeParents m
1435+ subscribers :: [(Maybe (DSum k Identity), Height, DSum k (MergeSubscribedParent k))] <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
1436+ s <- liftIO $ newSubscriberMerge k subscribedUnsafe
1437+ subscription@(EventSubscription _ parentSubd) <- subscribe e s
1438+ parentOcc <- liftIO $ readEventSubscribed parentSubd
1439+ height <- liftIO $ readIORef $ eventSubscribedHeightRef parentSubd
1440+ return $ (fmap (\x -> k :=> Identity x) parentOcc, height, k :=> MergeSubscribedParent subscription s)
1441+ let dm = DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
1442+ heights = fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
1443+ myHeightBag = heightBagFromList $ filter (/= invalidHeight) heights
1444+ myHeight = if invalidHeight `elem` heights
1446+ else succHeight $ heightBagMax myHeightBag
1447+ currentHeight <- getCurrentHeight
1448+ let (occ, accum) = if currentHeight >= myHeight -- If we should have fired by now
1449+ then (if DMap.null dm then Nothing else Just dm, DMap.empty)
1451+ unless (DMap.null accum) $ do
1452+ scheduleMerge myHeight subscribedUnsafe
1453+ occRef <- liftIO $ newIORef occ
1454+ when (isJust occ) $ scheduleClear occRef
1455+ accumRef <- liftIO $ newIORef accum
1456+ heightRef <- liftIO $ newIORef myHeight
1457+ heightMapRef <- liftIO $ newIORef myHeightBag
1458+ weakSelf <- liftIO $ newIORef $ error "getMergeSubscribed: weakSelf not yet initialized"
1459+ (subs, sln) <- liftIO $ WeakBag.singleton sub weakSelf cleanupMergeSubscribed
1460+ changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
1461+ parentsRef <- liftIO $ newIORef $ DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
1462+ let !subscribed = MergeSubscribed
1463+ { mergeSubscribedCachedSubscribed = mergeSubscribed m
1464+ , mergeSubscribedOccurrence = occRef
1465+ , mergeSubscribedAccum = accumRef
1466+ , mergeSubscribedHeight = heightRef
1467+ , mergeSubscribedHeightBag = heightMapRef
1468+ , mergeSubscribedSubscribers = subs
1469+ , mergeSubscribedChange = changeSubdRef
1470+ , mergeSubscribedParents = parentsRef
1471+ , mergeSubscribedWeakSelf = weakSelf
1472+#ifdef DEBUG_NODEIDS
1473+ , mergeSubscribedNodeId = unsafeNodeId m
1476+ defer $ SomeMergeInit subscribed $ updated $ mergeParents m
1477+ liftIO $ writeIORef subscribedRef $! subscribed
1478+ liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "MergeSubscribed"
1479+ liftIO $ writeIORef (mergeSubscribed m) $ Just subscribed
1480+ return (sln, subscribed)
1482+cleanupMergeSubscribed :: MergeSubscribed k -> IO ()
1483+cleanupMergeSubscribed subscribed = do
1484+ parents <- readIORef $ mergeSubscribedParents subscribed
1485+ forM_ (DMap.toList parents) $ \(_ :=> msp) -> unsubscribe $ mergeSubscribedParentSubscription msp
1486+ -- Not necessary, because this whole MergeSubscribed is dead: writeIORef (mergeSubscribedParents subscribed) DMap.empty
1487+ writeIORef (mergeSubscribedCachedSubscribed subscribed) $ Nothing -- Get rid of the cached subscribed
1489+{-# INLINE subscribeMergeSubscribed #-}
1490+subscribeMergeSubscribed :: MergeSubscribed k -> Subscriber (DMap k Identity) -> IO (SubscriberListTicket (DMap k Identity))
1491+subscribeMergeSubscribed subscribed sub = WeakBag.insert sub (mergeSubscribedSubscribers subscribed) (mergeSubscribedWeakSelf subscribed) cleanupMergeSubscribed
1493+{-# SPECIALIZE getFanSubscribed :: GCompare k => k a -> Fan k -> Subscriber a -> EventM x (SubscriberListTicket a, FanSubscribed k) #-}
1494+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)
1495+getFanSubscribed k f sub = do
1496+ mSubscribed <- liftIO $ readIORef $ fanSubscribed f
1497+ case mSubscribed of
1498+ Just subscribed -> {-# SCC "hitFan" #-} do
1499+ sln <- liftIO $ subscribeFanSubscribed k subscribed sub
1500+ return (sln, subscribed)
1501+ Nothing -> {-# SCC "missFan" #-} do
1502+ subscribedRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribedRef not yet initialized"
1503+ subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1504+ s <- liftIO $ newSubscriberFan subscribedUnsafe
1505+ subscription <- subscribe (fanParent f) s
1506+ weakSelf <- liftIO $ newIORef $ error "getFanSubscribed: weakSelf not yet initialized"
1507+ (subsForK, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupFanSubscribed
1508+ subscribersRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribersRef not yet initialized"
1509+ let subscribed = FanSubscribed
1510+ { fanSubscribedCachedSubscribed = fanSubscribed f
1511+ , fanSubscribedParent = subscription
1512+ , fanSubscribedSubscribers = subscribersRef
1513+#ifdef DEBUG_NODEIDS
1514+ , fanSubscribedNodeId = unsafeNodeId f
1517+ let !self = (k, subscribed)
1518+ liftIO $ writeIORef subscribersRef $! DMap.singleton k $ FanSubscribedChildren subsForK self weakSelf
1519+ liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug self "FanSubscribed"
1520+ liftIO $ writeIORef subscribedRef $! subscribed
1521+ liftIO $ writeIORef (fanSubscribed f) $ Just subscribed
1522+ return (slnForSub, subscribed)
1524+cleanupFanSubscribed :: GCompare k => (k a, FanSubscribed k) -> IO ()
1525+cleanupFanSubscribed (k, subscribed) = do
1526+ subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1527+ let reducedSubscribers = DMap.delete k subscribers
1528+ if DMap.null reducedSubscribers
1530+ unsubscribe $ fanSubscribedParent subscribed
1531+ -- Not necessary in this case, because this whole FanSubscribed is dead: writeIORef (fanSubscribedSubscribers subscribed) reducedSubscribers
1532+ writeIORef (fanSubscribedCachedSubscribed subscribed) Nothing
1533+ else writeIORef (fanSubscribedSubscribers subscribed) $! reducedSubscribers
1535+{-# INLINE subscribeFanSubscribed #-}
1536+subscribeFanSubscribed :: GCompare k => k a -> FanSubscribed k -> Subscriber a -> IO (SubscriberListTicket a)
1537+subscribeFanSubscribed k subscribed sub = do
1538+ subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1539+ case DMap.lookup k subscribers of
1540+ Nothing -> {-# SCC "missSubscribeFanSubscribed" #-} do
1541+ let !self = (k, subscribed)
1542+ weakSelf <- newIORef =<< mkWeakPtrWithDebug self "FanSubscribed"
1543+ (list, sln) <- WeakBag.singleton sub weakSelf cleanupFanSubscribed
1544+ 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
1546+ Just (FanSubscribedChildren list _ weakSelf) -> {-# SCC "hitSubscribeFanSubscribed" #-} WeakBag.insert sub list weakSelf cleanupFanSubscribed
1548+{-# SPECIALIZE getSwitchSubscribed :: Switch a -> Subscriber a -> EventM x (SubscriberListTicket a, SwitchSubscribed a) #-}
1549+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)
1550+getSwitchSubscribed s sub = do
1551+ mSubscribed <- liftIO $ readIORef $ switchSubscribed s
1552+ case mSubscribed of
1553+ Just subscribed -> {-# SCC "hitSwitch" #-} do
1554+ sln <- liftIO $ subscribeSwitchSubscribed subscribed sub
1555+ return (sln, subscribed)
1556+ Nothing -> {-# SCC "missSwitch" #-} do
1557+ subscribedRef <- liftIO $ newIORef $ error "getSwitchSubscribed: subscribed has not yet been created"
1558+ subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1559+ i <- liftIO $ newInvalidatorSwitch subscribedUnsafe
1560+ mySub <- liftIO $ newSubscriberSwitch subscribedUnsafe
1561+ wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorSwitch"
1562+ wiRef <- liftIO $ newIORef wi
1563+ parentsRef <- liftIO $ newIORef [] --TODO: This should be unnecessary, because it will always be filled with just the single parent behavior
1564+ holdInits <- getDeferralQueue
1565+ e <- liftIO $ runBehaviorM (readBehaviorTracked (switchParent s)) (Just (wi, parentsRef)) holdInits
1566+ subscription@(EventSubscription _ subd) <- subscribe e mySub
1567+ subscriptionRef <- liftIO $ newIORef subscription
1568+ parentOcc <- liftIO $ readEventSubscribed subd
1569+ occRef <- liftIO $ newIORef parentOcc
1570+ when (isJust parentOcc) $ scheduleClear occRef
1571+ heightRef <- liftIO $ newIORef =<< readIORef (eventSubscribedHeightRef subd)
1572+ weakSelf <- liftIO $ newIORef $ error "getSwitchSubscribed: weakSelf not yet initialized"
1573+ (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupSwitchSubscribed
1574+ let !subscribed = SwitchSubscribed
1575+ { switchSubscribedCachedSubscribed = switchSubscribed s
1576+ , switchSubscribedOccurrence = occRef
1577+ , switchSubscribedHeight = heightRef
1578+ , switchSubscribedSubscribers = subs
1579+ , switchSubscribedOwnInvalidator = i
1580+ , switchSubscribedOwnWeakInvalidator = wiRef
1581+ , switchSubscribedBehaviorParents = parentsRef
1582+ , switchSubscribedParent = switchParent s
1583+ , switchSubscribedCurrentParent = subscriptionRef
1584+ , switchSubscribedWeakSelf = weakSelf
1585+#ifdef DEBUG_NODEIDS
1586+ , switchSubscribedNodeId = unsafeNodeId s
1589+ liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "switchSubscribedWeakSelf"
1590+ liftIO $ writeIORef subscribedRef $! subscribed
1591+ liftIO $ writeIORef (switchSubscribed s) $ Just subscribed
1592+ return (slnForSub, subscribed)
1594+cleanupSwitchSubscribed :: SwitchSubscribed a -> IO ()
1595+cleanupSwitchSubscribed subscribed = do
1596+ unsubscribe =<< readIORef (switchSubscribedCurrentParent subscribed)
1597+ finalize =<< readIORef (switchSubscribedOwnWeakInvalidator subscribed) -- We don't need to get invalidated if we're dead
1598+ writeIORef (switchSubscribedCachedSubscribed subscribed) Nothing
1600+{-# INLINE subscribeSwitchSubscribed #-}
1601+subscribeSwitchSubscribed :: SwitchSubscribed a -> Subscriber a -> IO (SubscriberListTicket a)
1602+subscribeSwitchSubscribed subscribed sub = WeakBag.insert sub (switchSubscribedSubscribers subscribed) (switchSubscribedWeakSelf subscribed) cleanupSwitchSubscribed
1604+{-# SPECIALIZE getCoincidenceSubscribed :: Coincidence a -> Subscriber a -> EventM x (SubscriberListTicket a, CoincidenceSubscribed a) #-}
1605+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)
1606+getCoincidenceSubscribed c sub = do
1607+ mSubscribed <- liftIO $ readIORef $ coincidenceSubscribed c
1608+ case mSubscribed of
1609+ Just subscribed -> {-# SCC "hitCoincidence" #-} do
1610+ sln <- liftIO $ subscribeCoincidenceSubscribed subscribed sub
1611+ return (sln, subscribed)
1612+ Nothing -> {-# SCC "missCoincidence" #-} do
1613+ subscribedRef <- liftIO $ newIORef $ error "getCoincidenceSubscribed: subscribed has not yet been created"
1614+ subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1615+ subOuter <- liftIO $ newSubscriberCoincidenceOuter subscribedUnsafe
1616+ outerSubscription@(EventSubscription _ outerSubd) <- subscribe (coincidenceParent c) subOuter
1617+ outerOcc <- liftIO $ readEventSubscribed outerSubd
1618+ outerHeight <- liftIO $ readIORef $ eventSubscribedHeightRef outerSubd
1619+ (occ, height, mInnerSubd) <- case outerOcc of
1620+ Nothing -> return (Nothing, outerHeight, Nothing)
1622+ (occ, height, innerSubd) <- subscribeCoincidenceInner o outerHeight subscribedUnsafe
1623+ return (occ, height, Just innerSubd)
1624+ occRef <- liftIO $ newIORef occ
1625+ when (isJust occ) $ scheduleClear occRef
1626+ heightRef <- liftIO $ newIORef height
1627+ innerSubdRef <- liftIO $ newIORef mInnerSubd
1628+ scheduleClear innerSubdRef
1629+ weakSelf <- liftIO $ newIORef $ error "getCoincidenceSubscribed: weakSelf not yet implemented"
1630+ (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupCoincidenceSubscribed
1631+ let subscribed = CoincidenceSubscribed
1632+ { coincidenceSubscribedCachedSubscribed = coincidenceSubscribed c
1633+ , coincidenceSubscribedOccurrence = occRef
1634+ , coincidenceSubscribedHeight = heightRef
1635+ , coincidenceSubscribedSubscribers = subs
1636+ , coincidenceSubscribedOuter = subOuter
1637+ , coincidenceSubscribedOuterParent = outerSubscription
1638+ , coincidenceSubscribedInnerParent = innerSubdRef
1639+ , coincidenceSubscribedWeakSelf = weakSelf
1640+#ifdef DEBUG_NODEIDS
1641+ , coincidenceSubscribedNodeId = unsafeNodeId c
1644+ liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "CoincidenceSubscribed"
1645+ liftIO $ writeIORef subscribedRef $! subscribed
1646+ liftIO $ writeIORef (coincidenceSubscribed c) $ Just subscribed
1647+ return (slnForSub, subscribed)
1649+cleanupCoincidenceSubscribed :: CoincidenceSubscribed a -> IO ()
1650+cleanupCoincidenceSubscribed subscribed = do
1651+ unsubscribe $ coincidenceSubscribedOuterParent subscribed
1652+ writeIORef (coincidenceSubscribedCachedSubscribed subscribed) Nothing
1654+{-# INLINE subscribeCoincidenceSubscribed #-}
1655+subscribeCoincidenceSubscribed :: CoincidenceSubscribed a -> Subscriber a -> IO (SubscriberListTicket a)
1656+subscribeCoincidenceSubscribed subscribed sub = WeakBag.insert sub (coincidenceSubscribedSubscribers subscribed) (coincidenceSubscribedWeakSelf subscribed) cleanupCoincidenceSubscribed
1658+{-# INLINE merge #-}
1659+merge :: GCompare k => Dynamic R.PatchDMap (DMap k Event) -> Event (DMap k Identity)
1660+merge m = EventMerge $ Merge
1662+ , mergeSubscribed = unsafeNewIORef m Nothing
1665+newtype EventSelector k = EventSelector { select :: forall a. k a -> Event a }
1667+fan :: GCompare k => Event (DMap k Identity) -> EventSelector k
1671+ , fanSubscribed = unsafeNewIORef e Nothing
1673+ in EventSelector $ \k -> EventFan k f
1675+runHoldInits :: IORef [SomeHoldInit] -> IORef [SomeMergeInit] -> EventM x ()
1676+runHoldInits holdInitRef mergeInitRef = do
1677+ holdInits <- liftIO $ readIORef holdInitRef
1678+ mergeInits <- liftIO $ readIORef mergeInitRef
1679+ unless (null holdInits && null mergeInits) $ do
1680+ liftIO $ writeIORef holdInitRef []
1681+ liftIO $ writeIORef mergeInitRef []
1682+ mapM_ initHold holdInits
1683+ mapM_ initMerge mergeInits
1684+ runHoldInits holdInitRef mergeInitRef
1686+initHold :: SomeHoldInit -> EventM x ()
1687+initHold (SomeHoldInit h) = void $ getHoldEventSubscription h
1689+initMerge :: SomeMergeInit -> EventM x ()
1690+initMerge (SomeMergeInit subscribed changed) = do
1691+ changeSub <- liftIO $ newSubscriberMergeChange subscribed
1692+ EventSubscription _ changeSubd <- subscribe changed changeSub
1693+ change <- liftIO $ readEventSubscribed changeSubd
1694+ forM_ change $ \c -> defer $ SomeMergeUpdate c subscribed
1695+ liftIO $ writeIORef (mergeSubscribedChange subscribed) (changeSub, changeSubd)
1697+-- | Run an event action outside of a frame
1698+runFrame :: EventM x a -> SpiderHost x a --TODO: This function also needs to hold the mutex
1699+runFrame a = SpiderHost $ ask >>= \spiderEnv -> lift $ do
1700+ -- 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
1701+ pendingCleanups <- atomicModifyIORef (_spiderEnv_cleanups spiderEnv) $ \x -> ([], x)
1702+ {-# SCC "cleanups" #-} sequence_ pendingCleanups
1703+ toAssignRef <- newIORef [] -- This should only actually get used when events are firing
1704+ holdInitRef <- newIORef []
1705+ mergeUpdateRef <- newIORef []
1706+ mergeInitRef <- newIORef []
1707+ heightRef <- newIORef zeroHeight
1708+ toClearRef <- newIORef []
1709+ toClearRootRef <- newIORef []
1710+ coincidenceInfosRef <- newIORef []
1711+ delayedRef <- liftIO $ newIORef IntMap.empty
1712+ let env = EventEnv spiderEnv toAssignRef holdInitRef mergeUpdateRef mergeInitRef toClearRef toClearRootRef heightRef coincidenceInfosRef delayedRef
1715+ 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
1717+ result <- runEventM go env
1718+ toClear <- readIORef toClearRef
1719+ forM_ toClear $ \(SomeClear ref) -> {-# SCC "clear" #-} writeIORef ref Nothing
1720+ toClearRoot <- readIORef toClearRootRef
1721+ forM_ toClearRoot $ \(SomeRootClear ref) -> {-# SCC "rootClear" #-} writeIORef ref $! DMap.empty
1722+ toAssign <- readIORef toAssignRef
1723+ toReconnectRef <- newIORef []
1724+ coincidenceInfos <- readIORef coincidenceInfosRef
1725+ forM_ toAssign $ \(SomeAssignment vRef iRef v) -> {-# SCC "assignment" #-} do
1727+ when debugInvalidate $ putStrLn $ "Invalidating Hold"
1728+ writeIORef iRef =<< evaluate =<< invalidate toReconnectRef =<< readIORef iRef
1729+ mergeUpdates <- readIORef mergeUpdateRef
1730+ writeIORef mergeUpdateRef []
1731+ let updateMerge :: SomeMergeUpdate -> IO [SomeEventSubscription]
1732+ updateMerge (SomeMergeUpdate (R.PatchDMap p :: R.PatchDMap (DMap k Event)) m) = do
1733+ oldParents <- readIORef $ mergeSubscribedParents m
1734+ let f (subscriptionsToKill, ps) (k :=> Compose me) = do
1735+ (mOldSubd, newPs) <- case me of
1736+ Nothing -> return $ DMap.updateLookupWithKey (\_ _ -> Nothing) k ps
1738+ s <- liftIO $ newSubscriberMerge k m
1739+ subscription@(EventSubscription _ subd) <- subscribe e s
1740+ let newParent = MergeSubscribedParent subscription s
1741+ newParentHeight <- liftIO $ getEventSubscribedHeight subd
1742+ liftIO $ addMergeHeight newParentHeight m
1743+ return $ DMap.insertLookupWithKey' (\_ new _ -> new) k newParent ps
1744+ forM_ mOldSubd $ \oldSubd -> do
1745+ oldHeight <- liftIO $ readIORef $ eventSubscribedHeightRef $ _eventSubscription_subscribed $ mergeSubscribedParentSubscription oldSubd
1746+ liftIO $ removeMergeHeight oldHeight m
1747+ return (maybeToList (SomeEventSubscription . mergeSubscribedParentSubscription <$> mOldSubd) ++ subscriptionsToKill, newPs)
1748+ (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
1749+ writeIORef (mergeSubscribedParents m) $! newParents
1750+ return subscriptionsToKill
1751+ when debugPropagate $ putStrLn "Updating merges"
1752+ mergeSubscriptionsToKill <- concat <$> mapM updateMerge mergeUpdates
1753+ when debugPropagate $ putStrLn "Updating merges done"
1754+ toReconnect <- readIORef toReconnectRef
1755+ switchSubscriptionsToKill <- forM toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
1756+ oldSubscription <- readIORef $ switchSubscribedCurrentParent subscribed
1757+ wi <- readIORef $ switchSubscribedOwnWeakInvalidator subscribed
1758+ when debugInvalidate $ putStrLn $ "Finalizing invalidator for Switch" <> showNodeId subscribed
1760+ i <- evaluate $ switchSubscribedOwnInvalidator subscribed
1761+ wi' <- mkWeakPtrWithDebug i "wi'"
1762+ writeIORef (switchSubscribedOwnWeakInvalidator subscribed) $! wi'
1763+ writeIORef (switchSubscribedBehaviorParents subscribed) []
1764+ writeIORef holdInitRef [] --TODO: Should we reuse this?
1765+ e <- runBehaviorM (readBehaviorTracked (switchSubscribedParent subscribed)) (Just (wi', switchSubscribedBehaviorParents subscribed)) holdInitRef
1766+ 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
1767+ --TODO: Make sure we touch the pieces of the SwitchSubscribed at the appropriate times
1768+ sub <- newSubscriberSwitch subscribed
1769+ 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
1771+ stackTrace <- liftIO $ fmap renderStack $ ccsToStrings =<< (getCCSOf $! switchSubscribedParent subscribed)
1772+ liftIO $ putStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
1773+ EventRoot _ -> "EventRoot"
1774+ EventNever -> "EventNever"
1775+ _ -> "something else"
1777+ writeIORef (switchSubscribedCurrentParent subscribed) $! subscription
1778+ return $ SomeEventSubscription oldSubscription
1779+ forM_ mergeSubscriptionsToKill $ \(SomeEventSubscription oldSubscription) -> liftIO $ unsubscribe oldSubscription
1780+ forM_ switchSubscriptionsToKill $ \(SomeEventSubscription oldSubscription) -> liftIO $ unsubscribe oldSubscription
1781+ forM_ toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
1782+ EventSubscription _ subd' <- readIORef $ switchSubscribedCurrentParent subscribed
1783+ parentHeight <- readIORef $ eventSubscribedHeightRef subd'
1784+ myHeight <- readIORef $ switchSubscribedHeight subscribed
1785+ when (parentHeight /= myHeight) $ do
1786+ writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
1787+ WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight myHeight
1788+ forM_ mergeUpdates $ \(SomeMergeUpdate _ m) -> do
1789+ 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
1790+ forM_ coincidenceInfos $ \(SomeResetCoincidence subscription mcs) -> do
1791+ unsubscribe subscription
1792+ mapM_ invalidateCoincidenceHeight mcs
1793+ forM_ coincidenceInfos $ \(SomeResetCoincidence _ mcs) -> mapM_ recalculateCoincidenceHeight mcs
1794+ forM_ mergeUpdates $ \(SomeMergeUpdate _ m) -> revalidateMergeHeight m
1795+ forM_ toReconnect $ \(SomeSwitchSubscribed subscribed) -> do
1796+ height <- calculateSwitchHeight subscribed
1797+ updateSwitchHeight height subscribed
1800+newtype Height = Height { unHeight :: Int } deriving (Show, Read, Eq, Ord, Bounded)
1802+{-# INLINE zeroHeight #-}
1803+zeroHeight :: Height
1804+zeroHeight = Height 0
1806+{-# INLINE invalidHeight #-}
1807+invalidHeight :: Height
1808+invalidHeight = Height (-1000)
1810+-- | An invalid height that is currently being traversed, e.g. by walkInvalidHeightParents
1811+{-# INLINE invalidHeightBeingTraversed #-}
1812+invalidHeightBeingTraversed :: Height
1813+invalidHeightBeingTraversed = Height (-1001)
1815+{-# INLINE succHeight #-}
1816+succHeight :: Height -> Height
1817+succHeight h@(Height a) =
1818+ if h == invalidHeight
1820+ else Height $ succ a
1822+invalidateSubscriberHeight :: Height -> Subscriber a -> IO ()
1823+invalidateSubscriberHeight old s = case s of
1824+ SubscriberPush _ subscribed -> do
1825+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberPush" <> showNodeId subscribed
1826+ WeakBag.traverse (pushSubscribedSubscribers subscribed) $ invalidateSubscriberHeight old
1827+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberPush" <> showNodeId subscribed <> " done"
1828+ SubscriberMerge _ subscribed -> do
1829+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed
1830+ removeMergeHeight old subscribed
1831+ invalidateMergeHeight subscribed
1832+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed <> " done"
1833+ SubscriberMergeChange _ -> return () -- Doesn't affect the height of the merge, because its changes are delayed
1834+ SubscriberFan subscribed -> do
1835+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
1836+ subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1837+ forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ invalidateSubscriberHeight old
1838+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
1839+ SubscriberHold _ -> return ()
1840+ SubscriberHoldIdentity _ -> return ()
1841+ SubscriberSwitch subscribed -> do
1842+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
1843+ oldHeight <- readIORef $ switchSubscribedHeight subscribed
1844+ when (oldHeight /= invalidHeight) $ do
1845+ writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
1846+ WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
1847+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
1848+ SubscriberCoincidenceOuter subscribed -> do
1849+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
1850+ invalidateCoincidenceHeight subscribed
1851+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
1852+ SubscriberCoincidenceInner subscribed -> do
1853+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
1854+ invalidateCoincidenceHeight subscribed
1855+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
1856+ SubscriberHandle -> return ()
1858+removeMergeHeight :: Height -> MergeSubscribed k -> IO ()
1859+removeMergeHeight oldParentHeight subscribed = do
1860+ when debugInvalidateHeight $ putStrLn $ "removeMergeHeight: " <> show oldParentHeight <> " Merge" <> showNodeId subscribed
1861+ oldHeights <- readIORef $ mergeSubscribedHeightBag subscribed
1862+ let newHeights = heightBagRemove oldParentHeight oldHeights
1863+ writeIORef (mergeSubscribedHeightBag subscribed) $! newHeights
1865+invalidateMergeHeight :: MergeSubscribed k -> IO ()
1866+invalidateMergeHeight subscribed = do
1867+ oldHeight <- readIORef $ mergeSubscribedHeight subscribed
1868+ -- If the height used to be valid, it must be invalid now; we should never have *more* heights than we have parents
1869+ when (oldHeight /= invalidHeight) $ do
1870+ writeIORef (mergeSubscribedHeight subscribed) $! invalidHeight
1871+ WeakBag.traverse (mergeSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
1873+addMergeHeight :: Height -> MergeSubscribed k -> IO ()
1874+addMergeHeight newParentHeight subscribed = do
1875+ when debugInvalidateHeight $ putStrLn $ "addMergeHeight: " <> show newParentHeight <> " Merge" <> showNodeId subscribed
1876+ oldHeights <- readIORef $ mergeSubscribedHeightBag subscribed
1877+ let newHeights = heightBagAdd newParentHeight oldHeights
1878+ writeIORef (mergeSubscribedHeightBag subscribed) $! newHeights
1880+revalidateMergeHeight :: MergeSubscribed k -> IO ()
1881+revalidateMergeHeight subscribed = do
1882+ currentHeight <- readIORef $ mergeSubscribedHeight subscribed
1883+ when (currentHeight == invalidHeight) $ do -- revalidateMergeHeight may be called multiple times; perhaps the's a way to finesse it to avoid this check
1884+ heights <- readIORef $ mergeSubscribedHeightBag subscribed
1885+ parents <- readIORef $ mergeSubscribedParents subscribed
1886+ -- When the number of heights in the bag reaches the number of parents, we should have a valid height
1887+ case heightBagSize heights `compare` DMap.size parents of
1890+ let height = succHeight $ heightBagMax heights
1891+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
1892+ writeIORef (mergeSubscribedHeight subscribed) $! height
1893+ WeakBag.traverse (mergeSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
1894+ GT -> error $ "revalidateMergeHeight: more heights than parents for Merge" <> showNodeId subscribed
1896+invalidateCoincidenceHeight :: CoincidenceSubscribed a -> IO ()
1897+invalidateCoincidenceHeight subscribed = do
1898+ oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
1899+ when (oldHeight /= invalidHeight) $ do
1900+ writeIORef (coincidenceSubscribedHeight subscribed) $! invalidHeight
1901+ WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
1903+recalculateSubscriberHeight :: Height -> Subscriber a -> IO ()
1904+recalculateSubscriberHeight new s = case s of
1905+ SubscriberPush _ subscribed -> do
1906+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberPush" <> showNodeId subscribed
1907+ WeakBag.traverse (pushSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
1908+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberPush" <> showNodeId subscribed <> " done"
1909+ SubscriberMerge _ subscribed -> do
1910+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed
1911+ addMergeHeight new subscribed
1912+ revalidateMergeHeight subscribed
1913+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed <> " done"
1914+ SubscriberMergeChange _ -> return ()
1915+ SubscriberFan subscribed -> do
1916+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
1917+ subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1918+ forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ recalculateSubscriberHeight new
1919+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
1920+ SubscriberHold _ -> return ()
1921+ SubscriberHoldIdentity _ -> return ()
1922+ SubscriberSwitch subscribed -> do
1923+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
1924+ updateSwitchHeight new subscribed
1925+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
1926+ SubscriberCoincidenceOuter subscribed -> do
1927+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
1928+ recalculateCoincidenceHeight subscribed
1929+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
1930+ SubscriberCoincidenceInner subscribed -> do
1931+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
1932+ recalculateCoincidenceHeight subscribed
1933+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
1934+ SubscriberHandle -> return ()
1936+updateSwitchHeight :: Height -> SwitchSubscribed a -> IO ()
1937+updateSwitchHeight new subscribed = do
1938+ oldHeight <- readIORef $ switchSubscribedHeight subscribed
1939+ when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
1940+ when (new /= invalidHeight) $ do --TODO: This 'when' should probably be an assertion
1941+ writeIORef (switchSubscribedHeight subscribed) $! new
1942+ WeakBag.traverse (switchSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
1944+recalculateCoincidenceHeight :: CoincidenceSubscribed a -> IO ()
1945+recalculateCoincidenceHeight subscribed = do
1946+ oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
1947+ when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
1948+ height <- calculateCoincidenceHeight subscribed
1949+ when (height /= invalidHeight) $ do
1950+ writeIORef (coincidenceSubscribedHeight subscribed) $! height
1951+ WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
1953+getEventSubscribedHeight :: EventSubscribed a -> IO Height
1954+getEventSubscribedHeight es = readIORef $ eventSubscribedHeightRef es
1956+calculateSwitchHeight :: SwitchSubscribed a -> IO Height
1957+calculateSwitchHeight subscribed = readIORef . eventSubscribedHeightRef . _eventSubscription_subscribed =<< readIORef (switchSubscribedCurrentParent subscribed)
1959+calculateCoincidenceHeight :: CoincidenceSubscribed a -> IO Height
1960+calculateCoincidenceHeight subscribed = do
1961+ outerHeight <- readIORef $ eventSubscribedHeightRef $ _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
1962+ innerHeight <- maybe (return zeroHeight) (readIORef . eventSubscribedHeightRef) =<< readIORef (coincidenceSubscribedInnerParent subscribed)
1963+ return $ if outerHeight == invalidHeight || innerHeight == invalidHeight then invalidHeight else max outerHeight innerHeight
1965+data SomeSwitchSubscribed = forall a. SomeSwitchSubscribed {-# NOUNPACK #-} (SwitchSubscribed a)
1967+invalidate :: IORef [SomeSwitchSubscribed] -> WeakList Invalidator -> IO (WeakList Invalidator)
1968+invalidate toReconnectRef wis = do
1969+ forM_ wis $ \wi -> do
1973+ traceInvalidate "invalidate Dead"
1974+ return () --TODO: Should we clean this up here?
1976+ finalize wi -- Once something's invalidated, it doesn't need to hang around; this will change when some things are strict
1978+ InvalidatorPull p -> do
1979+ traceInvalidate $ "invalidate: Pull" <> showNodeId p
1980+ mVal <- readIORef $ pullValue p
1981+ forM_ mVal $ \val -> do
1982+ writeIORef (pullValue p) Nothing
1983+ writeIORef (pullSubscribedInvalidators val) =<< evaluate =<< invalidate toReconnectRef =<< readIORef (pullSubscribedInvalidators val)
1984+ InvalidatorSwitch subscribed -> do
1985+ traceInvalidate $ "invalidate: Switch" <> showNodeId subscribed
1986+ modifyIORef' toReconnectRef (SomeSwitchSubscribed subscribed :)
1987+ 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
1989+--------------------------------------------------------------------------------
1990+-- Reflex integration
1991+--------------------------------------------------------------------------------
1993+-- | The default, global Spider environment
1994+type Spider = SpiderEnv Global
1996+-- | Designates the default, global Spider timeline
1999+{-# NOINLINE globalSpiderEnv #-}
2000+globalSpiderEnv :: SpiderEnv Global
2001+globalSpiderEnv = unsafePerformIO unsafeNewSpiderEnv
2003+-- | Stores all global data relevant to a particular Spider timeline; only one
2004+-- value should exist for each type @x@
2005+data SpiderEnv x = SpiderEnv
2006+ { _spiderEnv_toUnsubscribe :: !(IORef [SomeEventSubscription])
2007+ , _spiderEnv_lock :: !(MVar ())
2008+ , _spiderEnv_cleanups :: !(IORef [IO ()])
2010+ , _spiderEnv_depth :: !(IORef Int)
2013+type role SpiderEnv nominal
2015+instance GEq SpiderEnv where
2016+ a `geq` b = if _spiderEnv_toUnsubscribe a == _spiderEnv_toUnsubscribe b
2017+ then Just $ unsafeCoerce Refl -- This unsafeCoerce is safe because the same SpiderEnv can't have two different 'x' arguments
2020+unsafeNewSpiderEnv :: forall x. IO (SpiderEnv x)
2021+unsafeNewSpiderEnv = do
2022+ toUnsubscribe <- newIORef []
2024+ cleanups <- newIORef []
2026+ depthRef <- newIORef 0
2029+ { _spiderEnv_toUnsubscribe = toUnsubscribe
2030+ , _spiderEnv_lock = lock
2031+ , _spiderEnv_cleanups = cleanups
2033+ , _spiderEnv_depth = depthRef
2037+-- | Create a new SpiderEnv
2038+newSpiderEnv :: IO (Some SpiderEnv)
2039+newSpiderEnv = Some.This <$> unsafeNewSpiderEnv
2041+newtype SpiderPullM x a = SpiderPullM (BehaviorM a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
2043+newtype SpiderPushM x a = SpiderPushM (ComputeM a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
2045+instance R.Reflex (SpiderEnv x) where
2046+ newtype Behavior (SpiderEnv x) a = SpiderBehavior { unSpiderBehavior :: Behavior a }
2047+ newtype Event (SpiderEnv x) a = SpiderEvent { unSpiderEvent :: Event a }
2048+ newtype Dynamic (SpiderEnv x) a = SpiderDynamic { unSpiderDynamic :: Dynamic Identity a } deriving (Functor, Applicative, Monad)
2049+ newtype Incremental (SpiderEnv x) p a = SpiderIncremental { unSpiderIncremental :: Dynamic p a }
2050+ type PullM (SpiderEnv x) = SpiderPullM x
2051+ type PushM (SpiderEnv x) = SpiderPushM x
2052+ {-# INLINABLE never #-}
2053+ never = SpiderEvent EventNever
2054+ {-# INLINABLE constant #-}
2055+ constant = SpiderBehavior . BehaviorConst
2056+ {-# INLINABLE push #-}
2057+ push f = SpiderEvent . push (coerce f) . unSpiderEvent
2058+ {-# INLINABLE pull #-}
2059+ pull = SpiderBehavior . pull . coerce
2060+ {-# INLINABLE merge #-}
2061+ merge = SpiderEvent . merge . DynamicConst . (unsafeCoerce :: DMap k (R.Event (SpiderEnv x)) -> DMap k Event)
2062+ {-# INLINABLE fan #-}
2063+ fan e = R.EventSelector $ SpiderEvent . select (fan (unSpiderEvent e))
2064+ {-# INLINABLE switch #-}
2065+ switch = SpiderEvent . switch . (unsafeCoerce :: Behavior (R.Event (SpiderEnv x) a) -> Behavior (Event a)) . unSpiderBehavior
2066+ {-# INLINABLE coincidence #-}
2067+ coincidence = SpiderEvent . coincidence . (unsafeCoerce :: Event (R.Event (SpiderEnv x) a) -> Event (Event a)) . unSpiderEvent
2068+ {-# INLINABLE current #-}
2069+ current = SpiderBehavior . current . unSpiderDynamic
2070+ {-# INLINABLE updated #-}
2071+ updated = SpiderEvent . fmap runIdentity . updated . unSpiderDynamic
2072+ {-# INLINABLE unsafeBuildDynamic #-}
2073+ unsafeBuildDynamic readV0 v' = SpiderDynamic $ DynamicDynIdentity $ unsafeDyn (coerce readV0) $ addIdentity $ unSpiderEvent v'
2074+ {-# INLINABLE unsafeBuildIncremental #-}
2075+ unsafeBuildIncremental readV0 dv = SpiderIncremental $ DynamicDyn $ unsafeDyn (coerce readV0) $ unSpiderEvent dv
2076+ {-# INLINABLE mergeIncremental #-}
2077+ mergeIncremental = SpiderEvent . merge . (unsafeCoerce :: Dynamic R.PatchDMap (DMap k (R.Event (SpiderEnv x))) -> Dynamic R.PatchDMap (DMap k Event)) . unSpiderIncremental
2078+ {-# INLINABLE currentIncremental #-}
2079+ currentIncremental = SpiderBehavior . current . unSpiderIncremental
2080+ {-# INLINABLE updatedIncremental #-}
2081+ updatedIncremental = SpiderEvent . updated . unSpiderIncremental
2082+ {-# INLINABLE incrementalToDynamic #-}
2083+ incrementalToDynamic (SpiderIncremental i) = SpiderDynamic $ DynamicDynIdentity $ unsafeDyn (readBehaviorUntracked $ current i) $ flip push (updated i) $ \p -> do
2084+ c <- readBehaviorUntracked $ current i
2085+ return $ Identity <$> R.apply p c --TODO: Avoid the redundant 'apply'
2087+instance R.MonadSample (SpiderEnv x) (EventM x) where
2088+ {-# INLINABLE sample #-}
2089+ sample (SpiderBehavior b) = readBehaviorUntracked b
2091+instance R.MonadHold (SpiderEnv x) (EventM x) where
2092+ {-# INLINABLE hold #-}
2093+ hold = holdSpiderEventM
2094+ {-# INLINABLE holdDyn #-}
2095+ holdDyn = holdDynSpiderEventM
2096+ {-# INLINABLE holdIncremental #-}
2097+ holdIncremental = holdIncrementalSpiderEventM
2099+holdSpiderEventM :: a -> R.Event (SpiderEnv x) a -> EventM x (R.Behavior (SpiderEnv x) a)
2100+holdSpiderEventM v0 e = fmap (SpiderBehavior . BehaviorHoldIdentity) $ hold v0 $ addIdentity $ unSpiderEvent e
2102+holdDynSpiderEventM :: a -> R.Event (SpiderEnv x) a -> EventM x (R.Dynamic (SpiderEnv x) a)
2103+holdDynSpiderEventM v0 e = fmap (SpiderDynamic . DynamicHoldIdentity) $ hold v0 $ addIdentity $ unSpiderEvent e
2105+holdIncrementalSpiderEventM :: R.Patch p => a -> R.Event (SpiderEnv x) (p a) -> EventM x (R.Incremental (SpiderEnv x) p a)
2106+holdIncrementalSpiderEventM v0 e = fmap (SpiderIncremental . DynamicHold) $ hold v0 $ unSpiderEvent e
2108+instance R.MonadHold (SpiderEnv x) (SpiderHost x) where
2109+ {-# INLINABLE hold #-}
2110+ hold v0 e = R.runHostFrame $ R.hold v0 e
2111+ {-# INLINABLE holdDyn #-}
2112+ holdDyn v0 e = R.runHostFrame $ R.holdDyn v0 e
2113+ {-# INLINABLE holdIncremental #-}
2114+ holdIncremental v0 e = R.runHostFrame $ R.holdIncremental v0 e
2116+instance R.MonadSample (SpiderEnv x) (SpiderHost x) where
2117+ {-# INLINABLE sample #-}
2118+ sample = runFrame . readBehaviorUntracked . unSpiderBehavior
2120+instance R.MonadSample (SpiderEnv x) (SpiderPullM x) where
2121+ {-# INLINABLE sample #-}
2122+ sample = coerce . readBehaviorTracked . unSpiderBehavior
2124+instance R.MonadSample (SpiderEnv x) (SpiderPushM x) where
2125+ {-# INLINABLE sample #-}
2126+ sample (SpiderBehavior b) = SpiderPushM $ readBehaviorUntracked b
2128+instance R.MonadHold (SpiderEnv x) (SpiderPushM x) where
2129+ {-# INLINABLE hold #-}
2130+ hold v0 e = R.current <$> R.holdDyn v0 e
2131+ {-# INLINABLE holdDyn #-}
2132+ holdDyn v0 (SpiderEvent e) = SpiderPushM $ fmap (SpiderDynamic . DynamicHoldIdentity) $ hold v0 $ addIdentity e
2133+ {-# INLINABLE holdIncremental #-}
2134+ holdIncremental v0 (SpiderEvent e) = SpiderPushM $ SpiderIncremental . DynamicHold <$> hold v0 e
2136+data RootTrigger a = forall k. GCompare k => RootTrigger (SubscriberList a, IORef (DMap k Identity), k a)
2137+newtype SpiderEventHandle a = SpiderEventHandle { unSpiderEventHandle :: EventSubscription a }
2139+instance R.MonadSubscribeEvent (SpiderEnv x) (SpiderHostFrame x) where
2140+ {-# INLINABLE subscribeEvent #-}
2141+ subscribeEvent e = SpiderHostFrame $ do
2142+ subscription <- subscribe (unSpiderEvent e) SubscriberHandle --TODO: Unsubscribe eventually (manually and/or with weak ref)
2143+ return $ SpiderEventHandle subscription
2145+instance R.ReflexHost (SpiderEnv x) where
2146+ type EventTrigger (SpiderEnv x) = RootTrigger
2147+ type EventHandle (SpiderEnv x) = SpiderEventHandle
2148+ type HostFrame (SpiderEnv x) = SpiderHostFrame x
2150+instance R.MonadReadEvent (SpiderEnv x) (ReadPhase x) where
2151+ {-# INLINABLE readEvent #-}
2152+ readEvent h = ReadPhase $ fmap (fmap return) $ liftIO $ do
2153+ let EventSubscription sln subscribed = unSpiderEventHandle h
2154+ result <- readEventSubscribed subscribed
2158+instance MonadRef (EventM x) where
2159+ type Ref (EventM x) = Ref IO
2160+ {-# INLINABLE newRef #-}
2161+ {-# INLINABLE readRef #-}
2162+ {-# INLINABLE writeRef #-}
2163+ newRef = liftIO . newRef
2164+ readRef = liftIO . readRef
2165+ writeRef r a = liftIO $ writeRef r a
2167+instance MonadAtomicRef (EventM x) where
2168+ {-# INLINABLE atomicModifyRef #-}
2169+ atomicModifyRef r f = liftIO $ atomicModifyRef r f
2171+-- | The monad for actions that manipulate a Spider timeline identified by @x@
2172+newtype SpiderHost x a = SpiderHost { unSpiderHost :: ReaderT (SpiderEnv x) IO a } deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2174+instance Monad (SpiderHost x) where
2175+ {-# INLINABLE (>>=) #-}
2176+ SpiderHost x >>= f = SpiderHost $ x >>= unSpiderHost . f
2177+ {-# INLINABLE (>>) #-}
2178+ SpiderHost x >> SpiderHost y = SpiderHost $ x >> y
2179+ {-# INLINABLE return #-}
2180+ return x = SpiderHost $ return x
2181+ {-# INLINABLE fail #-}
2182+ fail s = SpiderHost $ fail s
2184+-- | Run an action affecting the global Spider timeline; this will be guarded by
2185+-- a mutex for that timeline
2186+runSpiderHost :: SpiderHost Global a -> IO a
2187+runSpiderHost (SpiderHost a) = runReaderT a globalSpiderEnv
2189+newtype SpiderHostFrame x a = SpiderHostFrame { runSpiderHostFrame :: EventM x a } deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2191+instance Monad (SpiderHostFrame x) where
2192+ {-# INLINABLE (>>=) #-}
2193+ SpiderHostFrame x >>= f = SpiderHostFrame $ x >>= runSpiderHostFrame . f
2194+ {-# INLINABLE (>>) #-}
2195+ SpiderHostFrame x >> SpiderHostFrame y = SpiderHostFrame $ x >> y
2196+ {-# INLINABLE return #-}
2197+ return x = SpiderHostFrame $ return x
2198+ {-# INLINABLE fail #-}
2199+ fail s = SpiderHostFrame $ fail s
2201+instance R.MonadSample (SpiderEnv x) (SpiderHostFrame x) where
2202+ sample = SpiderHostFrame . readBehaviorUntracked . unSpiderBehavior --TODO: This can cause problems with laziness, so we should get rid of it if we can
2204+addIdentity :: Event a -> Event (Identity a)
2205+--addIdentity = fmap Identity
2206+addIdentity = unsafeCoerce
2208+instance R.MonadHold (SpiderEnv x) (SpiderHostFrame x) where
2209+ {-# INLINABLE hold #-}
2210+ hold v0 e = SpiderHostFrame $ fmap (SpiderBehavior . BehaviorHoldIdentity) $ hold v0 $ addIdentity $ unSpiderEvent e
2211+ {-# INLINABLE holdDyn #-}
2212+ holdDyn v0 e = SpiderHostFrame $ fmap (SpiderDynamic . DynamicHoldIdentity) $ hold v0 $ addIdentity $ unSpiderEvent e
2213+ {-# INLINABLE holdIncremental #-}
2214+ holdIncremental v0 e = SpiderHostFrame $ fmap (SpiderIncremental . DynamicHold) $ hold v0 $ unSpiderEvent e
2216+newEventWithTriggerIO :: forall a. (RootTrigger a -> IO (IO ())) -> IO (Event a)
2217+newEventWithTriggerIO f = do
2218+ es <- newFanEventWithTriggerIO $ \Refl -> f
2219+ return $ select es Refl
2221+newFanEventWithTriggerIO :: GCompare k => (forall a. k a -> RootTrigger a -> IO (IO ())) -> IO (EventSelector k)
2222+newFanEventWithTriggerIO f = do
2223+ occRef <- newIORef DMap.empty
2224+ subscribedRef <- newIORef DMap.empty
2226+ { rootOccurrence = occRef
2227+ , rootSubscribed = subscribedRef
2230+ return $ EventSelector $ \k -> EventRoot k r
2232+instance R.MonadReflexCreateTrigger (SpiderEnv x) (SpiderHost x) where
2233+ newEventWithTrigger = SpiderHost . lift . fmap SpiderEvent . newEventWithTriggerIO
2234+ newFanEventWithTrigger f = SpiderHost $ lift $ do
2235+ es <- newFanEventWithTriggerIO f
2236+ return $ R.EventSelector $ SpiderEvent . select es
2238+instance R.MonadReflexCreateTrigger (SpiderEnv x) (SpiderHostFrame x) where
2239+ newEventWithTrigger = SpiderHostFrame . EventM . liftIO . fmap SpiderEvent . newEventWithTriggerIO
2240+ newFanEventWithTrigger f = SpiderHostFrame $ EventM $ liftIO $ do
2241+ es <- newFanEventWithTriggerIO f
2242+ return $ R.EventSelector $ SpiderEvent . select es
2244+instance R.MonadSubscribeEvent (SpiderEnv x) (SpiderHost x) where
2245+ {-# INLINABLE subscribeEvent #-}
2246+ subscribeEvent = subscribeEventSpiderHost
2248+subscribeEventSpiderHost :: R.Event (SpiderEnv x) a -> SpiderHost x (R.EventHandle (SpiderEnv x) a)
2249+subscribeEventSpiderHost e = do
2250+ subscription <- runFrame $ subscribe (unSpiderEvent e) SubscriberHandle --TODO: Unsubscribe eventually (manually and/or with weak ref)
2251+ return $ SpiderEventHandle subscription
2253+newtype ReadPhase x a = ReadPhase (ResultM x a) deriving (Functor, Applicative, Monad, MonadFix)
2255+instance R.MonadSample (SpiderEnv x) (ReadPhase x) where
2256+ {-# INLINABLE sample #-}
2257+ sample = ReadPhase . R.sample
2259+instance R.MonadHold (SpiderEnv x) (ReadPhase x) where
2260+ {-# INLINABLE hold #-}
2261+ hold v0 e = ReadPhase $ R.hold v0 e
2262+ {-# INLINABLE holdDyn #-}
2263+ holdDyn v0 e = ReadPhase $ R.holdDyn v0 e
2264+ {-# INLINABLE holdIncremental #-}
2265+ holdIncremental v0 e = ReadPhase $ R.holdIncremental v0 e
2267+instance R.MonadReflexHost (SpiderEnv x) (SpiderHost x) where
2268+ type ReadPhase (SpiderHost x) = ReadPhase x
2269+ fireEventsAndRead es (ReadPhase a) = run es a
2270+ runHostFrame = runFrame . runSpiderHostFrame
2272+instance MonadRef (SpiderHost x) where
2273+ type Ref (SpiderHost x) = Ref IO
2274+ newRef = SpiderHost . newRef
2275+ readRef = SpiderHost . readRef
2276+ writeRef r = SpiderHost . writeRef r
2278+instance MonadAtomicRef (SpiderHost x) where
2279+ atomicModifyRef r = SpiderHost . atomicModifyRef r
2281+instance MonadRef (SpiderHostFrame x) where
2282+ type Ref (SpiderHostFrame x) = Ref IO
2283+ newRef = SpiderHostFrame . newRef
2284+ readRef = SpiderHostFrame . readRef
2285+ writeRef r = SpiderHostFrame . writeRef r
2287+instance MonadAtomicRef (SpiderHostFrame x) where
2288+ atomicModifyRef r = SpiderHostFrame . atomicModifyRef r