Modulerope-utf16-splay-0.4.0.0Haskell2010

Data.Rope.UTF16

Contents

Queries
Conversions
Transformations
Chunking
UTF-16 code unit indexing
Breaking by predicate
Folds
Special folds

Synopsis

newtype Rope
value null
value length
value rows
value columns
value toText
value toLazyText
value fromText
value toString
value map
value intercalate
value toChunks
value unconsChunk
value unsnocChunk
value splitAt
value take
value drop
data RowColumn
value rowColumnCodeUnits
value codeUnitsRowColumn
value splitAtLine
value span
value break
value takeWhile
value dropWhile
value foldl
value foldl'
value foldr
value any
value all

Packagerope-utf16-splay-0.4.0.0
Exports30
LanguageHaskell2010
LicenceBSD-3-Clause
SourceInternal.hs

newtypenewtype Rope

A SplayTree of Text values optimised for being indexed by and modified at UTF-16 code units and row/column (RowColumn) positions. Internal invariant: No empty Chunks in the SplayTree

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

Eq RopeDefined in rope-utf16-splay-0.4.0.0 · Data.Rope.UTF16.Internal
Ord RopeDefined in rope-utf16-splay-0.4.0.0 · Data.Rope.UTF16.Internal
Show RopeDefined in rope-utf16-splay-0.4.0.0 · Data.Rope.UTF16.Internal
IsString RopeDefined in rope-utf16-splay-0.4.0.0 · Data.Rope.UTF16.Internal
Semigroup RopeDefined in rope-utf16-splay-0.4.0.0 · Data.Rope.UTF16.Internal
Append joins adjacent chunks if that can be done while staying below chunkLength.
Monoid RopeDefined in rope-utf16-splay-0.4.0.0 · Data.Rope.UTF16.Internal
Measured Position RopeDefined in rope-utf16-splay-0.4.0.0 · Data.Rope.UTF16.Internal

Queries

valuenull :: Rope -> Bool

Source#

Is the rope empty?

valuelength :: Rope -> Int

Source#

Length in UTF-16 code units (not characters)

valuerows :: Rope -> Int

Source#

The number of newlines in the rope

valuecolumns :: Rope -> Int

Source#

The number of UTF-16 code units (not characters) since the last newline or the start of the rope

Conversions

valuetoText :: Rope -> Text

valuetoLazyText :: Rope -> Text

valuefromText :: Text -> Rope

valuetoString :: Rope -> String

Transformations

valuemap :: (Char -> Char) -> Rope -> Rope

Source#

Map over the characters of a rope

valueintercalate :: Rope -> [Rope] -> Rope

Source#

Concatenate the interspersion of a rope between the elements of a list of ropes

Chunking

valuetoChunks :: Rope -> [Text]

Source#

The raw Text data that the Rope is built from

valueunconsChunk :: Rope -> Maybe (Text, Rope)

Source#

Get the first chunk and the rest of the Rope if non-empty

valueunsnocChunk :: Rope -> Maybe (Rope, Text)

Source#

Get the last chunk and the rest of the Rope if non-empty

UTF-16 code unit indexing

valuesplitAt :: Int -> Rope -> (Rope, Rope)

Source#

Split the rope at the nth UTF-16 code unit (not character)

valuetake :: Int -> Rope -> Rope

Source#

Take the first n UTF-16 code units (not characters)

valuedrop :: Int -> Rope -> Rope

Source#

Drop the first n UTF-16 code units (not characters)

datadata RowColumn

Constructors

RowColumn
- row :: !Int
  Number of newlines before this position
- column :: !Int
  Number of UTF-16 code units since last newline or start of string

Instances5Eq, Ord, Show, Semigroup, Monoid

Eq RowColumnDefined in rope-utf16-splay-0.4.0.0 · Data.Rope.UTF16.Internal.Position
Ord RowColumnDefined in rope-utf16-splay-0.4.0.0 · Data.Rope.UTF16.Internal.Position
Show RowColumnDefined in rope-utf16-splay-0.4.0.0 · Data.Rope.UTF16.Internal.Position
Semigroup RowColumnDefined in rope-utf16-splay-0.4.0.0 · Data.Rope.UTF16.Internal.Position
Monoid RowColumnDefined in rope-utf16-splay-0.4.0.0 · Data.Rope.UTF16.Internal.Position

valuerowColumnCodeUnits :: RowColumn -> Rope -> Int

Source#

Get the UTF-16 code unit index in the rope that corresponds to a RowColumn position

valuecodeUnitsRowColumn :: Int -> Rope -> RowColumn

Source#

Get the RowColumn position that corresponds to a UTF-16 code unit index in the rope

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

Source#

Split the rope immediately after the i:th newline

Breaking by predicate

valuespan :: (Char -> Bool) -> Rope -> (Rope, Rope)

Source#

span f r = (takeWhile f r, dropWhile f r)

valuebreak :: (Char -> Bool) -> Rope -> (Rope, Rope)

Source#

break f = span (not . f)

valuetakeWhile :: (Char -> Bool) -> Rope -> Rope

Source#

takeWhile f = fst . span f

valuedropWhile :: (Char -> Bool) -> Rope -> Rope

Source#

dropWhile f = snd . span f

Folds

valuefoldl :: (a -> Char -> a) -> a -> Rope -> a

Source#

Fold left

valuefoldl' :: (a -> Char -> a) -> a -> Rope -> a

Source#

A strict version of foldl

valuefoldr :: (Char -> a -> a) -> a -> Rope -> a

Source#

Fold right

Special folds

valueany :: (Char -> Bool) -> Rope -> Bool

Source#

Do any characters in the rope satisfy the predicate?

valueall :: (Char -> Bool) -> Rope -> Bool

Source#

Do all characters in the rope satisfy the predicate?