All files / json-crdt-extensions/peritext/overlay Overlay.ts

94.56% Statements 435/460
89.3% Branches 192/215
82.45% Functions 47/57
95.11% Lines 370/389

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 72660x 60x 60x 60x 60x 60x 60x 60x 60x 60x 60x 60x 60x 60x                       360x                 60x 3390x 3390x               3390x 3390x 3390x 3390x       34066x       1143x       21891x       845x       21x       10x             51706x 4656x 4656x 3451x 47050x 46207x 46207x 46207x 83380x 83380x 70414x   32999x 32999x 32999x 17933x     18175x             48x 2x 2x 2x 46x 43x 43x 43x 87x 87x 70x   43x 43x 43x 29x     12x               728x 21x 21x 1x 707x 697x 697x 697x 851x 851x 817x   260x 260x 260x 120x     523x                   52327x 52327x 52327x 52327x 52327x 52327x 52327x 9710x 9710x 9710x 9710x   52327x 52327x 16285x   36042x 36042x 36042x 36042x 36042x 68394x 18549x 18549x 18549x 18248x 4091x 4091x     54237x 50442x 50442x 18700x 4970x     40507x         11812x 11812x 68013x 68013x 68013x         1181x                             2656x 2656x 4623x 4623x 4623x         163x                         2478x 517x 517x 517x                               2433x 2433x   2433x 2433x 1129x 29x 29x   1129x 1085x 1085x     2397x 6346x 3949x 1568x 1493x 1493x 16x 16x     1552x 1552x 1552x 1552x         11122x 11122x 1513x 1513x 3026x     9609x 9609x 9609x 61865x 61865x 61865x 17831x 8862x 8862x 8862x   44034x 44034x 44034x 9002x 264x 264x     44034x         50x       11072x 11072x 64746x 64746x 54314x 54314x 54314x         20x                       9x 9x 10x 3x   2x                       6470x 6470x 6470x 4216x 14472x 13629x 13629x 13629x 28615x 28615x   13629x 2x 2x     4216x                       4677x 4677x 4677x 4022x 11262x 11262x 19832x 11262x 26x 26x     4022x                                     1014x 1014x 1014x 1014x 198x 198x   1014x 1014x 1014x 1014x 1014x 1014x 1014x 1014x 1308x 18x 18x 12x   1290x 1290x 1290x 1290x 1854x 1854x 1854x 1854x 1854x   948x 948x   168x 168x     1290x 882x 882x 54x 882x   408x 126x 114x 114x   408x   1014x                   3470x 3470x 3470x                             3390x     38445x 38445x 38445x 38445x 38445x     38445x   8534x   38445x     3390x     115335x 115335x 115335x 115335x 115335x   17921x 52583x 52583x 39315x       39315x 39315x 37797x   14786x 14786x   17921x 7219x 28675x 28675x 28675x 8739x         115335x       13643x 13643x 13643x 13643x 13643x 13643x 13643x 13643x 9667x 9667x   13643x 12631x 8118x 8118x   12631x 17117x   1012x 13643x       1143x 1143x 1143x 1142x 1142x 1142x   1143x       10257x 10257x 10257x 17049x 17049x 17049x   10257x 10257x 10257x 10257x               27286x 27286x 27286x 17785x                 28429x 1143x     28429x 28429x 28429x 4115x 4115x   24314x 14812x 14812x 1197x   14812x 14812x       12948x 12948x     3390x     8534x 8534x 8534x 8534x 8532x 8532x 8532x 8532x 8532x 44086x 44086x 44086x 44086x 44086x 49642x 49642x     44086x 60322x 44086x 44086x 44086x 44086x 1713x 534x   1179x   1713x 1713x 1713x     8532x 1179x   7353x   8532x                                                                  
import {printTree} from 'tree-dump/lib/printTree';
import {printBinary} from 'tree-dump/lib/printBinary';
import {first, insertLeft, insertRight, last, next, prev, remove} from 'sonic-forest/lib/util';
import {first2, insert2, last2, next2, prev2, remove2} from 'sonic-forest/lib/util2';
import {splay} from 'sonic-forest/lib/splay/util';
import {Anchor} from '../rga/constants';
import {OverlayPoint} from './OverlayPoint';
import {MarkerOverlayPoint} from './MarkerOverlayPoint';
import {OverlayRefSliceEnd, OverlayRefSliceStart} from './refs';
import {compare, type ITimestampStruct} from '../../../json-crdt-patch/clock';
import {CONST, updateNum} from '../../../json-hash';
import {MarkerSlice} from '../slice/MarkerSlice';
import {UndefEndIter, type UndefIterator} from '../../../util/iterator';
import {SliceBehavior} from '../slice/constants';
import type {Point} from '../rga/Point';
import type {Range} from '../rga/Range';
import type {Chunk} from '../../../json-crdt/nodes/rga';
import type {Peritext} from '../Peritext';
import type {Stateful} from '../types';
import type {Printable} from 'tree-dump/lib/types';
import type {MutableSlice, Slice, SliceType} from '../slice/types';
import type {Slices} from '../slice/Slices';
import type {MarkerOverlayPair, OverlayPair, OverlayTuple} from './types';
import type {Comparator} from 'sonic-forest/lib/types';
 
const spatialComparator: Comparator<OverlayPoint> = (a: OverlayPoint, b: OverlayPoint) => a.cmpSpatial(b);
 
/**
 * Overlay is a tree structure that represents all the intersections of slices
 * in the text. It is used to quickly find all the slices that overlap a
 * given point in the text. The overlay is a read-only structure, its state
 * is changed only by calling the `refresh` method, which updates the overlay
 * based on the current state of the text and slices.
 */
export class Overlay<T = string> implements Printable, Stateful {
  public root: OverlayPoint<T> | undefined = undefined;
  public root2: MarkerOverlayPoint<T> | undefined = undefined;
 
  /** A virtual absolute start point, used when the absolute start is missing. */
  public readonly START: OverlayPoint<T>;
 
  /** A virtual absolute end point, used when the absolute end is missing. */
  public readonly END: OverlayPoint<T>;
 
  constructor(protected readonly txt: Peritext<T>) {
    const id = txt.str.id;
    this.START = this.point(id, Anchor.After);
    this.END = this.point(id, Anchor.Before);
  }
 
  private point(id: ITimestampStruct, anchor: Anchor): OverlayPoint<T> {
    return new OverlayPoint(this.txt.str, id, anchor);
  }
 
  private mPoint(marker: MarkerSlice<T>, anchor: Anchor): MarkerOverlayPoint<T> {
    return new MarkerOverlayPoint(this.txt.str, marker.start.id, anchor, marker);
  }
 
  public first(): OverlayPoint<T> | undefined {
    return this.root ? first(this.root) : undefined;
  }
 
  public last(): OverlayPoint<T> | undefined {
    return this.root ? last(this.root) : undefined;
  }
 
  public firstMarker(): MarkerOverlayPoint<T> | undefined {
    return this.root2 ? first2(this.root2) : undefined;
  }
 
  public lastMarker(): MarkerOverlayPoint<T> | undefined {
    return this.root2 ? last2(this.root2) : undefined;
  }
 
  /**
   * Retrieve overlay point or the previous one, measured in spacial dimension.
   */
  public getOrNextLower(point: Point<T>): OverlayPoint<T> | undefined {
    if (point.isAbsStart()) {
      const first = this.first();
      if (!first) return;
      return first.isAbsStart() ? first : void 0;
    } else if (point.isAbsEnd()) return this.last();
    let curr: OverlayPoint<T> | undefined = this.root;
    let result: OverlayPoint<T> | undefined = undefined;
    while (curr) {
      const cmp = curr.cmpSpatial(point);
      if (cmp === 0) return curr;
      if (cmp > 0) curr = curr.l;
      else {
        const next = curr.r;
        result = curr;
        if (!next) return result;
        curr = next;
      }
    }
    return result;
  }
 
  /**
   * Retrieve overlay point or the next one, measured in spacial dimension.
   */
  public getOrNextHigher(point: Point<T>): OverlayPoint<T> | undefined {
    if (point.isAbsEnd()) {
      const last = this.last();
      Iif (!last) return;
      return last.isAbsEnd() ? last : void 0;
    } else if (point.isAbsStart()) return this.first();
    let curr: OverlayPoint<T> | undefined = this.root;
    let result: OverlayPoint<T> | undefined = undefined;
    while (curr) {
      const cmp = curr.cmpSpatial(point);
      if (cmp === 0) return curr;
      if (cmp < 0) curr = curr.r;
      else {
        const next = curr.l;
        result = curr;
        if (!next) return result;
        curr = next;
      }
    }
    return result;
  }
 
  /**
   * Retrieve a {@link MarkerOverlayPoint} at the specified point or the
   * previous one, measured in spacial dimension.
   */
  public getOrNextLowerMarker(point: Point<T>): MarkerOverlayPoint<T> | undefined {
    if (point.isAbsStart()) {
      const first = this.firstMarker();
      if (!first) return;
      return first.isAbsStart() ? first : void 0;
    } else if (point.isAbsEnd()) return this.lastMarker();
    let curr: MarkerOverlayPoint<T> | undefined = this.root2;
    let result: MarkerOverlayPoint<T> | undefined = undefined;
    while (curr) {
      const cmp = curr.cmpSpatial(point);
      if (cmp === 0) return curr;
      if (cmp > 0) curr = curr.l2;
      else {
        const next = curr.r2;
        result = curr;
        if (!next) return result;
        curr = next;
      }
    }
    return result;
  }
 
  /** @todo Rename to `chunks()`. */
  public chunkSlices0(
    chunk: Chunk<T> | undefined,
    p1: Point<T>,
    p2: Point<T>,
    callback: (chunk: Chunk<T>, off: number, len: number) => boolean | void,
  ): Chunk<T> | undefined {
    const rga = this.txt.str;
    const strId = rga.id;
    let checkFirstAnchor = p1.anchor === Anchor.After;
    const adjustForLastAnchor = p2.anchor === Anchor.Before;
    let id1 = p1.id;
    const id1IsStr = !compare(id1, strId);
    if (id1IsStr) {
      const first = rga.first();
      Iif (!first) return;
      id1 = first.id;
      checkFirstAnchor = false;
    }
    const id2 = p2.id;
    if (!checkFirstAnchor && !adjustForLastAnchor) {
      return rga.range0(chunk, id1, id2, callback) as Chunk<T>;
    }
    const sid1 = id1.sid;
    const time1 = id1.time;
    const sid2 = id2.sid;
    const time2 = id2.time;
    return rga.range0(undefined, id1, id2, (chunk: Chunk<T>, off: number, len: number): boolean | void => {
      if (checkFirstAnchor) {
        checkFirstAnchor = false;
        const chunkId = chunk.id;
        if (chunkId.sid === sid1 && chunkId.time + off === time1) {
          if (len <= 1) return;
          off += 1;
          len -= 1;
        }
      }
      if (adjustForLastAnchor) {
        const chunkId = chunk.id;
        if (chunkId.sid === sid2 && chunkId.time + off + len - 1 === time2) {
          if (len <= 1) return;
          len -= 1;
        }
      }
      Iif (callback(chunk, off, len)) return true;
    }) as Chunk<T>;
  }
 
  public points0(after: undefined | OverlayPoint<T>, inclusive?: boolean): UndefIterator<OverlayPoint<T>> {
    let curr = after ? (inclusive ? after : next(after)) : this.first();
    return () => {
      const ret = curr;
      if (curr) curr = next(curr);
      return ret;
    };
  }
 
  public points(after?: undefined | OverlayPoint<T>, inclusive?: boolean): IterableIterator<OverlayPoint<T>> {
    return new UndefEndIter(this.points0(after, inclusive));
  }
 
  /**
   * Returns all {@link MarkerOverlayPoint} instances in the overlay, starting
   * from the given marker point, not including the marker point itself.
   *
   * If the `after` parameter is not provided, the iteration starts from the
   * first marker point in the overlay.
   *
   * @param after The marker point after which to start the iteration.
   * @returns All marker points in the overlay, starting from the given marker
   *     point.
   */
  public markers0(after: undefined | MarkerOverlayPoint<T>): UndefIterator<MarkerOverlayPoint<T>> {
    let curr = after ? next2(after) : first2(this.root2);
    return () => {
      const ret = curr;
      if (curr) curr = next2(curr);
      return ret;
    };
  }
 
  public markers(after?: undefined | MarkerOverlayPoint<T>): UndefEndIter<MarkerOverlayPoint<T>> {
    return new UndefEndIter(this.markers0(after));
  }
 
  /**
   * Returns all {@link MarkerOverlayPoint} instances in the overlay, starting
   * from a give {@link Point}, including any marker overlay points that are
   * at the same position as the given point.
   *
   * @param point Point (inclusive) from which to return all markers.
   * @returns All marker points in the overlay, starting from the given marker
   *     point.
   */
  public markersFrom0(point: Point<T>): UndefIterator<MarkerOverlayPoint<T>> {
    if (point.isAbsStart()) return this.markers0(undefined);
    let after = this.getOrNextLowerMarker(point);
    if (after && after.cmp(point) === 0) after = prev2(after);
    return this.markers0(after);
  }
 
  /**
   * Returns a pair of overlay marker points for each pair of adjacent marker
   * points in the overlay, starting from a given point (which may not be a
   * marker). The very first point in the first pair might be `undefined`, if
   * the given point is not a marker. Similarly, the very last point in the last
   * pair might be `undefined`, if the iteration end point is not a marker.
   *
   * @param start Start point of the iteration, inclusive.
   * @param end End point of the iteration. If not provided, the iteration
   *     continues until the end of the overlay.
   * @returns Iterator that returns pairs of overlay points.
   */
  public markerPairs0(start: Point<T>, end?: Point<T>): UndefIterator<MarkerOverlayPair<T>> {
    const i = this.markersFrom0(start);
    let closed = false;
    let p1: MarkerOverlayPoint<T> | undefined;
    let p2: MarkerOverlayPoint<T> | undefined = i();
    if (p2) {
      if (p2.isAbsStart() || !p2.cmp(start)) {
        p1 = p2;
        p2 = i();
      }
      if (end && p2) {
        const cmp = end.cmpSpatial(p2);
        if (cmp <= 0) return () => (closed ? void 0 : ((closed = true), [p1, cmp ? void 0 : p2]));
      }
    }
    return () => {
      if (closed) return;
      if (!p2 || p2.isAbsEnd()) return (closed = true), [p1, p2];
      else if (p2 && end) {
        const cmp = end.cmpSpatial(p2);
        if (cmp <= 0) {
          closed = true;
          return [p1, cmp ? void 0 : p2];
        }
      }
      const result: MarkerOverlayPair<T> = [p1, p2];
      p1 = p2;
      p2 = i();
      return result;
    };
  }
 
  public pairs0(after: undefined | OverlayPoint<T>): UndefIterator<OverlayPair<T>> {
    const isEmpty = !this.root;
    if (isEmpty) {
      const u = undefined;
      let closed = false;
      return () => (closed ? u : ((closed = true), [u, u]));
    }
    let p1: OverlayPoint<T> | undefined;
    let p2: OverlayPoint<T> | undefined = after;
    const iterator = this.points0(after);
    return () => {
      const next = iterator();
      const isEnd = !next;
      if (isEnd) {
        if (!p2 || p2.isAbsEnd()) return;
        p1 = p2;
        p2 = undefined;
        return [p1, p2];
      }
      p1 = p2;
      p2 = next;
      if (!p1) {
        if (p2 && p2.isAbsStart()) {
          p1 = p2;
          p2 = iterator();
        }
      }
      return p1 || p2 ? [p1, p2] : undefined;
    };
  }
 
  public pairs(after?: undefined | OverlayPoint<T>): IterableIterator<OverlayPair<T>> {
    return new UndefEndIter(this.pairs0(after));
  }
 
  public tuples0(after: undefined | OverlayPoint<T>): UndefIterator<OverlayTuple<T>> {
    const iterator = this.pairs0(after);
    return () => {
      const pair = iterator();
      if (!pair) return;
      pair[0] ??= this.START;
      pair[1] ??= this.END;
      return pair as OverlayTuple<T>;
    };
  }
 
  public tuples(after?: undefined | OverlayPoint<T>): IterableIterator<OverlayTuple<T>> {
    return new UndefEndIter(this.tuples0(after));
  }
 
  /**
   * Finds the first point that satisfies the given predicate function.
   *
   * @param predicate Predicate function to find the point, returns true if the
   *     point is found.
   * @returns The first point that satisfies the predicate, or undefined if no
   *     point is found.
   */
  public find(predicate: (point: OverlayPoint<T>) => boolean): OverlayPoint<T> | undefined {
    let point = this.first();
    while (point) {
      if (predicate(point)) return point;
      point = next(point);
    }
    return;
  }
 
  /**
   * Finds all slices that are contained within the given range. A slice is
   * considered contained if its start and end points are within the range,
   * inclusive (uses {@link Range#contains} method to check containment).
   *
   * @param range The range to search for contained slices.
   * @returns A set of slices that are contained within the given range.
   */
  public findContained(range: Range<T>): Set<Slice<T>> {
    const result = new Set<Slice<T>>();
    let point = this.getOrNextLower(range.start) ?? this.first();
    if (!point) return result;
    do {
      if (!range.containsPoint(point)) continue;
      const slices = point.layers;
      const length = slices.length;
      for (let i = 0; i < length; i++) {
        const slice = slices[i];
        if (!result.has(slice) && range.contains(slice)) result.add(slice);
      }
      if (point instanceof MarkerOverlayPoint) {
        const marker = point.marker;
        if (marker && !result.has(marker) && range.contains(marker)) result.add(marker);
      }
    } while (point && (point = next(point)) && range.containsPoint(point));
    return result;
  }
 
  /**
   * Finds all slices that overlap with the given range. A slice is considered
   * overlapping if its start or end point is within the range, inclusive
   * (uses {@link Range#containsPoint} method to check overlap).
   *
   * @param range The range to search for overlapping slices.
   * @returns A set of slices that overlap with the given range.
   */
  public findOverlapping(range: Range<T>): Set<Slice<T>> {
    const result = new Set<Slice<T>>();
    let point: OverlayPoint<T> | undefined = this.getOrNextLower(range.start) ?? this.first();
    if (!point) return result;
    do {
      const slices = point.layers;
      const length = slices.length;
      for (let i = 0; i < length; i++) result.add(slices[i]);
      if (point instanceof MarkerOverlayPoint) {
        const marker = point.marker;
        if (marker) result.add(marker);
      }
    } while (point && (point = next(point)) && range.containsPoint(point));
    return result;
  }
 
  /**
   * Returns a summary of how different slice types overlap with the given range.
   *
   * @param range Range over which to search for slices.
   * @param endOnMarker If set to a positive number, the search will stop after
   *     the given number of marker points have been observed.
   * @returns Summary of the slices in this range. `complete` contains all
   *     "Overwrite" slice types, which overlay the full range, which have not
   *     been removed by "Erase" slice type. `partial` contains all "Overwrite"
   *     slice types, which mark a part of the range, and have not been removed
   *     by "Erase" slice type.
   */
  public stat(
    range: Range<T>,
    endOnMarker = 10,
  ): [complete: Set<SliceType>, partial: Set<SliceType>, markerCount: number] {
    const {start, end: end_} = range;
    let end = end_;
    const isSamePoint = start.cmp(end_) === 0;
    if (isSamePoint) {
      end = end.clone();
      end.halfstep(1);
    }
    const after = this.getOrNextLower(start);
    const hasLeadingPoint = !!after;
    const iterator = this.points0(after, true);
    let complete: Set<SliceType> = new Set<SliceType>();
    let partial: Set<SliceType> = new Set<SliceType>();
    let isFirst = true;
    let markerCount = 0;
    OVERLAY: for (let point = iterator(); point && point.cmpSpatial(end) < 0; point = iterator()) {
      if (point instanceof MarkerOverlayPoint) {
        markerCount++;
        if (markerCount >= endOnMarker) break;
        continue OVERLAY;
      }
      const current = new Set<SliceType>();
      const layers = point.layers;
      const length = layers.length;
      LAYERS: for (let i = 0; i < length; i++) {
        const slice = layers[i];
        const type = slice.type;
        Iif (typeof type === 'object') continue LAYERS;
        const behavior = slice.behavior;
        BEHAVIOR: switch (behavior) {
          case SliceBehavior.One:
            current.add(type);
            break BEHAVIOR;
          case SliceBehavior.Erase:
            current.delete(type);
            break BEHAVIOR;
        }
      }
      if (isFirst) {
        isFirst = false;
        if (hasLeadingPoint) complete = current;
        else partial = current;
        continue OVERLAY;
      }
      for (const type of complete)
        if (!current.has(type)) {
          complete.delete(type);
          partial.add(type);
        }
      for (const type of current) if (!complete.has(type)) partial.add(type);
    }
    return [complete, partial, markerCount];
  }
 
  /**
   * Returns `true` if the current character is a marker sentinel.
   *
   * @param id ID of the point to check.
   * @returns Whether the point is a marker point.
   */
  public isMarker(id: ITimestampStruct): boolean {
    const p = this.txt.point(id, Anchor.Before);
    const op = this.getOrNextLower(p);
    return op instanceof MarkerOverlayPoint && op.id.time === id.time && op.id.sid === id.sid;
  }
 
  public skipMarkers(point: Point<T>, direction: -1 | 1): boolean {
    while (true) {
      const isMarker = this.isMarker(point.id);
      Iif (!isMarker) return true;
      const end = point.step(direction);
      Iif (end) break;
    }
    return false;
  }
 
  // ----------------------------------------------------------------- Stateful
 
  public hash: number = 0;
 
  public refresh(slicesOnly: boolean = false): number {
    const txt = this.txt;
    let hash: number = CONST.START_STATE;
    hash = this.refreshSlices(hash, txt.savedSlices);
    hash = this.refreshSlices(hash, txt.extraSlices);
    hash = this.refreshSlices(hash, txt.localSlices);
 
    // TODO: Move test hash calculation out of the overlay.
    if (!slicesOnly) {
      // hash = updateRga(hash, txt.str);
      hash = this.refreshTextSlices(hash);
    }
    return (this.hash = hash);
  }
 
  public readonly slices = new Map<Slice<T>, [start: OverlayPoint<T>, end: OverlayPoint<T>]>();
 
  private refreshSlices(state: number, slices: Slices<T>): number {
    const oldSlicesHash = slices.hash;
    const changed = oldSlicesHash !== slices.refresh();
    const sliceSet = this.slices;
    state = updateNum(state, slices.hash);
    if (changed) {
      // biome-ignore lint: slices is not iterable
      slices.forEach((slice) => {
        let tuple: [start: OverlayPoint<T>, end: OverlayPoint<T>] | undefined = sliceSet.get(slice);
        if (tuple) {
          Iif ((slice as any).isDel && (slice as any).isDel()) {
            this.delSlice(slice, tuple);
            return;
          }
          const positionMoved = tuple[0].cmp(slice.start) !== 0 || tuple[1].cmp(slice.end) !== 0;
          if (positionMoved) this.delSlice(slice, tuple);
          else return;
        }
        tuple = slice instanceof MarkerSlice ? this.insMarker(slice) : this.insSlice(slice);
        this.slices.set(slice, tuple);
      });
      if (slices.size() < sliceSet.size) {
        sliceSet.forEach((tuple, slice) => {
          const mutSlice = slice as Slice | MutableSlice;
          if ((<MutableSlice>mutSlice).isDel) {
            if (!(<MutableSlice>mutSlice).isDel()) return;
            this.delSlice(slice, tuple);
          }
        });
      }
    }
    return state;
  }
 
  private insSlice(slice: Slice<T>): [start: OverlayPoint<T>, end: OverlayPoint<T>] {
    const x0 = slice.start;
    const x1 = slice.end;
    const [start, isStartNew] = this.upsertPoint(x0);
    const [end, isEndNew] = this.upsertPoint(x1);
    const isCollapsed = x0.cmp(x1) === 0;
    start.refs.push(new OverlayRefSliceStart(slice));
    end.refs.push(new OverlayRefSliceEnd(slice));
    if (isStartNew) {
      const beforeStartPoint = prev(start);
      if (beforeStartPoint) start.layers.push(...beforeStartPoint.layers);
    }
    if (!isCollapsed) {
      if (isEndNew) {
        const beforeEndPoint = prev(end);
        if (beforeEndPoint) end.layers.push(...beforeEndPoint.layers);
      }
      let curr: OverlayPoint<T> | undefined = start;
      do curr.addLayer(slice);
      while ((curr = next(curr)) && curr !== end);
    } else start.addMarker(slice);
    return [start, end];
  }
 
  private insMarker(slice: MarkerSlice<T>): [start: OverlayPoint<T>, end: OverlayPoint<T>] {
    const point = this.mPoint(slice, Anchor.Before);
    const pivot = this.insPoint(point);
    if (!pivot) {
      point.refs.push(slice);
      const prevPoint = prev(point);
      if (prevPoint) point.layers.push(...prevPoint.layers);
    }
    return [point, point];
  }
 
  private delSlice(slice: Slice<T>, [start, end]: [start: OverlayPoint<T>, end: OverlayPoint<T>]): void {
    this.slices.delete(slice);
    let curr: OverlayPoint<T> | undefined = start;
    do {
      curr.removeLayer(slice);
      curr.removeMarker(slice);
      curr = next(curr);
    } while (curr && curr !== end);
    start.removeRef(slice);
    end.removeRef(slice);
    if (!start.refs.length) this.delPoint(start);
    if (!end.refs.length && start !== end) this.delPoint(end);
  }
 
  /**
   * Retrieve an existing {@link OverlayPoint} or create a new one, inserted
   * in the tree, sorted by spatial dimension.
   */
  private upsertPoint(point: Point<T>): [point: OverlayPoint<T>, isNew: boolean] {
    const newPoint = this.point(point.id, point.anchor);
    const pivot = this.insPoint(newPoint);
    if (pivot) return [pivot, false];
    return [newPoint, true];
  }
 
  /**
   * Inserts a point into the tree, sorted by spatial dimension.
   * @param point Point to insert.
   * @returns Returns the existing point if it was already in the tree.
   */
  private insPoint(point: OverlayPoint<T>): OverlayPoint<T> | undefined {
    if (point instanceof MarkerOverlayPoint) {
      this.root2 = insert2(this.root2, point, spatialComparator);
      // if (this.root2 !== point) this.root2 = splay2(this.root2!, point, 10);
    }
    let pivot = this.getOrNextLower(point);
    if (!pivot) pivot = first(this.root);
    if (!pivot) {
      this.root = point;
      return;
    } else {
      if (pivot.cmp(point) === 0) return pivot;
      const cmp = pivot.cmpSpatial(point);
      if (cmp < 0) insertRight(point, pivot);
      else insertLeft(point, pivot);
    }
    if (this.root !== point) this.root = splay(this.root!, point, 10);
    return;
  }
 
  private delPoint(point: OverlayPoint<T>): void {
    if (point instanceof MarkerOverlayPoint) this.root2 = remove2(this.root2, point);
    this.root = remove(this.root, point);
  }
 
  public leadingTextHash: number = 0;
 
  protected refreshTextSlices(stateTotal: number): number {
    const txt = this.txt;
    const str = txt.str;
    const firstChunk = str.first();
    if (!firstChunk) return stateTotal;
    let chunk: Chunk<T> | undefined = firstChunk;
    let marker: MarkerOverlayPoint<T> | undefined = undefined;
    const i = this.tuples0(undefined);
    let state: number = CONST.START_STATE;
    for (let pair = i(); pair; pair = i()) {
      const [p1, p2] = pair;
      const id1 = p1.id;
      state = (state << 5) + state + (id1.sid >>> 0) + id1.time;
      let overlayPointHash = CONST.START_STATE;
      chunk = this.chunkSlices0(chunk || firstChunk, p1, p2, (chunk, off, len) => {
        const id = chunk.id;
        overlayPointHash =
          (overlayPointHash << 5) + overlayPointHash + ((((id.sid >>> 0) + id.time) << 8) + (off << 4) + len);
      });
      state = updateNum(state, overlayPointHash);
      for (const slice of p1.layers) state = updateNum(state, slice.hash);
      for (const slice of p1.markers) state = updateNum(state, slice.hash);
      p1.hash = overlayPointHash;
      stateTotal = updateNum(stateTotal, overlayPointHash);
      if (p2 instanceof MarkerOverlayPoint) {
        if (marker) {
          marker.textHash = state;
        } else {
          this.leadingTextHash = state;
        }
        stateTotal = updateNum(stateTotal, state);
        state = CONST.START_STATE;
        marker = p2;
      }
    }
    if ((marker as any) instanceof MarkerOverlayPoint) {
      (marker as any as MarkerOverlayPoint<T>).textHash = state;
    } else {
      this.leadingTextHash = state;
    }
    return stateTotal;
  }
 
  // ---------------------------------------------------------------- Printable
 
  public toString(tab: string = ''): string {
    const printPoint = (tab: string, point: OverlayPoint<T>): string => {
      return (
        point.toString(tab) +
        printBinary(tab, [
          !point.l ? null : (tab) => printPoint(tab, point.l!),
          !point.r ? null : (tab) => printPoint(tab, point.r!),
        ])
      );
    };
    const printMarkerPoint = (tab: string, point: MarkerOverlayPoint<T>): string => {
      return (
        point.toString(tab) +
        printBinary(tab, [
          !point.l2 ? null : (tab) => printMarkerPoint(tab, point.l2!),
          !point.r2 ? null : (tab) => printMarkerPoint(tab, point.r2!),
        ])
      );
    };
    return (
      `Overlay #${this.hash.toString(36)}` +
      printTree(tab, [
        !this.root ? null : (tab) => printPoint(tab, this.root!),
        !this.root2 ? null : (tab) => printMarkerPoint(tab, this.root2!),
      ])
    );
  }
}