Yi.Editor

The top level editor state, and operations on it. This is inside an internal module for easy re-export with Yi.Types bits.

Documentation

data Editor

The Editor state

Constructors

Editor

Fields

• bufferStack :: !(NonEmpty BufferRef)

  Stack of all the buffers. Invariant: first buffer is the current one.

• buffers :: !(Map BufferRef FBuffer)
• refSupply :: !Int

  Supply for buffer, window and tab ids.

• tabs_ :: !(PointedList Tab)

  current tab contains the visible windows pointed list.

• dynamic :: !DynamicState

  dynamic components

• statusLines :: !Statuses
• maxStatusHeight :: !Int
• killring :: !Killring
• currentRegex :: !(Maybe SearchExp)

  currently highlighted regex (also most recent regex for use in vim bindings)

• searchDirection :: !Direction
• pendingEvents :: ![Event]

  Processed events that didn't yield any action yet.

• onCloseActions :: !(Map BufferRef (EditorM ()))

  Actions to be run when the buffer is closed; should be scrapped.

Instances

MonadState Editor EditorM

Methods

get :: EditorM Editor

put :: Editor -> EditorM ()

state :: (Editor -> (a, Editor)) -> EditorM a

MonadState Editor YiM

Methods

get :: YiM Editor

put :: Editor -> YiM ()

state :: (Editor -> (a, Editor)) -> YiM a

data EditorM a

Instances

Monad EditorM

Methods

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

(>>) :: EditorM a -> EditorM b -> EditorM b

return :: a -> EditorM a

fail :: String -> EditorM a

Functor EditorM

Methods

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

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

Applicative EditorM

Methods

pure :: a -> EditorM a

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

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

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

MonadEditor EditorM

Methods

askCfg :: EditorM Config

withEditor :: EditorM a -> EditorM a

withEditor_ :: EditorM a -> EditorM ()

MonadReader Config EditorM

Methods

ask :: EditorM Config

local :: (Config -> Config) -> EditorM a -> EditorM a

reader :: (Config -> a) -> EditorM a

MonadState Editor EditorM

Methods

get :: EditorM Editor

put :: Editor -> EditorM ()

state :: (Editor -> (a, Editor)) -> EditorM a

HookType (EditorM a)

Methods

runHookImpl :: YiConfigVariable var => (var -> EditorM a) -> EditorM a

YiAction (EditorM x) x

Methods

makeAction :: EditorM x -> Action

class (Monad m, MonadState Editor m) => MonadEditor m where

Minimal complete definition

askCfg

Methods

askCfg :: m Config

withEditor :: EditorM a -> m a

withEditor_ :: EditorM a -> m ()

Instances

MonadEditor EditorM

Methods

askCfg :: EditorM Config

withEditor :: EditorM a -> EditorM a

withEditor_ :: EditorM a -> EditorM ()

MonadEditor YiM

Methods

askCfg :: YiM Config

withEditor :: EditorM a -> YiM a

withEditor_ :: EditorM a -> YiM ()

runEditor :: Config -> EditorM a -> Editor -> (Editor, a)

acceptedInputsOtherWindow :: EditorM ()

Shows the current key bindings in a new window

addJumpAtE :: Point -> EditorM ()

addJumpHereE :: EditorM ()

alternateBufferE :: Int -> EditorM ()

askConfigVariableA :: (YiConfigVariable b, MonadEditor m) => m b

bufferSet :: Editor -> [FBuffer]

Return the buffers we have, in no particular order

buffersA :: Lens' Editor (Map BufferRef FBuffer)

closeBufferAndWindowE :: EditorM ()

Close current buffer and window, unless it's the last one.

closeBufferE :: Text -> EditorM ()

Close a buffer. Note: close the current buffer if the empty string is given

closeOtherE :: EditorM ()

Make the current window the only window on the screen

clrStatus :: EditorM ()

Clear the status line

commonNamePrefix :: Editor -> [FilePath]

Return a prefix that can be removed from all buffer paths while keeping them unique.

currentBuffer :: Editor -> BufferRef

Return the current buffer

currentRegexA :: Lens' Editor (Maybe SearchExp)

currentWindowA :: Lens' Editor Window

deleteBuffer :: MonadEditor m => BufferRef -> m ()

Delete a buffer (and release resources associated with it).

deleteTabE :: EditorM ()

Deletes the current tab. If there is only one tab open then error out. When the last tab is focused, move focus to the left, otherwise move focus to the right.

emptyEditor :: Editor

The initial state

findBuffer :: MonadEditor m => BufferRef -> m (Maybe FBuffer)

findBufferWith :: BufferRef -> Editor -> FBuffer

Find buffer with this key

findBufferWithName :: Text -> Editor -> [BufferRef]

Find buffers with this name

findWindowWith :: WindowRef -> Editor -> Window

focusWindowE :: WindowRef -> EditorM ()

bring the editor focus the window with the given key.

Fails if no window with the given key is found.

getBufferStack :: MonadEditor m => m (NonEmpty FBuffer)

getBufferWithName :: MonadEditor m => Text -> m BufferRef

Find buffer with given name. Fail if not found.

getBufferWithNameOrCurrent :: MonadEditor m => Text -> m BufferRef

getEditorDyn :: (MonadEditor m, YiVariable a, Default a, Functor m) => m a

Dynamically-extensible state components.

These hooks are used by keymaps to store values that result from Actions (i.e. that restult from IO), as opposed to the pure values they generate themselves, and can be stored internally.

The dynamic field is a type-indexed map.

Retrieve a value from the extensible state

getRegE :: EditorM YiString

Return the contents of the yank register

jumpBackE :: EditorM ()

jumpForwardE :: EditorM ()

killringA :: Lens' Editor Killring

layoutManagerNextVariantE :: EditorM ()

Next variant of the current layout manager, as given by nextVariant

layoutManagerPreviousVariantE :: EditorM ()

Previous variant of the current layout manager, as given by previousVariant

layoutManagersNextE :: EditorM ()

Cycle to the next layout manager, or the first one if the current one is nonstandard.

layoutManagersPreviousE :: EditorM ()

Cycle to the previous layout manager, or the first one if the current one is nonstandard.

layoutManagersPrintMsgE :: EditorM ()

Prints the description of the current layout manager in the status bar

maxStatusHeightA :: Lens' Editor Int

moveTabE :: Maybe Int -> EditorM ()

Moves the focused tab to the given index, or to the end if the index is not specified.

moveWinNextE :: EditorM ()

Swap focused window with the next one

moveWinPrevE :: EditorM ()

Swap focused window with the previous one

newBufferE

Arguments

:: BufferId

buffer name

-> YiString

buffer contents

-> EditorM BufferRef

Like fnewE, create a new buffer filled with the String s, Switch the current window to this buffer. Doesn't associate any file with the buffer (unlike fnewE) and so is good for popup internal buffers (like scratch)

newEmptyBufferE :: BufferId -> EditorM BufferRef

Like newBufferE but defaults to empty contents.

newTabE :: EditorM ()

Creates a new tab containing a window that views the current buffer.

newTempBufferE :: EditorM BufferRef

Creates an in-memory buffer with a unique name.

newWindowE :: Bool -> BufferRef -> EditorM Window

Create a new window onto the given buffer.

nextTabE :: EditorM ()

Moves to the next tab in the round robin set of tabs

nextWinE :: EditorM ()

Rotate focus to the next window

onCloseActionsA :: Lens' Editor (Map BufferRef (EditorM ()))

pendingEventsA :: Lens' Editor [Event]

prevWinE :: EditorM ()

Rotate focus to the previous window

previousTabE :: EditorM ()

Moves to the previous tab in the round robin set of tabs

printMsg :: MonadEditor m => Text -> m ()

Prints a message with defaultStyle.

printMsgs :: MonadEditor m => [Text] -> m ()

Prints a all given messages with defaultStyle.

printStatus :: MonadEditor m => Status -> m ()

pushWinToFirstE :: EditorM ()

Moves the focused window to the first window, and moves all other windows down the stack.

putEditorDyn :: (MonadEditor m, YiVariable a, Functor m) => a -> m ()

Insert a value into the extensible state, keyed by its type

searchDirectionA :: Lens' Editor Direction

setDividerPosE :: DividerRef -> DividerPosition -> EditorM ()

Sets the given divider position on the current tab

setRegE :: YiString -> EditorM ()

Put string into yank register

setStatus :: MonadEditor m => Status -> m ()

Set the "background" status line

shiftOtherWindow :: MonadEditor m => m ()

Switch focus to some other window. If none is available, create one.

splitE :: EditorM ()

Split the current window, opening a second window onto current buffer. TODO: unfold newWindowE here?

statusLine :: Editor -> [Text]

statusLineInfo :: Editor -> Status

statusLinesA :: Lens' Editor Statuses

stringToNewBuffer

Arguments

:: MonadEditor m

=> BufferId

The buffer indentifier

-> YiString

The contents with which to populate the buffer

-> m BufferRef

Create and fill a new buffer, using contents of string. | Does not focus the window, or make it the current window. | Call newWindowE or switchToBufferE to take care of that.

swapWinWithFirstE :: EditorM ()

Swaps the focused window with the first window. Useful for layouts such as HPairOneStack, for which the first window is the largest.

switchToBufferE :: BufferRef -> EditorM ()

Attach the specified buffer to the current window

switchToBufferWithNameE :: Text -> EditorM ()

Switch to the buffer specified as parameter. If the buffer name is empty, switch to the next buffer.

tabsA :: Lens' Editor (PointedList Tab)

tryCloseE :: EditorM ()

Close the current window. If there is only one tab open and the tab contains only one window then do nothing.

windows :: Editor -> PointedList Window

windowsA :: Lens' Editor (PointedList Window)

windowsOnBufferE :: BufferRef -> EditorM [Window]

Return the windows that are currently open on the buffer whose key is given

withCurrentBuffer :: MonadEditor m => BufferM a -> m a

Perform action with current window's buffer

withEveryBuffer :: MonadEditor m => BufferM a -> m [a]

withGivenBuffer :: MonadEditor m => BufferRef -> BufferM a -> m a

Perform action with any given buffer, using the last window that was used for that buffer.

withGivenBufferAndWindow :: MonadEditor m => Window -> BufferRef -> BufferM a -> m a

Perform action with any given buffer

withOtherWindow :: MonadEditor m => m a -> m a

Execute the argument in the context of an other window. Create one if necessary. The current window is re-focused after the argument has completed.

withWindowE :: Window -> BufferM a -> EditorM a

Orphan instances

Binary Editor

Methods

put :: Editor -> Put

get :: Get Editor

putList :: [Editor] -> Put