Rasa.Internal.Action

Documentation

data Hook

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

Constructors

Hook HookId (a -> Action ())

data HookId

Constructors

HookId Int TypeRep

Instances

Eq HookId

Methods

(==) :: HookId -> HookId -> Bool

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

type Hooks = Map TypeRep [Hook]

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

newtype Action a

This is a monad-transformer stack for performing actions against the editor. You 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 Directive module.

Constructors

Action

Fields

• runAct :: StateT ActionState IO 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

execAction :: ActionState -> Action () -> IO ActionState

Execute an Action (returning the editor state)

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

Evaluate an Action (returning the value)

type AsyncAction = Async (Action ())

data ActionState

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

Constructors

ActionState

Fields

• _ed :: Editor
• _asyncs :: [AsyncAction]
• _hooks :: Hooks
• _nextHook :: Int

Instances

Show ActionState

Methods

showsPrec :: Int -> ActionState -> ShowS

show :: ActionState -> String

showList :: [ActionState] -> ShowS

Default ActionState

Methods

def :: ActionState

HasEditor ActionState

Methods

editor :: Lens' ActionState Editor

HasActionState ActionState

Methods

actionState :: Lens' ActionState ActionState

MonadState ActionState Action

Methods

get :: Action ActionState

put :: ActionState -> Action ()

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

nextHook :: Lens' ActionState Int

hooks :: Lens' ActionState Hooks

ed :: Lens' ActionState Editor

asyncs :: Lens' ActionState [AsyncAction]

class HasActionState a where

Allows polymorphic lenses which need to access something in ActionState

Minimal complete definition

actionState

Methods

actionState :: Lens' a ActionState

Instances

HasActionState ActionState

Methods

actionState :: Lens' ActionState ActionState

HasActionState BufActionState

Methods

actionState :: Lens' BufActionState ActionState

data BufActionState

Contains all data about the editor; as well as a buffer which is in focus. We keep the full ActionState here too so that Actions may be lifted inside a BufAction

Constructors

BufActionState

Fields

• _actState :: ActionState
• _buf :: Buffer

Instances

HasBuffer BufActionState

Methods

buffer :: Lens' BufActionState Buffer

HasActionState BufActionState

Methods

actionState :: Lens' BufActionState ActionState

MonadState BufActionState BufAction

Methods

get :: BufAction BufActionState

put :: BufActionState -> BufAction ()

state :: (BufActionState -> (a, BufActionState)) -> BufAction a

buf :: Lens' BufActionState Buffer

actState :: Lens' BufActionState ActionState

newtype BufAction a

This is a monad-transformer stack for performing actions on a specific buffer. You run BufActions by embedding them in a Action via bufferDo or buffersDo

Within a BufAction you can:

• Use liftAction to run an Action; It is your responsibility to ensure that any nested Actions don't edit the Buffer which the current BufAction is editing; behaviour is undefined if this occurs.
• Use liftIO for IO
• Access/Edit the buffer's text
• Access/edit buffer extensions; see bufExt
• Embed and sequence BufActions from other extensions

Constructors

BufAction

Fields

• runBufAct :: StateT BufActionState IO a

Instances

Monad BufAction

Methods

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

(>>) :: BufAction a -> BufAction b -> BufAction b

return :: a -> BufAction a

fail :: String -> BufAction a

Functor BufAction

Methods

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

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

Applicative BufAction

Methods

pure :: a -> BufAction a

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

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

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

MonadIO BufAction

Methods

liftIO :: IO a -> BufAction a

MonadState BufActionState BufAction

Methods

get :: BufAction BufActionState

put :: BufActionState -> BufAction ()

state :: (BufActionState -> (a, BufActionState)) -> BufAction a

liftBuf :: BufAction a -> BufRef -> Action (Maybe a)

This lifts up a bufAction into an Action which performs the BufAction over the referenced buffer and returns the result (if the buffer existed)

liftAction :: Action a -> BufAction a

This lifts up an Action to be run inside a BufAction

it is your responsibility to ensure that any nested Actions don't edit the Buffer which the current BufAction is editing; behaviour is undefined if this occurs.