Copyright | (c) 2021-2022 Andrew Lelechenko |
---|---|
License | BSD3 |
Maintainer | Andrew Lelechenko <andrew.lelechenko@gmail.com> |
Safe Haskell | None |
Language | Haskell2010 |
Data.Text.Utf16.Lines
Contents
Description
Synopsis
- data TextLines
- fromText :: Text -> TextLines
- toText :: TextLines -> Text
- null :: TextLines -> Bool
- lines :: TextLines -> [Text]
- lengthInLines :: TextLines -> Word
- splitAtLine :: Word -> TextLines -> (TextLines, TextLines)
- length :: TextLines -> Word
- splitAt :: Word -> TextLines -> Maybe (TextLines, TextLines)
- data Position = Position {}
- lengthAsPosition :: TextLines -> Position
- splitAtPosition :: Position -> TextLines -> Maybe (TextLines, TextLines)
Documentation
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 Source # | |
Ord TextLines Source # | |
Show TextLines Source # | |
IsString TextLines Source # | |
Defined in Data.Text.Lines.Internal Methods fromString :: String -> TextLines # | |
Semigroup TextLines Source # | |
Monoid TextLines Source # | |
NFData TextLines Source # | |
Defined in Data.Text.Lines.Internal |
Lines
lines :: TextLines -> [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 :: TextLines -> Word Source #
splitAtLine :: Word -> TextLines -> (TextLines, TextLines) Source #
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 Source #
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) 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Ńš","")]
Represent a position in a text.
lengthAsPosition :: TextLines -> Position Source #
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) Source #
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š","Ń")