Yi.Keymap

Keymap, YiM and Actions.

Documentation

data Action

Constructors

forall a . Show a => YiA (YiM a)

forall a . Show a => EditorA (EditorM a)

forall a . Show a => BufferA (BufferM a)

Instances

Eq Action

Show Action

Typeable Action

YiAction Action ()

emptyAction :: Action

type Interact ev a = I ev Action a

type KeymapM a = Interact Event a

type Keymap = KeymapM ()

type KeymapEndo = Keymap -> Keymap

type KeymapProcess = P Event Action

data KeymapSet

Constructors

KeymapSet

Fields

topKeymap :: Keymap

Content of the top-level loop.

insertKeymap :: Keymap

For insertion-only modes

topKeymapA :: Lens' KeymapSet Keymap

insertKeymapA :: Lens' KeymapSet Keymap

extractTopKeymap :: KeymapSet -> Keymap

modelessKeymapSet :: Keymap -> KeymapSet

newtype YiM a

The type of user-bindable functions TODO: doc how these are actually user-bindable are they?

Constructors

YiM

Fields

runYiM :: ReaderT Yi IO a

Instances

Monad YiM

Functor YiM

Typeable1 YiM

Applicative YiM

MonadEditor YiM

MonadReader Yi YiM

MonadState Editor YiM

MonadBase IO YiM

HookType (YiM a)

YiAction (YiM x) x

withUI :: (UI Editor -> IO a) -> YiM a

unsafeWithEditor :: Config -> MVar YiVar -> EditorM a -> IO a

readEditor :: MonadEditor m => (Editor -> a) -> m a

catchDynE :: Exception exception => YiM a -> (exception -> YiM a) -> YiM a

catchJustE

Arguments

:: Exception e

=> (e -> Maybe b)

Predicate to select exceptions

-> YiM a

Computation to run

-> (b -> YiM a)

Handler

-> YiM a

handleJustE :: Exception e => (e -> Maybe b) -> (b -> YiM a) -> YiM a -> YiM a

class YiAction a x | a -> x where

Methods

makeAction :: Show x => a -> Action

Instances

YiAction Action ()

YiAction (IO x) x

YiAction (EditorM x) x

YiAction (BufferM x) x

YiAction (YiM x) x

(YiAction a x, Promptable r) => YiAction (r -> a) x

data Yi

Constructors

Yi

Fields

yiUi :: UI Editor

yiInput :: [Event] -> IO ()

input stream

yiOutput :: IsRefreshNeeded -> [Action] -> IO ()

output stream

yiConfig :: Config

yiVar :: MVar YiVar

The only mutable state in the program

Instances

Typeable Yi

MonadReader Yi YiM

data IsRefreshNeeded

Constructors

MustRefresh

NoNeedToRefresh

Instances

Eq IsRefreshNeeded

Show IsRefreshNeeded

data YiVar

Constructors

YiVar

Fields

yiEditor :: !Editor

yiSubprocessIdSupply :: !SubprocessId

yiSubprocesses :: !(Map SubprocessId SubprocessInfo)

write :: (MonadInteract m Action ev, YiAction a x, Show x) => a -> m ()

write a returns a keymap that just outputs the action a.

withModeY :: (forall syntax. Mode syntax -> YiM ()) -> YiM ()

withModeY f runs f on the current buffer's mode. As this runs in the YiM monad, we're able to do more than with just withModeB such as prompt the user for something before running the action.

Lenses

yiSubprocessesA :: Lens' YiVar (Map SubprocessId SubprocessInfo)

yiEditorA :: Lens' YiVar Editor

yiSubprocessIdSupplyA :: Lens' YiVar SubprocessId

yiConfigA :: Lens' Yi Config

yiInputA :: Lens' Yi ([Event] -> IO ())

yiOutputA :: Lens' Yi (IsRefreshNeeded -> [Action] -> IO ())

yiUiA :: Lens' Yi (UI Editor)

yiVarA :: Lens' Yi (MVar YiVar)