Rasa.Internal.Action

Documentation

newtype Action a

This is a monad for performing actions against the editor. You can register Actions to be run in response to events using onEveryTrigger

Within an Action you can:

• Use liftIO for IO
• Access/edit extensions that are stored globally, see ext
• Embed any Actions exported other extensions
• Embed buffer actions using bufDo or buffersDo
• Add/Edit/Focus buffers and a few other Editor-level things, see the Rasa.Internal.Actions module.

Constructors

Action

Fields

• getAction :: Free (ActionF ActionState) a

Instances

Monad Action

Methods

(>>=) :: Action a -> (a -> Action b) -> Action b

(>>) :: Action a -> Action b -> Action b

return :: a -> Action a

fail :: String -> Action a

Functor Action

Methods

fmap :: (a -> b) -> Action a -> Action b

(<$) :: a -> Action b -> Action a

Applicative Action

Methods

pure :: a -> Action a

(<*>) :: Action (a -> b) -> Action a -> Action b

(*>) :: Action a -> Action b -> Action b

(<*) :: Action a -> Action b -> Action a

MonadIO Action

Methods

liftIO :: IO a -> Action a

MonadState ActionState Action

Methods

get :: Action ActionState

put :: ActionState -> Action ()

state :: (ActionState -> (a, ActionState)) -> Action a

runAction :: ActionState -> Action a -> IO (a, ActionState)

Runs an Action into an IO

evalAction :: ActionState -> Action a -> IO a

Evals an Action into an IO

execAction :: ActionState -> Action a -> IO ActionState

Execs an Action into an IO

data ActionState

This contains all data representing the editor's state. It acts as the state object for an 'Action

Instances

Show ActionState

Methods

showsPrec :: Int -> ActionState -> ShowS

show :: ActionState -> String

showList :: [ActionState] -> ShowS

HasExts ActionState

Methods

exts :: Lens' ActionState (Map TypeRep Ext)

HasEditor ActionState

Methods

editor :: Lens' ActionState Editor

MonadState ActionState Action

Methods

get :: Action ActionState

put :: ActionState -> Action ()

state :: (ActionState -> (a, ActionState)) -> Action a

mkActionState :: Output (Action ()) -> ActionState

data Listener

A wrapper around event listeners so they can be stored in Listeners.

Constructors

Listener ListenerId (a -> Action ())

data ListenerId

An opaque reverence to a specific registered event-listener. A ListenerId is used only to remove listeners later with removeListener.

Constructors

ListenerId Int TypeRep

Instances

Eq ListenerId

Methods

(==) :: ListenerId -> ListenerId -> Bool

(/=) :: ListenerId -> ListenerId -> Bool

type Listeners = Map TypeRep [Listener]

A map of Event types to a list of listeners for that event

listeners :: Lens' ActionState Listeners

nextListenerId :: Lens' ActionState Int

actionQueue :: Lens' ActionState (Output (Action ()))