Data.Text.Utf16.Lines

Documentation

data TextLines

A wrapper around Text for fast line/column navigation. Concatenation takes linear time.

This is a building block for Rope, which provides logarithmic concatenation.

Instances

Eq TextLines

Defined in Data.Text.Lines.Internal

Methods

(==) :: TextLines -> TextLines -> Bool

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

Ord TextLines

Defined in Data.Text.Lines.Internal

Methods

compare :: TextLines -> TextLines -> Ordering

(<) :: TextLines -> TextLines -> Bool

(<=) :: TextLines -> TextLines -> Bool

(>) :: TextLines -> TextLines -> Bool

(>=) :: TextLines -> TextLines -> Bool

max :: TextLines -> TextLines -> TextLines

min :: TextLines -> TextLines -> TextLines

Show TextLines

Defined in Data.Text.Lines.Internal

Methods

showsPrec :: Int -> TextLines -> ShowS

show :: TextLines -> String

showList :: [TextLines] -> ShowS

IsString TextLines

Defined in Data.Text.Lines.Internal

Methods

fromString :: String -> TextLines

Semigroup TextLines

Defined in Data.Text.Lines.Internal

Methods

(<>) :: TextLines -> TextLines -> TextLines

sconcat :: NonEmpty TextLines -> TextLines

stimes :: Integral b => b -> TextLines -> TextLines

Monoid TextLines

Defined in Data.Text.Lines.Internal

Methods

mempty :: TextLines

mappend :: TextLines -> TextLines -> TextLines

mconcat :: [TextLines] -> TextLines

NFData TextLines

Defined in Data.Text.Lines.Internal

Methods

rnf :: TextLines -> ()

fromText :: Text -> TextLines

Create from Text, linear time.

toText :: TextLines -> Text

Extract Text, O(1).

null :: TextLines -> Bool

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

Lines

lines :: TextLines -> [Text]

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 :: TextLines -> Word

Equivalent to length . lines, but in O(1).

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

splitAtLine :: Word -> TextLines -> (TextLines, TextLines)

Split at given line, O(1).

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

UTF-16 code units

length :: TextLines -> Word

Length in UTF-16 code units. Takes linear time.

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

splitAt :: Word -> TextLines -> Maybe (TextLines, TextLines)

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

Represent a position in a text.

Constructors

Position

Fields

• posLine :: !Word

  Line.

• posColumn :: !Word

  Column in UTF-16 code units.

Instances

Eq Position

Defined in Data.Text.Utf16.Lines

Methods

(==) :: Position -> Position -> Bool

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

Ord Position

Defined in Data.Text.Utf16.Lines

Methods

compare :: Position -> Position -> Ordering

(<) :: Position -> Position -> Bool

(<=) :: Position -> Position -> Bool

(>) :: Position -> Position -> Bool

(>=) :: Position -> Position -> Bool

max :: Position -> Position -> Position

min :: Position -> Position -> Position

Show Position

Defined in Data.Text.Utf16.Lines

Methods

showsPrec :: Int -> Position -> ShowS

show :: Position -> String

showList :: [Position] -> ShowS

Semigroup Position

Associativity does not hold when posLine overflows.

Defined in Data.Text.Utf16.Lines

Methods

(<>) :: Position -> Position -> Position

sconcat :: NonEmpty Position -> Position

stimes :: Integral b => b -> Position -> Position

Monoid Position

Defined in Data.Text.Utf16.Lines

Methods

mempty :: Position

mappend :: Position -> Position -> Position

mconcat :: [Position] -> Position

NFData Position

Defined in Data.Text.Utf16.Lines

Methods

rnf :: Position -> ()

lengthAsPosition :: TextLines -> Position

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

>>> :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 -> TextLines -> Maybe (TextLines, TextLines)

Combination of splitAtLine and subsequent splitAt. If requested number of code units splits a code point in half, return Nothing. Time is linear in posColumn, but does not depend on 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𐀀","я")