License | GPL-2 |
---|---|
Maintainer | yi-devel@googlegroups.com |
Stability | experimental |
Portability | portable |
Safe Haskell | None |
Language | Haskell2010 |
Extensions | DeriveDataTypeable |
Yi.Buffer.TextUnit
Description
Working with blocks (units) of text.
- data TextUnit
- outsideUnit :: TextUnit -> TextUnit
- leftBoundaryUnit :: TextUnit -> TextUnit
- unitWord :: TextUnit
- unitViWord :: TextUnit
- unitViWORD :: TextUnit
- unitViWordAnyBnd :: TextUnit
- unitViWORDAnyBnd :: TextUnit
- unitViWordOnLine :: TextUnit
- unitViWORDOnLine :: TextUnit
- unitDelimited :: Char -> Char -> Bool -> TextUnit
- unitSentence :: TextUnit
- unitEmacsParagraph :: TextUnit
- unitParagraph :: TextUnit
- isAnySep :: Char -> Bool
- unitSep :: TextUnit
- unitSepThisLine :: TextUnit
- isWordChar :: Char -> Bool
- moveB :: TextUnit -> Direction -> BufferM ()
- maybeMoveB :: TextUnit -> Direction -> BufferM ()
- transformB :: (YiString -> YiString) -> TextUnit -> Direction -> BufferM ()
- transposeB :: TextUnit -> Direction -> BufferM ()
- regionOfB :: TextUnit -> BufferM Region
- regionOfNonEmptyB :: TextUnit -> BufferM Region
- regionOfPartB :: TextUnit -> Direction -> BufferM Region
- regionWithTwoMovesB :: BufferM a -> BufferM b -> BufferM Region
- regionOfPartNonEmptyB :: TextUnit -> Direction -> BufferM Region
- regionOfPartNonEmptyAtB :: TextUnit -> Direction -> Point -> BufferM Region
- readPrevUnitB :: TextUnit -> BufferM YiString
- readUnitB :: TextUnit -> BufferM YiString
- untilB :: BufferM Bool -> BufferM a -> BufferM [a]
- 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 ()
- atBoundaryB :: TextUnit -> Direction -> BufferM Bool
- numberOfB :: TextUnit -> TextUnit -> BufferM Int
- deleteB :: TextUnit -> Direction -> BufferM ()
- genMaybeMoveB :: TextUnit -> (Direction, BoundarySide) -> Direction -> BufferM ()
- genMoveB :: TextUnit -> (Direction, BoundarySide) -> Direction -> BufferM ()
- data BoundarySide
- genAtBoundaryB :: TextUnit -> Direction -> BoundarySide -> BufferM Bool
- checkPeekB :: Int -> [Char -> Bool] -> Direction -> BufferM Bool
- halfUnit :: Direction -> TextUnit -> TextUnit
- deleteUnitB :: TextUnit -> Direction -> BufferM ()
Documentation
Designate a given "unit" of text.
outsideUnit :: TextUnit -> TextUnit #
leftBoundaryUnit :: TextUnit -> TextUnit #
Unit that have its left and right boundaries at the left boundary of the argument unit.
unitViWord :: TextUnit #
unitViWORD :: TextUnit #
unitDelimited :: Char -> Char -> Bool -> TextUnit #
delimited on the left and right by given characters, boolean argument tells if whether those are included.
unitEmacsParagraph :: TextUnit #
Paragraph to implement emacs-like forward-paragraph/backward-paragraph
Paragraph that begins and ends in the paragraph, not the empty lines surrounding it.
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).
unitSepThisLine is true for any kind of whitespace/separator on this line only
isWordChar :: Char -> Bool #
transposeB :: TextUnit -> Direction -> BufferM () #
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 #
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.
doIfCharB :: (Char -> Bool) -> BufferM a -> BufferM () #
Do an action if the current buffer character passes the predicate
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.
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
deleteUnitB :: TextUnit -> Direction -> BufferM () #