Yi.Buffer.Normal

A normalized API to many buffer operations.

Documentation

data TextUnit

Designate a given "unit" of text.

Constructors

Character

a single character

Line

a line of text (between newlines)

VLine

a "vertical" line of text (area of text between two characters at the same column number)

Document

the whole document

GenUnit

Fields

genEnclosingUnit :: TextUnit

genUnitBoundary :: Direction -> BufferM Bool

Instances

Typeable * TextUnit

outsideUnit :: TextUnit -> TextUnit

Turns a unit into its "negative" by inverting the boundaries. For example, outsideUnit unitViWord will be the unit of spaces between words. For units without boundaries (Character, Document, ...), this is the identity function.

leftBoundaryUnit :: TextUnit -> TextUnit

Unit that have its left and right boundaries at the left boundary of the argument unit.

unitWord :: TextUnit

a word as in use in Emacs (fundamental mode)

unitViWord :: TextUnit

unitViWORD :: TextUnit

unitViWordAnyBnd :: TextUnit

unitViWORDAnyBnd :: TextUnit

unitViWordOnLine :: TextUnit

unitViWORDOnLine :: TextUnit

unitDelimited :: Char -> Char -> Bool -> TextUnit

delimited on the left and right by given characters, boolean argument tells if whether those are included.

unitSentence :: TextUnit

unitEmacsParagraph :: TextUnit

Paragraph to implement emacs-like forward-paragraph/backward-paragraph

unitParagraph :: TextUnit

Paragraph that begins and ends in the paragraph, not the empty lines surrounding it.

isAnySep :: Char -> Bool

Separator characters (space, tab, unicode separators). Most of the units above attempt to identify "words" with various punctuation and symbols included or excluded. This set of units is a simple inverse: it is true for "whitespace" or "separators" and false for anything that is not (letters, numbers, symbols, punctuation, whatever).

unitSep :: TextUnit

unitSep is true for any kind of whitespace/separator

unitSepThisLine :: TextUnit

unitSepThisLine is true for any kind of whitespace/separator on this line only

isWordChar :: Char -> Bool

moveB :: TextUnit -> Direction -> BufferM ()

Move to the next unit boundary

maybeMoveB :: TextUnit -> Direction -> BufferM ()

As moveB, unless the point is at a unit boundary

transformB :: (YiString -> YiString) -> TextUnit -> Direction -> BufferM ()

Transforms the region given by TextUnit in the Direction with user-supplied function.

transposeB :: TextUnit -> Direction -> BufferM ()

regionOfB :: TextUnit -> BufferM Region

Region of the whole textunit where the current point is.

regionOfNonEmptyB :: TextUnit -> BufferM Region

Non empty region of the whole textunit where the current point is.

regionOfPartB :: TextUnit -> Direction -> BufferM Region

Region between the point and the next boundary. The region is empty if the point is at the boundary.

regionOfPartNonEmptyB :: TextUnit -> Direction -> BufferM Region

Non empty region between the point and the next boundary, In fact the region can be empty if we are at the end of file.

regionOfPartNonEmptyAtB :: TextUnit -> Direction -> Point -> BufferM Region

Non empty region at given point and the next boundary,

readPrevUnitB :: TextUnit -> BufferM YiString

readUnitB :: TextUnit -> BufferM YiString

untilB :: BufferM Bool -> BufferM a -> BufferM [a]

Repeat an action until the condition is fulfilled or the cursor stops moving. The Action may be performed zero times.

doUntilB_ :: BufferM Bool -> BufferM a -> BufferM ()

untilB_ :: BufferM Bool -> BufferM a -> BufferM ()

whileB :: BufferM Bool -> BufferM a -> BufferM [a]

doIfCharB :: (Char -> Bool) -> BufferM a -> BufferM ()

Do an action if the current buffer character passes the predicate

atBoundaryB :: TextUnit -> Direction -> BufferM Bool

numberOfB :: TextUnit -> TextUnit -> BufferM Int

deleteB :: TextUnit -> Direction -> BufferM ()

Delete between point and next unit boundary, return the deleted region.

genMaybeMoveB :: TextUnit -> (Direction, BoundarySide) -> Direction -> BufferM ()

Generic maybe move operation. As genMoveB, but don't move if we are at boundary already.

genMoveB :: TextUnit -> (Direction, BoundarySide) -> Direction -> BufferM ()

Generic move operation Warning: moving To the (OutsideBound, Backward) bound of Document is impossible (offset -1!) genMoveB u b d: move in direction d until encountering boundary b or unit u. See genAtBoundaryB for boundary explanation.

data BoundarySide

Boundary side

Constructors

InsideBound

OutsideBound

Instances

Eq BoundarySide

genAtBoundaryB :: TextUnit -> Direction -> BoundarySide -> BufferM Bool

genAtBoundaryB u d s returns whether the point is at a given boundary (d,s) . Boundary (d,s) , taking Word as example, means: Word ^^ ^^ 12 34 1: (Backward,OutsideBound) 2: (Backward,InsideBound) 3: (Forward,InsideBound) 4: (Forward,OutsideBound)

rules: genAtBoundaryB u Backward InsideBound = atBoundaryB u Backward genAtBoundaryB u Forward OutsideBound = atBoundaryB u Forward

checkPeekB :: Int -> [Char -> Bool] -> Direction -> BufferM Bool

data RegionStyle

Constructors

LineWise

Inclusive

Exclusive

Block

Instances

Eq RegionStyle

Show RegionStyle

Binary RegionStyle

Default RegionStyle

YiVariable RegionStyle

Typeable * RegionStyle

mkRegionOfStyleB :: Point -> Point -> RegionStyle -> BufferM Region

convertRegionToStyleB :: Region -> RegionStyle -> BufferM Region

unitWiseRegion :: TextUnit -> Region -> BufferM Region

extendRegionToBoundaries :: TextUnit -> BoundarySide -> BoundarySide -> Region -> BufferM Region

Extend the given region to boundaries of the text unit. For instance one can extend the selection to complete lines, or paragraphs.

getRegionStyle :: BufferM RegionStyle

putRegionStyle :: RegionStyle -> BufferM ()