Rasa.Internal.Directive

Performing Actions on Buffers

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

This lifts a BufAction to an Action which performs the BufAction on the buffer referred to by the BufRef If the buffer referred to no longer exists this returns Action Nothing.

bufDo_ :: BufRef -> BufAction a -> Action ()

buffersDo :: BufAction a -> Action [a]

This lifts a BufAction to an Action which performs the BufAction on every buffer and collects the return values as a list.

buffersDo_ :: BufAction a -> Action ()

Editor Actions

exit :: Action ()

This signals to the editor that you'd like to shutdown. The current events will finish processing, then the onExit hook will run, then the editor will exit.

newBuffer :: YiString -> Action BufRef

This adds a new buffer with the given text.

getBufRefs :: Action [BufRef]

Returns an up-to-date list of all BufRefs

getBuffers :: Action [(BufRef, Buffer)]

Returns an up-to-date list of all Buffers, returned values are read-only; altering them has no effect on the actual stored buffers. This function is useful for renderers.

getBuffer :: BufRef -> Action (Maybe Buffer)

Returns the Buffer for a BufRef if it still exists. This is read-only; altering the buffer has no effect on the stored buffer. This function is useful for renderers.

nextBufRef :: BufRef -> Action BufRef

Gets BufRef that comes after the one provided

prevBufRef :: BufRef -> Action BufRef

Gets BufRef that comes before the one provided

Buffer Actions

overRange :: Range -> (YiString -> YiString) -> BufAction ()

Runs the given function over the text in the range, replacing it with the results.

replaceRange :: Range -> YiString -> BufAction ()

Replaces the text in the given range from the buffer.

deleteRange :: Range -> BufAction ()

Deletes the text in the given range from the buffer.

insertAt :: Coord -> YiString -> BufAction ()

Inserts text into the buffer at the given Coord.

sizeOf :: YiString -> Coord

Returns the number of rows and columns that a chunk of text spans as a Coord