Yi.OldRope

This module defines a Rope representation.

While the representation are ByteStrings stored in a finger tree, the indices are actually in number of characters.

This is currently based on utf8-string, but a couple of other packages might be better: text, compact-string.

At the moment none of them has a lazy implementation, which forces us to always export plain Strings. (Utf8-string does not have a proper newtype)

Important: The reason this module exists is to allow benchmarking and behaviour checks against a new implementation. As of today (10th September 2014), Yi imports this module. Notably, this module will be going away and Yi will start using Yi.Rope instead in the near future.

Documentation

data Rope

Instances

Eq Rope

Show Rope

IsString Rope

Binary Rope

Conversions to Rope

fromString :: IsString a => String -> a

Conversions from Rope

toString :: Rope -> String

toReverseString :: Rope -> String

List-like functions

null :: Rope -> Bool

empty :: Rope

take :: Int -> Rope -> Rope

drop :: Int -> Rope -> Rope

length :: Rope -> Int

Get the length of the string. (This information cached, so O(1) amortized runtime.)

reverse :: Rope -> Rope

countNewLines :: Rope -> Int

Count the number of newlines in the strings. (This information cached, so O(1) amortized runtime.)

split :: Word8 -> Rope -> [Rope]

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

Split the string at the specified position.

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

Split before the specified line. Lines are indexed from 0.

append :: Rope -> Rope -> Rope

Append two strings by merging the two finger trees.

concat :: [Rope] -> Rope

IO

readFile :: FilePath -> IO Rope

writeFile :: FilePath -> Rope -> IO ()

Low level functions

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

Split the rope on a chunk, so that the desired position lies within the first chunk of the second rope.