Yi.Buffer.HighLevel

High level operations on buffers.

Documentation

atEof :: BufferM Bool

True if point at end of file

atEol :: BufferM Bool

Return true if the current point is the end of a line

atLastLine :: BufferM Bool

True if point at the last line

atSol :: BufferM Bool

Return true if the current point is the start of a line

bdeleteB :: BufferM ()

Delete one character backward

bdeleteLineB :: BufferM ()

Delete backward to the sof or the new line character

bkillWordB :: BufferM ()

Delete backward whitespace or non-whitespace depending on the character before point.

botB :: BufferM ()

Move cursor to end of buffer

bufInfoB :: BufferM BufferFileInfo

File info, size in chars, line no, col num, char num, percent

data BufferFileInfo

Constructors

BufferFileInfo

Fields

bufInfoFileName :: FilePath

bufInfoSize :: Int

bufInfoLineNo :: Int

bufInfoColNo :: Int

bufInfoCharNo :: Point

bufInfoPercent :: Text

bufInfoModified :: Bool

capitaliseWordB :: BufferM ()

capitalise the first letter of this word

deleteBlankLinesB :: BufferM ()

deleteHorizontalSpaceB :: Maybe Int -> BufferM ()

emacs' delete-horizontal-space with the optional argument.

deleteRegionWithStyleB :: Region -> RegionStyle -> BufferM Point

deleteToEol :: BufferM ()

Delete to the end of line, excluding it.

deleteTrailingSpaceB :: BufferM ()

Delete trailing whitespace from all lines. Uses savingPositionB to get back to where it was.

downFromTosB :: Int -> BufferM ()

Move to n lines down from top of screen

downScreenB :: BufferM ()

Scroll down 1 screen

downScreensB :: Int -> BufferM ()

exchangePointAndMarkB :: BufferM ()

Exchange point & mark.

fillParagraph :: BufferM ()

findMatchingPairB :: BufferM ()

firstNonSpaceB :: BufferM ()

Move to first non-space character in this line

flipRectangleB :: Point -> Point -> BufferM (Point, Point)

getBookmarkB :: String -> BufferM Mark

getLineAndCol :: BufferM (Int, Int)

Get the current line and column number

getLineAndColOfPoint :: Point -> BufferM (Int, Int)

getNextLineB :: Direction -> BufferM YiString

The same as getMaybeNextLineB but avoids the use of the Maybe type in the return by returning the empty string if there is no next line.

getNextNonBlankLineB :: Direction -> BufferM YiString

Returns the closest line to the current line which is non-blank, in the given direction. Returns the empty string if there is no such line (for example if we are on the top line already).

getRawestSelectRegionB :: BufferM Region

Return the region between point and mark

getSelectionMarkPointB :: BufferM Point

Get the current buffer selection mark

getSelectRegionB :: BufferM Region

Get the current region boundaries. Extended to the current selection unit.

gotoCharacterB :: Char -> Direction -> RegionStyle -> Bool -> BufferM ()

hasWhiteSpaceBefore :: BufferM Bool

incrementNextNumberByB :: Int -> BufferM ()

Increase (or decrease if negative) next number on line by n.

insertRopeWithStyleB :: YiString -> RegionStyle -> BufferM ()

isCurrentLineAllWhiteSpaceB :: BufferM Bool

Note: Returns False if line doesn't have any characters besides a newline

isCurrentLineEmptyB :: BufferM Bool

True if current line consists of just a newline (no whitespace)

isNumberB :: BufferM Bool

Is character under cursor a number.

killWordB :: BufferM ()

Delete forward whitespace or non-whitespace depending on the character under point.

lastNonSpaceB :: BufferM ()

Move to the last non-space character in this line

leftEdgesOfRegionB :: RegionStyle -> Region -> BufferM [Point]

leftOnEol :: BufferM ()

Move left if on eol, but not on blank line

lineMoveVisRel :: Int -> BufferM ()

Move point down by n lines If line extends past width of window, count moving a single line as moving width points to the right.

linePrefixSelectionB

Arguments

:: YiString

The string that starts a line comment

-> BufferM ()

Prefix each line in the selection using the given string.

lineStreamB :: Direction -> BufferM [YiString]

Get a (lazy) stream of lines in the buffer, starting at the next line in the given direction.

lowercaseWordB :: BufferM ()

lowerise word under the cursor

middleB :: BufferM ()

Move to middle line in screen

modifyExtendedSelectionB :: TextUnit -> (YiString -> YiString) -> BufferM ()

moveNonspaceOrSol :: BufferM ()

Go to the first non space character in the line; if already there, then go to the beginning of the line.

movePercentageFileB :: Int -> BufferM ()

moveToEol :: BufferM ()

Move point to end of line

moveToSol :: BufferM ()

Move point to start of line

moveXorEol :: Int -> BufferM ()

Move x chars forward, or to the eol, whichever is less

moveXorSol :: Int -> BufferM ()

Move x chars back, or to the sol, whichever is less

nextCInLineExc :: Char -> BufferM ()

nextCInLineInc :: Char -> BufferM ()

nextNParagraphs :: Int -> BufferM ()

Move down next n paragraphs

nextWordB :: BufferM ()

Move to first char of next word forwards

prevCInLineExc :: Char -> BufferM ()

prevCInLineInc :: Char -> BufferM ()

prevNParagraphs :: Int -> BufferM ()

Move up prev n paragraphs

prevWordB :: BufferM ()

Move to first char of next word backwards

readCurrentWordB :: BufferM YiString

Reads in word at point.

readLnB :: BufferM YiString

Read the line the point is on

readPrevWordB :: BufferM YiString

Reads in word before point.

readRegionRopeWithStyleB :: Region -> RegionStyle -> BufferM YiString

replaceBufferContent :: YiString -> BufferM ()

Replace the contents of the buffer with some string

revertB :: YiString -> Maybe ConverterName -> UTCTime -> BufferM ()

Helper function: revert the buffer contents to its on-disk version

rightEdgesOfRegionB :: RegionStyle -> Region -> BufferM [Point]

scrollB :: Int -> BufferM ()

Scroll by n lines.

scrollCursorToBottomB :: BufferM ()

Move cursor to the bottom of the screen

scrollCursorToTopB :: BufferM ()

Move cursor to the top of the screen

scrollScreensB :: Int -> BufferM ()

Scroll by n screens (negative for up)

scrollToCursorB :: BufferM ()

Move to middle line in screen

scrollToLineAboveWindowB :: BufferM ()

scrollToLineBelowWindowB :: BufferM ()

setSelectionMarkPointB :: Point -> BufferM ()

Marks

Set the current buffer selection mark

setSelectRegionB :: Region -> BufferM ()

Select the given region: set the selection mark at the regionStart and the current point at the regionEnd.

shapeOfBlockRegionB :: Region -> BufferM (Point, [Int])

sortLines :: BufferM ()

Sort the lines of the region.

snapInsB :: BufferM ()

Move the point to inside the viewable region

snapScreenB :: Maybe ScrollStyle -> BufferM Bool

Move the visible region to include the point

splitBlockRegionToContiguousSubRegionsB :: Region -> BufferM [Region]

swapB :: BufferM ()

Transpose two characters, (the Emacs C-t action)

switchCaseChar :: Char -> Char

test3CharB :: BufferM Bool

Used by isNumber to test if current character under cursor is a number.

testHexB :: BufferM Bool

Characters ['a'..'f'] are part of a hex number only if preceded by 0x. Test if the current occurence of ['a'..'f'] is part of a hex number.

toggleCommentB :: YiString -> BufferM ()

Just like toggleCommentSelectionB but automatically inserts a whitespace suffix to the inserted comment string. In fact:

topB :: BufferM ()

Move cursor to origin

unLineCommentSelectionB

Arguments

:: YiString

The string which begins a line comment

-> YiString

A potentially shorter string that begins a comment

-> BufferM ()

Uncomments the selection using the given line comment starting string. This only works for the comments which begin at the start of the line.

upFromBosB :: Int -> BufferM ()

Move to n lines up from the bottom of the screen

uppercaseWordB :: BufferM ()

capitalise the word under the cursor

upScreenB :: BufferM ()

Scroll up 1 screen

upScreensB :: Int -> BufferM ()

vimScrollB :: Int -> BufferM ()

Same as scrollB, but also moves the cursor

vimScrollByB :: (Int -> Int) -> Int -> BufferM ()

Same as scrollByB, but also moves the cursor