yi-core-0.19.2: Yi editor core library
Safe HaskellNone
  • ScopedTypeVariables
  • OverloadedStrings
  • RecursiveDo
  • RankNTypes
  • ExplicitForAll
  • LambdaCase



The core actions of Yi. This module is the link between the editor and the UI. Key bindings, and libraries should manipulate Yi through the interface defined here.


Construction and destruction

startEditor :: Config -> Maybe Editor -> IO () Source #

Start up the editor, setting any state with the user preferences and file names passed in, and turning on the UI

quitEditor :: YiM () Source #


quitEditorWithExitCode :: ExitCode -> YiM () Source #

Quit with an exit code. (This is used to implement vim's :cq command)

User interaction

suspendEditor :: YiM () Source #

Suspend the program

Global editor actions

errorEditor :: Text -> YiM () Source #

Show an error on the status line and log it.

closeWindow :: YiM () Source #

Close the current window. If this is the last window open, quit the program.

CONSIDER: call quitEditor when there are no other window in the interactive function. (Not possible since the windowset type disallows it -- should it be relaxed?)

closeWindowEmacs :: YiM () Source #

This is a like closeWindow but with emacs behaviour of C-x 0: if we're trying to close the minibuffer or last buffer in the editor, then just print a message warning the user about it rather closing mini or quitting editor.

Interacting with external commands

runProcessWithInput :: String -> String -> YiM String Source #

Pipe a string through an external command, returning the stdout chomp any trailing newline (is this desirable?)

Todo: varients with marks?

startSubprocess :: FilePath -> [String] -> (Either SomeException ExitCode -> YiM x) -> YiM BufferRef Source #

Start a subprocess with the given command and arguments.


withSyntax :: (Show x, YiAction a x) => (forall syntax. Mode syntax -> syntax -> a) -> YiM () Source #

onYiVar :: (Yi -> YiVar -> IO (YiVar, a)) -> YiM a Source #