Data.Text.Lazy.Zipper

Documentation

type Position = Word

data TextZipper

Constructors

TextZipper

Fields

• beforeCursor :: !Text

  The text appearing before the cursor

• afterCursor :: !Text

  The text appearing after the cursor

• cursor :: !Position

  The cursor's position in the line of text, i.e. the length of beforeCursor

Instances

IsString TextZipper

Defined in Data.Text.Lazy.Zipper

Methods

fromString :: String -> TextZipper

Monoid TextZipper

Defined in Data.Text.Lazy.Zipper

Methods

mempty :: TextZipper

mappend :: TextZipper -> TextZipper -> TextZipper

mconcat :: [TextZipper] -> TextZipper

Semigroup TextZipper

Defined in Data.Text.Lazy.Zipper

Methods

(<>) :: TextZipper -> TextZipper -> TextZipper

sconcat :: NonEmpty TextZipper -> TextZipper

stimes :: Integral b => b -> TextZipper -> TextZipper

Generic TextZipper

Defined in Data.Text.Lazy.Zipper

Associated Types

type Rep TextZipper :: Type -> Type

Methods

from :: TextZipper -> Rep TextZipper x

to :: Rep TextZipper x -> TextZipper

Show TextZipper

Defined in Data.Text.Lazy.Zipper

Methods

showsPrec :: Int -> TextZipper -> ShowS

show :: TextZipper -> String

showList :: [TextZipper] -> ShowS

Eq TextZipper

Defined in Data.Text.Lazy.Zipper

Methods

(==) :: TextZipper -> TextZipper -> Bool

(/=) :: TextZipper -> TextZipper -> Bool

type Rep TextZipper

Defined in Data.Text.Lazy.Zipper

type Rep TextZipper = D1 ('MetaData "TextZipper" "Data.Text.Lazy.Zipper" "text-rope-zipper-0.1.0.0-IuZC36hr3pjD5Fa3aYOd9b" 'False) (C1 ('MetaCons "TextZipper" 'PrefixI 'True) (S1 ('MetaSel ('Just "beforeCursor") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "afterCursor") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "cursor") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Position))))

moveCursor :: (Position -> Position) -> TextZipper -> TextZipper

Modify the cursor position, updating the TextZipper according to the change.

setCursor :: Position -> TextZipper -> TextZipper

Set the position of the Cursor to a specific value. The state of the TextZipper will be updated to match the new position.

hasTrailingNewline :: TextZipper -> Bool

Whether the TextZipper has a trailing newline. A trailing newline is present if the last character of the line is a '\n' character.

removeTrailingNewline :: Text -> Text

Helper function to remove the last character of the provided text iff it is a trailing newline.

null :: TextZipper -> Bool

Whether the provided TextZipper is empty.

length :: TextZipper -> Int64

The length of the entire TextZipper structure.

toText :: TextZipper -> Text

Convert a TextZipper to Text. Effectively 'beforeCursor <> afterCursor', but slightly more efficient in edge cases.

fromText :: Text -> TextZipper

Create a TextZipper from a Text source, with the cursor at the end of it.

fromTextAt :: Text -> Position -> TextZipper

Create a TextZipper from a Text source, with the cursor at the specified position.

fromParts :: Text -> Text -> TextZipper

Create a TextZipper by concatenating two Text components, with the cursor between them.

insert :: Text -> TextZipper -> TextZipper

Insert Text before the current Cursor position, updating its position according to the provided Text's length.

splitBefore :: TextZipper -> (TextZipper, Maybe Char)

splitAfter :: TextZipper -> (TextZipper, Maybe Char)

deleteBefore :: TextZipper -> TextZipper

Delete the first character before the cursor, if any.

deleteAfter :: TextZipper -> TextZipper

Delete the first character after the cursor, if any.

moveBackward :: TextZipper -> TextZipper

Decrement the cursor.

moveForward :: TextZipper -> TextZipper

Increment the cursor.

moveStart :: TextZipper -> TextZipper

Move the cursor to the beginning of the text.

moveEnd :: TextZipper -> TextZipper

Move the cursor to the end of the text.