yi-core-0.19.2: Yi editor core library

Yi.Buffer.Normal

Description

A normalized API to many buffer operations.

Synopsis

# Documentation

data TextUnit Source #

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 TextUnit (Direction -> BufferM 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).

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

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.

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

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

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

unitSep is true for any kind of whitespace/separator

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

a word as in use in Emacs (fundamental mode)

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

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

Do an action if the current buffer character passes the predicate

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

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

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.

As moveB, unless the point is at a unit boundary

Move to the next unit boundary

Region of the whole textunit where the current point is.

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

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

Non empty region at given point and the next boundary,

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.

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

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

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

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

Boundary side

Constructors

 InsideBound OutsideBound

#### Instances

Instances details
 Source # Instance detailsDefined in Yi.Buffer.TextUnit Methods

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

Constructors

 LineWise Inclusive Exclusive Block

#### Instances

Instances details
 Source # Instance detailsDefined in Yi.Types Methods Source # Instance detailsDefined in Yi.Types MethodsshowList :: [RegionStyle] -> ShowS # Source # Instance detailsDefined in Yi.Types MethodsputList :: [RegionStyle] -> Put # Source # Instance detailsDefined in Yi.Types Methods Source # Instance detailsDefined in Yi.Types

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