text-rope

Text lines and ropes

LTS Haskell 23.23:	0.2
Stackage Nightly 2025-05-22:	0.3
Latest on Hackage:	0.3

See all snapshots text-rope appears in

BSD-3-Clause licensed by Andrew Lelechenko, Olle Fredriksson

Maintained by Andrew Lelechenko

This version can be pinned in stack with:text-rope-0.3@sha256:49564982ede8efd89f3ccbabe06e2c1d062684f6a45503001e4a038fa3fcd5c4,2390

Module documentation for 0.3

Data
- Data.Text
  - Data.Text.Lines
  - Data.Text.Mixed
    - Data.Text.Mixed.Rope
  - Data.Text.Rope
  - Data.Text.Utf16
    - Data.Text.Utf16.Lines
    - Data.Text.Utf16.Rope
      - Data.Text.Utf16.Rope.Mixed
  - Data.Text.Utf8
    - Data.Text.Utf8.Lines
    - Data.Text.Utf8.Rope

Depends on 4 packages(full list with versions):

base, deepseq, text, vector

Used by 1 package in nightly-2025-04-24(full list with versions):

lsp

text-rope

A wrapper around Text for fast line/column navigation and logarithmic concatenation.

Here are benchmarks for 1000 edits over 70K text:

Split at position
  Unicode
    text-rope:
      3.09 ms ±  94 μs
    yi-rope:
      49.4 ms ± 1.4 ms, 15.98x
  UTF-16
    text-rope:
      3.09 ms ± 106 μs
    rope-utf16-splay:
      10.6 ms ± 337 μs, 3.44x
Split at offset
  Unicode
    text-rope:
      3.04 ms ± 112 μs
    core-text:
      14.0 ms ± 297 μs, 4.59x
    yi-rope:
      6.25 ms ± 102 μs, 2.06x
  UTF-16
    text-rope:
      3.40 ms ±  70 μs
    rope-utf16-splay:
      8.92 ms ± 169 μs, 2.62x

For 10000 edits over 700K text:

Split at position
  Unicode
    text-rope:
      62.9 ms ± 4.2 ms
    yi-rope:
      568  ms ±  31 ms, 9.04x
  UTF-16
    text-rope:
      61.0 ms ± 3.9 ms
    rope-utf16-splay:
      325  ms ±  13 ms, 5.32x
Split at offset
  Unicode
    text-rope:
      59.6 ms ± 3.8 ms
    core-text:
      209  ms ±  15 ms, 3.50x
    yi-rope:
      105  ms ± 7.4 ms, 1.76x
  UTF-16
    text-rope:
      63.6 ms ± 5.3 ms
    rope-utf16-splay:
      230  ms ± 9.0 ms, 3.62x

For 100000 edits over 7M text:

Split at position
  Unicode
    text-rope:
      963  ms ±  43 ms
    yi-rope:
      6.379 s ± 138 ms, 6.62x
  UTF-16
    text-rope:
      988  ms ±  19 ms
    rope-utf16-splay: T
      57.408 s ± 4.24 s, 58.12x
Split at offset
  Unicode
    text-rope:
      1.014 s ±  70 ms
    core-text:
      3.008 s ± 138 ms, 2.97x
    yi-rope:
      1.716 s ±  76 ms, 1.69x
  UTF-16
    text-rope:
      1.065 s ±  53 ms
    rope-utf16-splay:
      38.852 s ± 568 ms, 36.49x

Changes

0.3

Move Data.Text.Utf16.Rope.Mixed module to Data.Text.Mixed.Rope. Data.Text.Utf16.Rope.Mixed re-exports Data.Text.Mixed.Rope for legacy clients.
Add Data.Text.Utf8.Lines and Data.Text.Utf8.Rope modules for ropes indexed by UTF-8 code units.
Add UTF-8 indexing functionality to Data.Text.Mixed.Rope.
The metrics stored internally in the rope nodes has changed, which should improve performance by making some re-measuring redundant. As a consequence, the time complexity of Data.Text.Rope.lengthAsPosition is now linear in the length of the last line.
Add getLine functions to extract lines by 0-based index.

0.2

Share TextLines between Char and UTF-16 modules.
Add Data.Text.Utf16.Rope.Mixed.

0.1

Initial release.