mixdog 0.9.3 → 0.9.4

package/src/tui/app/use-transcript-scroll.mjs

@@ -0,0 +1,510 @@
+/**
+ * use-transcript-scroll.mjs — transcript scroll + ink-grid selection engine.
+ *
+ * Extracted verbatim from App.jsx: smooth scroll animation, reading-anchor
+ * capture, selection painting/throttling/clipping, word-line span extension,
+ * keyboard selection focus movement and the wheel/edge-drag coalescer.
+ * Scroll/drag state refs stay App-owned and are injected; this hook owns only
+ * its internal timers (animation interval, selection paint throttle, text
+ * capture defer, scroll coalescer).
+ */
+import { useCallback, useEffect, useRef } from 'react';
+import { theme } from '../theme.mjs';
+import {
+  SELECTION_PAINT_INTERVAL_MS,
+  SCROLL_COALESCE_MS,
+  selectionRectsEqual,
+  shiftSelectionRectY,
+  comparePoints,
+  upperBound,
+} from './transcript-window.mjs';
+
+export function useTranscriptScroll({
+  store,
+  frameColumns,
+  statuslineBandRows,
+  setScrollOffset,
+  scrollPositionRef,
+  scrollTargetRef,
+  maxScrollRowsRef,
+  transcriptBottomSlackRowsRef,
+  followingRef,
+  transcriptAnchorRef,
+  transcriptAnchorDirtyRef,
+  transcriptGeomRef,
+  dragRef,
+  frameRowsRef,
+  transcriptViewportRef,
+  selectionLayoutRef,
+  selectionTextRef,
+}) {
+  const scrollAnimationRef = useRef(null);
+  const selectionPaintRef = useRef({ t: 0, rect: null, pending: null, timer: null });
+  // Coalescer for edge-drag auto-scroll + wheel scroll deltas (see
+  // SCROLL_COALESCE_MS). Both call sites accumulate into pendingRows.
+  const scrollCoalesceRef = useRef({ pendingRows: 0, timer: null });
+  const selectionTextTimerRef = useRef(null);
+
+  const stopSmoothScroll = useCallback(() => {
+    if (!scrollAnimationRef.current) return;
+    clearInterval(scrollAnimationRef.current);
+    scrollAnimationRef.current = null;
+  }, []);
+
+  const startSmoothScroll = useCallback(() => {
+    if (scrollAnimationRef.current) return;
+    scrollAnimationRef.current = setInterval(() => {
+      const current = scrollPositionRef.current;
+      const target = scrollTargetRef.current;
+      const next = current + (target - current) * 0.32;
+      if (Math.abs(target - next) < 0.12) {
+        scrollPositionRef.current = target;
+        setScrollOffset(Math.max(0, Math.round(target)));
+        followingRef.current = false;
+        stopSmoothScroll();
+        return;
+      }
+      scrollPositionRef.current = Math.max(0, next);
+      setScrollOffset(Math.max(0, Math.round(scrollPositionRef.current)));
+    }, 16);
+    scrollAnimationRef.current.unref?.();
+  }, [stopSmoothScroll]);
+
+  const cancelTranscriptFollow = useCallback(() => {
+    followingRef.current = false;
+  }, []);
+
+  const resetTranscriptScroll = useCallback(() => {
+    cancelTranscriptFollow();
+    stopSmoothScroll();
+    scrollPositionRef.current = 0;
+    scrollTargetRef.current = 0;
+    transcriptAnchorRef.current = null;
+    transcriptAnchorDirtyRef.current = false;
+    setScrollOffset(0);
+  }, [stopSmoothScroll, cancelTranscriptFollow]);
+
+  const armTranscriptFollow = useCallback(() => {
+    // Do not mutate scrollOffset here. During prompt submit the transcript rows
+    // have not necessarily been committed yet; resetting immediately makes a
+    // long transcript jump to the bottom, then jump again when the new row is
+    // appended. Keep the current viewport stable and let the row-delta effect
+    // perform the single bottom-follow when the transcript actually grows.
+    transcriptAnchorRef.current = null;
+    transcriptAnchorDirtyRef.current = false;
+    followingRef.current = true;
+    stopSmoothScroll();
+  }, [stopSmoothScroll]);
+
+  const rememberSelectionTextSoon = useCallback(() => {
+    if (selectionTextTimerRef.current) return;
+    selectionTextTimerRef.current = setTimeout(() => {
+      selectionTextTimerRef.current = null;
+      const text = store.getRenderSelectionText?.();
+      if (text && text.trim()) selectionTextRef.current = text;
+    }, 0);
+  }, [store]);
+
+  const selectionClip = useCallback(() => {
+    // The status-bar grid selection lives in the bottom statusline band, not the
+    // transcript viewport — clip there so the highlight cannot spill into the
+    // prompt/transcript rows. Everything else (transcript, word-select) keeps the
+    // transcript-viewport clip.
+    if (dragRef.current.region === 'status') {
+      const rows = Math.max(1, Number(frameRowsRef.current) || 24);
+      const top = Math.max(0, rows - statuslineBandRows);
+      return { y1: top, y2: Math.max(top, rows - 1) };
+    }
+    return {
+      y1: Math.max(0, Number(transcriptViewportRef.current?.top) || 0),
+      y2: Math.max(0, Number(transcriptViewportRef.current?.bottom) || 0),
+    };
+  }, []);
+
+  const withSelectionClip = useCallback((rect, options = {}) => {
+    if (!rect) return null;
+    const clip = selectionClip();
+    const clipped = {
+      ...rect,
+      clipY1: clip.y1,
+      clipY2: Math.max(clip.y1, clip.y2),
+      selectionForeground: theme.selectionHighlightText || theme.selectionText,
+      selectionBackground: theme.selectionHighlightBackground || theme.selectionBackground,
+    };
+    if (options.captureText === false) clipped.captureText = false;
+    return clipped;
+  }, [selectionClip]);
+
+  const paintSelectionRect = useCallback((clippedRect, { rememberText = true, immediate = false } = {}) => {
+    const nextRect = clippedRect || null;
+    const state = selectionPaintRef.current;
+    if (selectionRectsEqual(state.rect, nextRect)) {
+      const needsCapture = nextRect && rememberText && nextRect.captureText !== false;
+      if (!immediate && !needsCapture) return false;
+      if (immediate || needsCapture) {
+        store.setRenderSelection?.(nextRect, { immediate: true });
+      }
+      if (needsCapture) rememberSelectionTextSoon();
+      return true;
+    }
+    state.rect = nextRect;
+    state.t = Date.now();
+    store.setRenderSelection?.(nextRect, immediate ? { immediate: true } : undefined);
+    if (nextRect && rememberText && nextRect.captureText !== false) rememberSelectionTextSoon();
+    return true;
+  }, [store, rememberSelectionTextSoon]);
+
+  const applySelectionRect = useCallback((rect) => {
+    const clippedRect = withSelectionClip(rect);
+    dragRef.current.rect = clippedRect || null;
+    if (!clippedRect) selectionTextRef.current = '';
+    const state = selectionPaintRef.current;
+    if (state.timer) {
+      clearTimeout(state.timer);
+      state.timer = null;
+      state.pending = null;
+    }
+    paintSelectionRect(clippedRect, { rememberText: true, immediate: true });
+  }, [paintSelectionRect, withSelectionClip]);
+
+  const applySelectionRectThrottled = useCallback((rect) => {
+    const clippedRect = withSelectionClip(rect, { captureText: false });
+    if (selectionRectsEqual(dragRef.current.rect, clippedRect)) return;
+    dragRef.current.rect = clippedRect || null;
+    const state = selectionPaintRef.current;
+    if (selectionRectsEqual(state.rect, clippedRect)) return;
+    const now = Date.now();
+    const elapsed = now - state.t;
+    if (elapsed >= SELECTION_PAINT_INTERVAL_MS) {
+      if (state.timer) {
+        clearTimeout(state.timer);
+        state.timer = null;
+        state.pending = null;
+      }
+      paintSelectionRect(clippedRect, { rememberText: false });
+      return;
+    }
+    state.pending = clippedRect || null;
+    if (!state.timer) {
+      state.timer = setTimeout(() => {
+        const current = selectionPaintRef.current;
+        const pending = current.pending;
+        current.timer = null;
+        current.pending = null;
+        paintSelectionRect(pending, { rememberText: false });
+      }, Math.max(1, SELECTION_PAINT_INTERVAL_MS - elapsed));
+      state.timer.unref?.();
+    }
+  }, [paintSelectionRect, withSelectionClip]);
+
+  const selectionPointAtCurrentScroll = useCallback((point, pointScroll = 0) => {
+    if (!point) return null;
+    return {
+      x: point.x,
+      y: point.y + (Number(scrollTargetRef.current) || 0) - (Number(pointScroll) || 0),
+    };
+  }, []);
+
+  // Port of selection.ts extendSelection onto the linear-rect model, hoisted to
+  // component scope so BOTH the mouse handler (motion/release) AND the
+  // auto-scroll path (scrollTranscriptRows) can rebuild a span-aware rect. Grows
+  // a word/line multi-click selection from its anchor span to the word/line under
+  // the cursor: target ends before the span → extend backward (span.hi→targetLo);
+  // target starts after → extend forward (span.lo→targetHi); overlapping → the
+  // span. The moving end snaps to the word (getWordRectAt) or line (getLineRectAt)
+  // at the cursor; a miss (blank/gutter) falls back to the raw cell. spanScroll
+  // re-anchors the span to the current transcript scroll (status never scrolls) so
+  // the original word/line tracks the content while dragging/auto-scrolling.
+  const buildSpanRect = useCallback((span, x, y, region, spanScroll = 0) => {
+    const conv = (pt) => (region === 'status' ? pt : selectionPointAtCurrentScroll(pt, spanScroll));
+    const spanLo = conv(span.lo);
+    const spanHi = conv(span.hi);
+    let mLo;
+    let mHi;
+    if (span.kind === 'word') {
+      const wr = store.getWordRectAt?.(x, y);
+      if (wr) { mLo = { x: wr.x1, y: wr.y1 }; mHi = { x: wr.x2, y: wr.y2 }; }
+      else { mLo = { x, y }; mHi = { x, y }; }
+    } else {
+      const lr = store.getLineRectAt?.(y);
+      if (lr) { mLo = { x: lr.x1, y: lr.y1 }; mHi = { x: lr.x2, y: lr.y2 }; }
+      else { mLo = { x: 0, y }; mHi = { x, y }; }
+    }
+    const rect = (a, b) => ({ mode: 'linear', x1: a.x, y1: a.y, x2: b.x, y2: b.y });
+    if (comparePoints(mHi, spanLo) < 0) return rect(spanHi, mLo);
+    if (comparePoints(mLo, spanHi) > 0) return rect(spanLo, mHi);
+    return rect(spanLo, spanHi);
+  }, [store, selectionPointAtCurrentScroll]);
+
+  const transcriptViewportRows = useCallback(() => {
+    const top = Math.max(0, Number(transcriptViewportRef.current?.top) || 0);
+    const bottom = Math.max(top, Number(transcriptViewportRef.current?.bottom) || top);
+    return { top, bottom };
+  }, []);
+
+  const statusBandRows = useCallback(() => {
+    const rows = Math.max(1, Number(frameRowsRef.current) || 24);
+    const top = Math.max(0, rows - statuslineBandRows);
+    return { top, bottom: Math.max(top, rows - 1) };
+  }, []);
+
+  const selectionMaxColAtRow = useCallback((row) => {
+    const lr = store.getLineRectAt?.(row);
+    if (lr != null && Number.isFinite(lr.x2)) return Math.max(0, lr.x2);
+    return Math.max(0, frameColumns - 1);
+  }, [store, frameColumns]);
+
+  // Synchronous predicate: is a transcript/status ink-grid selection live? Used
+  // both by App (to consume Shift+Arrow even when focus clamps at an edge) and
+  // by PromptInput (via prop) to gate its own Shift+Arrow at event time — a flag
+  // set inside App's parent handler would be one event stale (parent handler
+  // runs AFTER the child prompt handler for the same key).
+  const gridSelectionActiveRef = useRef(() => {
+    const drag = dragRef.current;
+    if (!drag || drag.active) return false;
+    if (drag.region !== 'transcript' && drag.region !== 'status') return false;
+    const rect = drag.rect;
+    return Boolean(rect) && !(rect.x1 === rect.x2 && rect.y1 === rect.y2);
+  });
+
+  useEffect(() => () => {
+    const paintState = selectionPaintRef.current;
+    if (paintState.timer) clearTimeout(paintState.timer);
+    paintState.timer = null;
+    paintState.pending = null;
+    if (selectionTextTimerRef.current) clearTimeout(selectionTextTimerRef.current);
+    selectionTextTimerRef.current = null;
+    const coalesceState = scrollCoalesceRef.current;
+    if (coalesceState.timer) clearTimeout(coalesceState.timer);
+    coalesceState.timer = null;
+    coalesceState.pendingRows = 0;
+  }, []);
+
+  const scrollTranscriptRows = useCallback((deltaRows, options = {}) => {
+    const maxTarget = Math.max(0, Number(maxScrollRowsRef.current) || 0);
+    const target = Math.max(0, Math.min(maxTarget, scrollTargetRef.current + deltaRows));
+    const appliedDelta = target - scrollTargetRef.current;
+    // Any manual wheel/keyboard scroll takes precedence over an in-flight
+    // transcript follow: drop the glide so the user's intent wins.
+    if (appliedDelta !== 0) cancelTranscriptFollow();
+    scrollTargetRef.current = target;
+    // A manual scroll moves the reading position. Capture the new reading anchor
+    // SYNCHRONOUSLY from the latest published geometry so the very next render
+    // already locks to it — no one-frame "dirty" window where concurrent
+    // streaming growth could lurch the view. At/over the bottom, drop the anchor
+    // so the bottom-follow path owns the viewport again.
+    if (appliedDelta !== 0) {
+      if (target <= Math.max(0, Number(transcriptBottomSlackRowsRef.current) || 0)) {
+        transcriptAnchorRef.current = null;
+        transcriptAnchorDirtyRef.current = false;
+      } else {
+        const geom = transcriptGeomRef.current || {};
+        const prefixRows = geom.prefixRows;
+        if (Array.isArray(prefixRows) && prefixRows.length > 1) {
+          const gTotal = Math.max(0, Number(geom.totalRows) || 0);
+          const gView = Math.max(1, Number(geom.viewRows) || 1);
+          const anchorRow = Math.max(0, Math.min(gTotal, gTotal - target - gView));
+          let idx = upperBound(prefixRows, anchorRow) - 1;
+          if (idx < 0) idx = 0;
+          if (idx > prefixRows.length - 2) idx = prefixRows.length - 2;
+          const items = geom.items || [];
+          const anchorItem = items[idx];
+          if (anchorItem && anchorItem.id != null) {
+            transcriptAnchorRef.current = { id: anchorItem.id, offset: Math.max(0, anchorRow - (prefixRows[idx] || 0)) };
+            transcriptAnchorDirtyRef.current = false;
+          } else {
+            transcriptAnchorDirtyRef.current = true;
+          }
+        } else {
+          transcriptAnchorDirtyRef.current = true;
+        }
+      }
+    }
+    if (appliedDelta !== 0 && selectionLayoutRef.current) {
+      selectionLayoutRef.current = { ...selectionLayoutRef.current, scrollOffset: target };
+    }
+    if (appliedDelta !== 0 && dragRef.current.rect) {
+      let rect;
+      if (dragRef.current.active) {
+        const { anchor, anchorScroll, last, anchorSpan, region } = dragRef.current;
+        if (anchorSpan && last) {
+          // Word/line multi-click drag that reached the edge: keep extending by
+          // whole words/lines from the span to the word/line at the current cell,
+          // NOT collapsing to a char {anchor->last} rect. Mirrors the motion path.
+          rect = buildSpanRect(anchorSpan, last.x, last.y, region, anchorScroll);
+        } else {
+          const currentAnchor = selectionPointAtCurrentScroll(anchor, anchorScroll);
+          rect = currentAnchor && last ? { mode: 'linear', x1: currentAnchor.x, y1: currentAnchor.y, x2: last.x, y2: last.y } : null;
+        }
+      } else {
+        rect = shiftSelectionRectY(dragRef.current.rect, appliedDelta);
+      }
+      const clippedRect = withSelectionClip(rect);
+      dragRef.current = { ...dragRef.current, rect: clippedRect };
+      paintSelectionRect(clippedRect, { rememberText: !dragRef.current.active });
+    }
+    if (options.smooth) {
+      startSmoothScroll();
+      return;
+    }
+    stopSmoothScroll();
+    scrollPositionRef.current = target;
+    setScrollOffset(Math.round(target));
+  }, [startSmoothScroll, stopSmoothScroll, paintSelectionRect, selectionPointAtCurrentScroll, withSelectionClip, cancelTranscriptFollow, buildSpanRect]);
+
+  // Leading-edge coalescer for edge-drag auto-scroll + wheel deltas: the first
+  // delta after an idle period flushes immediately (single wheel ticks/short
+  // drags stay responsive), while a flood of deltas within SCROLL_COALESCE_MS
+  // accumulates into one scrollTranscriptRows call per tick instead of one per
+  // mousemove/wheel event. Both call sites below route through this instead of
+  // calling scrollTranscriptRows directly.
+  const queueScrollCoalesced = useCallback((deltaRows) => {
+    const state = scrollCoalesceRef.current;
+    state.pendingRows += deltaRows;
+    if (state.timer) return;
+    const rows = state.pendingRows;
+    state.pendingRows = 0;
+    scrollTranscriptRows(rows);
+    state.timer = setTimeout(() => {
+      state.timer = null;
+      if (state.pendingRows !== 0) {
+        const remaining = state.pendingRows;
+        state.pendingRows = 0;
+        scrollTranscriptRows(remaining);
+      }
+    }, SCROLL_COALESCE_MS);
+    state.timer.unref?.();
+  }, [scrollTranscriptRows]);
+
+  // NOTE: declared AFTER scrollTranscriptRows — it appears in the deps array
+  // below, and useCallback deps are evaluated at render time, so referencing
+  // it before its const initializer would throw a TDZ ReferenceError.
+  const moveSelectionFocus = useCallback((move) => {
+    const drag = dragRef.current;
+    if (drag.active) return false;
+    const region = drag.region;
+    if (region !== 'transcript' && region !== 'status') return false;
+    const rect = drag.rect;
+    if (!rect) return false;
+    if (rect.x1 === rect.x2 && rect.y1 === rect.y2) return false;
+
+    let anchor = { x: rect.x1, y: rect.y1 };
+    let col = rect.x2;
+    let row = rect.y2;
+    const beforeCol = col;
+    const beforeRow = row;
+    // Set when Shift+Up/Down hits the viewport edge and we scroll the
+    // transcript to reveal a new row rather than moving within the current
+    // viewport (mirrors the mouse edge-drag auto-scroll at the drag-motion
+    // handler). In that case row/col numerically equal their "before" values
+    // (both clamp to the same viewport edge index) even though the
+    // underlying content changed, so the generic before/after guard below
+    // must not treat it as a no-op.
+    let scrolledEdge = false;
+
+    const { top, bottom } = region === 'status' ? statusBandRows() : transcriptViewportRows();
+
+    switch (move) {
+      case 'left':
+        if (col > 0) col -= 1;
+        else if (row > top) {
+          row -= 1;
+          col = selectionMaxColAtRow(row);
+        }
+        break;
+      case 'right': {
+        const maxCol = selectionMaxColAtRow(row);
+        if (col < maxCol) col += 1;
+        else if (row < bottom) {
+          row += 1;
+          col = 0;
+        }
+        break;
+      }
+      case 'up':
+        if (row > top) {
+          row -= 1;
+        } else if (region === 'transcript') {
+          // Already at the top visible row: scroll the transcript up by one
+          // row (same direction as the mouse edge-drag auto-scroll at the
+          // top edge, App.jsx ~3060) instead of clamping the selection in
+          // place, then extend the focus onto the newly revealed top row.
+          const beforeTarget = scrollTargetRef.current;
+          scrollTranscriptRows(1);
+          if (scrollTargetRef.current !== beforeTarget) {
+            scrolledEdge = true;
+            // scrollTranscriptRows REPLACES dragRef.current with a shifted
+            // copy — re-read it; the local `drag` binding is stale here.
+            const shiftedRect = dragRef.current.rect;
+            if (shiftedRect) anchor = { x: shiftedRect.x1, y: shiftedRect.y1 };
+            row = top;
+          }
+        }
+        break;
+      case 'down':
+        if (row < bottom) {
+          row += 1;
+        } else if (region === 'transcript') {
+          // Already at the bottom visible row: scroll down by one row (mirrors
+          // the mouse edge-drag auto-scroll at the bottom edge, App.jsx
+          // ~3062) instead of clamping, then extend the focus onto the newly
+          // revealed bottom row.
+          const beforeTarget = scrollTargetRef.current;
+          scrollTranscriptRows(-1);
+          if (scrollTargetRef.current !== beforeTarget) {
+            scrolledEdge = true;
+            // Re-read post-scroll dragRef.current (see 'up' case).
+            const shiftedRect = dragRef.current.rect;
+            if (shiftedRect) anchor = { x: shiftedRect.x1, y: shiftedRect.y1 };
+            row = bottom;
+          }
+        }
+        break;
+      case 'lineStart':
+        col = 0;
+        break;
+      case 'lineEnd':
+        col = selectionMaxColAtRow(row);
+        break;
+      default:
+        return false;
+    }
+
+    row = Math.max(top, Math.min(bottom, row));
+    col = Math.max(0, Math.min(selectionMaxColAtRow(row), col));
+
+    if (!scrolledEdge && col === beforeCol && row === beforeRow) return false;
+
+    // After an edge scroll dragRef.current is a NEW object; mutate the live
+    // one, not the stale entry binding.
+    const dragNow = dragRef.current;
+    if (dragNow.anchorSpan) dragNow.anchorSpan = null;
+
+    const focus = { x: col, y: row };
+    applySelectionRect({
+      mode: 'linear',
+      x1: anchor.x,
+      y1: anchor.y,
+      x2: focus.x,
+      y2: focus.y,
+    });
+    dragNow.last = { x: focus.x, y: focus.y };
+    return true;
+  }, [applySelectionRect, statusBandRows, transcriptViewportRows, selectionMaxColAtRow, scrollTranscriptRows]);
+
+  return {
+    stopSmoothScroll,
+    resetTranscriptScroll,
+    armTranscriptFollow,
+    withSelectionClip,
+    paintSelectionRect,
+    applySelectionRect,
+    applySelectionRectThrottled,
+    selectionPointAtCurrentScroll,
+    buildSpanRect,
+    gridSelectionActiveRef,
+    scrollTranscriptRows,
+    queueScrollCoalesced,
+    moveSelectionFocus,
+  };
+}