text-rope-0.2: Text lines and ropes
Copyright(c) 2021-2022 Andrew Lelechenko
LicenseBSD3
MaintainerAndrew Lelechenko <andrew.lelechenko@gmail.com>
Safe HaskellNone
LanguageHaskell2010

Data.Text.Utf16.Rope

Description

 
Synopsis

Documentation

data Rope Source #

Rope of Text chunks with logarithmic concatenation. This rope offers an interface, based on UTF-16 code units. Use Data.Text.Rope, if you need code points, or Data.Text.Utf16.Rope.Mixed, if you need both interfaces.

Instances

Instances details
IsString Rope Source # 
Instance details

Defined in Data.Text.Utf16.Rope

Methods

fromString :: String -> Rope #

Monoid Rope Source # 
Instance details

Defined in Data.Text.Utf16.Rope

Methods

mempty :: Rope #

mappend :: Rope -> Rope -> Rope #

mconcat :: [Rope] -> Rope #

Semigroup Rope Source # 
Instance details

Defined in Data.Text.Utf16.Rope

Methods

(<>) :: Rope -> Rope -> Rope #

sconcat :: NonEmpty Rope -> Rope #

stimes :: Integral b => b -> Rope -> Rope #

Show Rope Source # 
Instance details

Defined in Data.Text.Utf16.Rope

Methods

showsPrec :: Int -> Rope -> ShowS #

show :: Rope -> String #

showList :: [Rope] -> ShowS #

NFData Rope Source # 
Instance details

Defined in Data.Text.Utf16.Rope

Methods

rnf :: Rope -> () #

Eq Rope Source # 
Instance details

Defined in Data.Text.Utf16.Rope

Methods

(==) :: Rope -> Rope -> Bool #

(/=) :: Rope -> Rope -> Bool #

Ord Rope Source # 
Instance details

Defined in Data.Text.Utf16.Rope

Methods

compare :: Rope -> Rope -> Ordering #

(<) :: Rope -> Rope -> Bool #

(<=) :: Rope -> Rope -> Bool #

(>) :: Rope -> Rope -> Bool #

(>=) :: Rope -> Rope -> Bool #

max :: Rope -> Rope -> Rope #

min :: Rope -> Rope -> Rope #

fromText :: Text -> Rope Source #

Create from Text, linear time.

fromTextLines :: TextLines -> Rope Source #

Create from TextLines, linear time.

toText :: Rope -> Text Source #

Glue chunks into Text, linear time.

toTextLines :: Rope -> TextLines Source #

Glue chunks into TextLines, linear time.

null :: Rope -> Bool Source #

Check whether a rope is empty, O(1).

Lines

lines :: Rope -> [Text] Source #

Split into lines by \n, similar to Data.Text.lines. Each line is produced in O(1).

>>> :set -XOverloadedStrings
>>> lines ""
[]
>>> lines "foo"
["foo"]
>>> lines "foo\n"
["foo"]
>>> lines "foo\n\n"
["foo",""]
>>> lines "foo\nbar"
["foo","bar"]

lengthInLines :: Rope -> Word Source #

Equivalent to length . lines, but in logarithmic time.

>>> :set -XOverloadedStrings
>>> lengthInLines ""
0
>>> lengthInLines "foo"
1
>>> lengthInLines "foo\n"
1
>>> lengthInLines "foo\n\n"
2
>>> lengthInLines "foo\nbar"
2

If you do not care about ignoring the last newline character, you can use posLine . lengthAsPosition instead, which works in O(1).

splitAtLine :: Word -> Rope -> (Rope, Rope) Source #

Split at given line, logarithmic time.

>>> :set -XOverloadedStrings
>>> map (\l -> splitAtLine l "foo\nbar") [0..3]
[("","foo\nbar"),("foo\n","bar"),("foo\nbar",""),("foo\nbar","")]

UTF-16 code units

length :: Rope -> Word Source #

Length in UTF-16 code units, O(1).

>>> :set -XOverloadedStrings
>>> length "fя𐀀"
4
>>> Data.Text.Rope.length "fя𐀀"
3

splitAt :: Word -> Rope -> Maybe (Rope, Rope) Source #

Split at given UTF-16 code unit. If requested number of code units splits a code point in half, return Nothing. Takes linear time.

>>> :set -XOverloadedStrings
>>> map (\c -> splitAt c "fя𐀀") [0..4]
[Just ("","fя𐀀"),Just ("f","я𐀀"),Just ("fя","𐀀"),Nothing,Just ("fя𐀀","")]

data Position Source #

Represent a position in a text.

Constructors

Position 

Fields

Instances

Instances details
Monoid Position Source # 
Instance details

Defined in Data.Text.Utf16.Lines

Semigroup Position Source #

Associativity does not hold when posLine overflows.

Instance details

Defined in Data.Text.Utf16.Lines

Show Position Source # 
Instance details

Defined in Data.Text.Utf16.Lines

NFData Position Source # 
Instance details

Defined in Data.Text.Utf16.Lines

Methods

rnf :: Position -> () #

Eq Position Source # 
Instance details

Defined in Data.Text.Utf16.Lines

Ord Position Source # 
Instance details

Defined in Data.Text.Utf16.Lines

lengthAsPosition :: Rope -> Position Source #

Measure text length as an amount of lines and columns, O(1).

>>> :set -XOverloadedStrings
>>> lengthAsPosition "f𐀀"
Position {posLine = 0, posColumn = 3}
>>> lengthAsPosition "f\n𐀀"
Position {posLine = 1, posColumn = 2}
>>> lengthAsPosition "f\n𐀀\n"
Position {posLine = 2, posColumn = 0}

splitAtPosition :: Position -> Rope -> Maybe (Rope, Rope) Source #

Combination of splitAtLine and subsequent splitAt. Time is linear in posColumn and logarithmic in posLine.

>>> :set -XOverloadedStrings
>>> splitAtPosition (Position 1 0) "f\n𐀀я"
Just ("f\n","𐀀я")
>>> splitAtPosition (Position 1 1) "f\n𐀀я"
Nothing
>>> splitAtPosition (Position 1 2) "f\n𐀀я"
Just ("f\n𐀀","я")
>>> splitAtPosition (Position 0 2) "f\n𐀀я"
Just ("f\n","𐀀я")
>>> splitAtPosition (Position 0 3) "f\n𐀀я"
Nothing
>>> splitAtPosition (Position 0 4) "f\n𐀀я"
Just ("f\n𐀀","я")