Rasa.Internal.BufActions

Documentation

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

Runs function over given range of text

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

Replaces the text in the given range with the given text.

deleteRange :: CrdRange -> 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

getLineRange :: Row -> BufAction (Maybe CrdRange)

Gets the range representing a given row (if that row exists)

Performing Apps on Buffers

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

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

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

buffersDo :: BufAction a -> App [a]

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

buffersDo_ :: BufAction a -> App ()

Editor Apps

getBufRefs :: App [BufRef]

Returns an up-to-date list of all BufRefs

nextBufRef :: BufRef -> App BufRef

Gets BufRef that comes after the one provided

prevBufRef :: BufRef -> App BufRef

Gets BufRef that comes before the one provided

getBufExt :: (Typeable s, Show s, Default s) => BufAction s

Retrieve some buffer extension state

setBufExt :: (Typeable s, Show s, Default s) => s -> BufAction ()

Set some buffer extension state

overBufExt :: (Typeable s, Show s, Default s) => (s -> s) -> BufAction ()

Set some buffer extension state

getBufRef :: BufAction BufRef

Gets the current buffer's BufRef

getRange :: CrdRange -> BufAction YiString

Gets the range of text from the buffer

addBuffer :: YiString -> App BufRef

Adds a new buffer and returns the BufRef

getBuffer :: BufRef -> App (Maybe Buffer)

Retrieve a buffer. This is read-only for loggingrenderingdebugging purposes only.

dispatchBufEvent :: (Monoid result, Typeable eventType, Typeable result) => eventType -> BufAction result

Dispatches an event of any type to the BufAction's buffer. See dispatchEvent

addBufListener :: (Typeable eventType, Typeable result, Monoid result) => (eventType -> BufAction result) -> BufAction ListenerId

Adds a listener to the BufAction's buffer. See addListener

addBufListener_ :: (Typeable eventType, Typeable result, Monoid result) => (eventType -> BufAction result) -> BufAction ()

removeBufListener :: ListenerId -> BufAction ()

Removes a listener from the BufAction's buffer. See removeListener

onBufAdded :: (BufAdded -> App result) -> App ListenerId

Registers an action to be performed after a new buffer is added.

The supplied function will be called with a BufRef to the new buffer, and the resulting App will be run.

onBufAdded_ :: (BufAdded -> App result) -> App ()

dispatchBufAdded :: BufAdded -> App ()

Dispatch the BufAdded action.

onEveryNewBuffer :: BufAction a -> App ListenerId

Run the given BufAction over all new buffers

onEveryNewBuffer_ :: BufAction a -> App ()

onBufTextChanged :: (BufTextChanged -> BufAction result) -> BufAction ListenerId

This is fired every time text in a buffer changes.

The range of text which was altered and the new value of that text are provided inside a BufTextChanged event.

dispatchBufTextChanged :: BufTextChanged -> BufAction ()

Dispatch the BufBufTextChanged action.

getText :: BufAction YiString

Returns the text of the current buffer