Moduletext-rope-0.3Haskell2010

Data.Text.Utf8.Rope

2 types
13 values

Packagetext-rope-0.3
Exports15
LanguageHaskell2010
LicenceBSD-3-Clause
SourceRope.hs

datadata Rope

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

Instances7Eq, Ord, Show, IsString, Semigroup, Monoid, …

Eq RopeDefined in text-rope-0.3 · Data.Text.Utf8.Rope
Ord RopeDefined in text-rope-0.3 · Data.Text.Utf8.Rope
Show RopeDefined in text-rope-0.3 · Data.Text.Utf8.Rope
IsString RopeDefined in text-rope-0.3 · Data.Text.Utf8.Rope
Semigroup RopeDefined in text-rope-0.3 · Data.Text.Utf8.Rope
Monoid RopeDefined in text-rope-0.3 · Data.Text.Utf8.Rope
NFData RopeDefined in text-rope-0.3 · Data.Text.Utf8.Rope

valuefromText :: Text -> Rope

Create from Text, linear time.

valuefromTextLines :: TextLines -> Rope

Create from TextLines, linear time.

valuetoText :: Rope -> Text

Glue chunks into Text, linear time.

valuetoTextLines :: Rope -> TextLines

Glue chunks into TextLines, linear time.

valuenull :: Rope -> Bool

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

Lines

4 declarations

valuelines :: Rope -> [Text]

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

Example6 expressions

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

valuelengthInLines :: Rope -> Word

Equivalent to Data.List.length . lines, but in logarithmic time.

Example6 expressions

>>> :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).

valuesplitAtLine :: Word -> Rope -> (Rope, Rope)

Split at given line, logarithmic time.

Example2 expressions

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

valuegetLine :: Word -> Rope -> Rope

Get a line by its 0-based index. Returns mempty if the index is out of bounds. The result doesn't contain \n characters.

Example2 expressions

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

UTF-8 code units

5 declarations

valuelength :: Rope -> Word

Length in UTF-8 code units aka bytes, O(1).

Example3 expressions

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

valuesplitAt :: Word -> Rope -> Maybe (Rope, Rope)

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

Example2 expressions

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

datadata Position

Represent a position in a text.

Constructors

Position
- posLine :: !Word
  Line.
- posColumn :: !Word
  Column in UTF-8 code units aka bytes.

Instances6Eq, Ord, Show, Semigroup, Monoid, NFData

Eq PositionDefined in text-rope-0.3 · Data.Text.Utf8.Lines
Ord PositionDefined in text-rope-0.3 · Data.Text.Utf8.Lines
Show PositionDefined in text-rope-0.3 · Data.Text.Utf8.Lines
Semigroup PositionDefined in text-rope-0.3 · Data.Text.Utf8.Lines
Associativity does not hold when posLine overflows.
Monoid PositionDefined in text-rope-0.3 · Data.Text.Utf8.Lines
NFData PositionDefined in text-rope-0.3 · Data.Text.Utf8.Lines

valuelengthAsPosition :: Rope -> Position

Measure text length as an amount of lines and columns. Time is linear in the length of the last line.

Example4 expressions

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

valuesplitAtPosition :: Position -> Rope -> Maybe (Rope, Rope)

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

Example7 expressions

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