Copyright | (c) 2021-2022 Andrew Lelechenko |
---|---|
License | BSD3 |
Maintainer | Andrew Lelechenko <andrew.lelechenko@gmail.com> |
Safe Haskell | None |
Language | Haskell2010 |
Synopsis
- data Rope
- fromText :: Text -> Rope
- fromTextLines :: TextLines -> Rope
- toText :: Rope -> Text
- toTextLines :: Rope -> TextLines
- null :: Rope -> Bool
- lines :: Rope -> [Text]
- lengthInLines :: Rope -> Word
- splitAtLine :: Word -> Rope -> (Rope, Rope)
- length :: Rope -> Word
- splitAt :: Word -> Rope -> (Rope, Rope)
- data Position = Position {}
- lengthAsPosition :: Rope -> Position
- splitAtPosition :: Position -> Rope -> (Rope, Rope)
Documentation
Rope of Text
chunks with logarithmic concatenation.
This rope offers an interface, based on code points.
Use Data.Text.Utf16.Rope, if you need UTF-16 code units,
or Data.Text.Utf16.Rope.Mixed, if you need both interfaces.
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","")]
Code points
length :: Rope -> Word Source #
Length in code points, similar to Data.Text.
length
, O(1).
>>>
:set -XOverloadedStrings
>>>
length "fя𐀀"
3>>>
Data.Text.Utf16.Rope.length "fя𐀀"
4
splitAt :: Word -> Rope -> (Rope, Rope) Source #
Split at given code point, similar to Data.Text.
splitAt
.
Takes linear time.
>>>
:set -XOverloadedStrings
>>>
map (\c -> splitAt c "fя𐀀") [0..4]
[("","fя𐀀"),("f","я𐀀"),("fя","𐀀"),("fя𐀀",""),("fя𐀀","")]
Represent a position in a text.
lengthAsPosition :: Rope -> Position Source #
Measure text length as an amount of lines and columns, O(1).
>>>
:set -XOverloadedStrings
>>>
lengthAsPosition "f𐀀"
Position {posLine = 0, posColumn = 2}>>>
lengthAsPosition "f\n𐀀"
Position {posLine = 1, posColumn = 1}>>>
lengthAsPosition "f\n𐀀\n"
Position {posLine = 2, posColumn = 0}
splitAtPosition :: Position -> Rope -> (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𐀀я"
("f\n","𐀀я")>>>
splitAtPosition (Position 1 1) "f\n𐀀я"
("f\n𐀀","я")>>>
splitAtPosition (Position 1 2) "f\n𐀀я"
("f\n𐀀я","")>>>
splitAtPosition (Position 0 2) "f\n𐀀я"
("f\n","𐀀я")>>>
splitAtPosition (Position 0 3) "f\n𐀀я"
("f\n𐀀","я")>>>
splitAtPosition (Position 0 4) "f\n𐀀я"
("f\n𐀀я","")