Reflex.Host.Class

Documentation

class (Reflex t, MonadReflexCreateTrigger t (HostFrame t), MonadSample t (HostFrame t), MonadHold t (HostFrame t), MonadFix (HostFrame t), MonadSubscribeEvent t (HostFrame t)) => ReflexHost t

Framework implementation support class for the reflex implementation represented by t.

Associated Types

type EventTrigger t :: * -> *

type EventHandle t :: * -> *

type HostFrame t :: * -> *

Instances

ReflexHost Spider

class (Reflex t, Monad m) => MonadSubscribeEvent t m | m -> t where

Monad in which Events can be subscribed. This forces all underlying event sources to be initialized, so that the event will fire whenever it ought to. Events must be subscribed before they are read using readEvent

Methods

subscribeEvent :: Event t a -> m (EventHandle t a)

Subscribe to an event and set it up if needed.

This function will create a new EventHandle from an Event. This handle may then be used via readEvent in the read callback of fireEventsAndRead.

If the event wasn't subscribed to before (either manually or through a dependent event or behavior) then this function will cause the event and all dependencies of this event to be set up. For example, if the event was created by newEventWithTrigger, then it's callback will be executed.

It's safe to call this function multiple times.

Instances

MonadSubscribeEvent Spider SpiderHostFrame

MonadSubscribeEvent Spider SpiderHost

MonadSubscribeEvent t m => MonadSubscribeEvent t (ExceptT r m)

MonadSubscribeEvent t m => MonadSubscribeEvent t (ContT r m)

MonadSubscribeEvent t m => MonadSubscribeEvent t (StateT r m)

MonadSubscribeEvent t m => MonadSubscribeEvent t (StateT r m)

(MonadSubscribeEvent t m, Monoid w) => MonadSubscribeEvent t (WriterT w m)

MonadSubscribeEvent t m => MonadSubscribeEvent t (ReaderT r m)

(MonadSubscribeEvent t m, Monoid w) => MonadSubscribeEvent t (RWST r w s m)

class (ReflexHost t, Applicative m, Monad m) => MonadReadEvent t m | m -> t where

Monad that allows to read events' values.

Methods

readEvent :: EventHandle t a -> m (Maybe (m a))

Read the value of an Event from an EventHandle (created by calling subscribeEvent).

After event propagation is done, all events can be in two states: either they are firing with some value or they are not firing. In the former case, this function returns Just act, where act in an action to read the current value of the event. In the latter case, the function returns Nothing.

This function is normally used in the calllback for fireEventsAndRead.

Instances

MonadReadEvent Spider ReadPhase

class (Applicative m, Monad m) => MonadReflexCreateTrigger t m | m -> t where

A monad where new events feed from external sources can be created.

Methods

newEventWithTrigger :: (EventTrigger t a -> IO (IO ())) -> m (Event t a)

Creates a root Event (one that is not based on any other event).

When a subscriber first subscribes to an event (building another event that depends on the subscription) the given callback function is run and passed a trigger. The callback function can then set up the event source in IO. After this is done, the callback function must return an accompanying teardown action.

Any time between setup and teardown the trigger can be used to fire the event, by passing it to fireEventsAndRead.

Note: An event may be set up multiple times. So after the teardown action is executed, the event may still be set up again in the future.

newFanEventWithTrigger :: GCompare k => (forall a. k a -> EventTrigger t a -> IO (IO ())) -> m (EventSelector t k)

Instances

MonadReflexCreateTrigger Spider SpiderHostFrame

MonadReflexCreateTrigger Spider SpiderHost

MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (ExceptT e m)

MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (ContT r m)

MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (StateT s m)

MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (StateT s m)

(MonadReflexCreateTrigger t m, Monoid w) => MonadReflexCreateTrigger t (WriterT w m)

MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (ReaderT r m)

(MonadReflexCreateTrigger t m, Monoid w) => MonadReflexCreateTrigger t (RWST r w s m)

class (ReflexHost t, MonadReflexCreateTrigger t m, MonadSubscribeEvent t m, MonadReadEvent t (ReadPhase m), MonadSample t (ReadPhase m), MonadHold t (ReadPhase m)) => MonadReflexHost t m | m -> t where

Associated Types

type ReadPhase m :: * -> *

Methods

fireEventsAndRead :: [DSum (EventTrigger t) Identity] -> ReadPhase m a -> m a

Propagate some events firings and read the values of events afterwards.

This function will create a new frame to fire the given events. It will then update all dependent events and behaviors. After that is done, the given callback is executed which allows to read the final values of events and check whether they have fired in this frame or not.

All events that are given are fired at the same time.

This function is typically used in the main loop of a reflex framework implementation. The main loop waits for external events to happen (such as keyboard input or a mouse click) and then fires the corresponding events using this function. The read callback can be used to read output events and perform a corresponding response action to the external event.

runHostFrame :: HostFrame t a -> m a

Run a frame without any events firing.

This function should be used when you want to use sample and hold when no events are currently firing. Using this function in that case can improve performance, since the implementation can assume that no events are firing when sample or hold are called.

This function is commonly used to set up the basic event network when the application starts up.

Instances

MonadReflexHost Spider SpiderHost

MonadReflexHost t m => MonadReflexHost t (ExceptT e m)

MonadReflexHost t m => MonadReflexHost t (ContT r m)

MonadReflexHost t m => MonadReflexHost t (StateT s m)

MonadReflexHost t m => MonadReflexHost t (StateT s m)

(MonadReflexHost t m, Monoid w) => MonadReflexHost t (WriterT w m)

MonadReflexHost t m => MonadReflexHost t (ReaderT r m)

(MonadReflexHost t m, Monoid w) => MonadReflexHost t (RWST r w s m)

fireEvents :: MonadReflexHost t m => [DSum (EventTrigger t) Identity] -> m ()

Like fireEventsAndRead, but without reading any events.

newEventWithTriggerRef :: (MonadReflexCreateTrigger t m, MonadRef m, Ref m ~ Ref IO) => m (Event t a, Ref m (Maybe (EventTrigger t a)))

Create a new event and store its trigger in an IORef while it's active.

An event is only active between the set up (when it's first subscribed to) and the teardown phases (when noboby is subscribing the event anymore). This function returns an Event and an IORef. As long as the event is active, the IORef will contain Just the event trigger to trigger this event. When the event is not active, the IORef will contain Nothing. This allows event sources to be more efficient, since they don't need to produce events when nobody is listening.

fireEventRef :: (MonadReflexHost t m, MonadRef m, Ref m ~ Ref IO) => Ref m (Maybe (EventTrigger t a)) -> a -> m ()

fireEventRefAndRead :: (MonadReflexHost t m, MonadRef m, Ref m ~ Ref IO) => Ref m (Maybe (EventTrigger t a)) -> a -> EventHandle t b -> m (Maybe b)