yi-0.6.2.3: The Haskell-Scriptable Editor Source code Contents Index

Yi.Keymap

Synopsis

data Action = forall a . Show a => YiA (YiM a) | forall a . Show a => EditorA (EditorM a) | forall a . Show a => BufferA (BufferM a) | TaggedA String 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 Yi = Yi { yiUi :: UI input :: Event -> IO () output :: [Action] -> IO () yiConfig :: Config yiVar :: MVar YiVar } data YiVar = YiVar { yiEditor :: !Editor threads :: ![ThreadId] yiSubprocessIdSupply :: !SubprocessId yiSubprocesses :: !(Map SubprocessId SubprocessInfo) } newtype YiM a = YiM { runYiM :: ReaderT Yi IO a } write :: (MonadInteract m Action ev, YiAction a x, Show x) => a -> m () withUI :: (UI -> IO a) -> YiM a unsafeWithEditor :: Config -> MVar YiVar -> EditorM a -> IO a withGivenBuffer :: BufferRef -> BufferM a -> YiM a withBuffer :: BufferM a -> YiM a readEditor :: (Editor -> a) -> YiM a catchDynE :: Typeable exception => YiM a -> (exception -> YiM a) -> YiM a catchJustE :: (Exception -> Maybe b) -> YiM a -> (b -> YiM a) -> YiM a handleJustE :: (Exception -> Maybe b) -> (b -> YiM a) -> YiM a -> YiM a shutdown :: YiM () class YiAction a x | a -> x where makeAction :: Show x => a -> Action data KeymapSet = KeymapSet { topKeymap :: Keymap startInsertKeymap :: Keymap insertKeymap :: Keymap startTopKeymap :: Keymap } startTopKeymapA :: T KeymapSet Keymap insertKeymapA :: T KeymapSet Keymap startInsertKeymapA :: T KeymapSet Keymap topKeymapA :: T KeymapSet Keymap extractTopKeymap :: KeymapSet -> Keymap modelessKeymapSet :: Keymap -> KeymapSet

Documentation

data Action Source

Constructors forall a . Show a => YiA (YiM a) forall a . Show a => EditorA (EditorM a) forall a . Show a => BufferA (BufferM a) TaggedA String Action Instances Show Action Typeable Action PEq Action YiAction Action ()

emptyAction :: Action Source

type Interact ev a = I ev Action a Source

type KeymapM a = Interact Event a Source

type Keymap = KeymapM () Source

type KeymapEndo = Keymap -> Keymap Source

type KeymapProcess = P Event Action Source

data Yi Source

Constructors Yi yiUi :: UI input :: Event -> IO () input stream output :: [Action] -> IO () output stream yiConfig :: Config yiVar :: MVar YiVar The only mutable state in the program Instances Typeable Yi MonadReader Yi YiM

data YiVar Source

Constructors YiVar yiEditor :: !Editor threads :: ![ThreadId] all our threads yiSubprocessIdSupply :: !SubprocessId yiSubprocesses :: !(Map SubprocessId SubprocessInfo)

newtype YiM a Source

The type of user-bindable functions Constructors YiM runYiM :: ReaderT Yi IO a Instances Monad YiM Functor YiM Typeable1 YiM MonadIO YiM MonadEditor YiM MonadReader Yi YiM MonadState Editor YiM YiAction (YiM x) x

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

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

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

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

withGivenBuffer :: BufferRef -> BufferM a -> YiM a Source

withBuffer :: BufferM a -> YiM a Source

readEditor :: (Editor -> a) -> YiM a Source

catchDynE :: Typeable exception => YiM a -> (exception -> YiM a) -> YiM a Source

catchJustE Source

:: Exception -> Maybe b Predicate to select exceptions -> YiM a Computation to run -> b -> YiM a Handler -> YiM a

handleJustE :: (Exception -> Maybe b) -> (b -> YiM a) -> YiM a -> YiM a Source

shutdown :: YiM () Source

Shut down all of our threads. Should free buffers etc.

class YiAction a x | a -> x where Source

Methods makeAction :: Show x => a -> Action Source Instances YiAction Action () YiAction (IO x) x YiAction (BufferM x) x YiAction (EditorM x) x YiAction (YiM x) x (YiAction a x, Promptable r) => YiAction (r -> a) x

data KeymapSet Source

Constructors KeymapSet topKeymap :: Keymap Content of the top-level loop. startInsertKeymap :: Keymap Startup when entering insert mode insertKeymap :: Keymap For insertion-only modes startTopKeymap :: Keymap Startup bit, to execute only once at the beginning.

startTopKeymapA :: T KeymapSet Keymap Source

insertKeymapA :: T KeymapSet Keymap Source

startInsertKeymapA :: T KeymapSet Keymap Source

topKeymapA :: T KeymapSet Keymap Source

extractTopKeymap :: KeymapSet -> Keymap Source

modelessKeymapSet :: Keymap -> KeymapSet Source

Produced by Haddock version 2.6.1