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