Skip to main content

hjkl_engine/
editor.rs

1//! Editor — the public sqeel-vim type, layered over `hjkl_buffer::View`.
2//!
3//! This file owns the public Editor API — construction, content access,
4//! mouse and goto helpers, the (buffer-level) undo stack, and insert-mode
5//! session bookkeeping. All vim-specific keyboard handling lives in
6//! [`vim`] and communicates with Editor through a small internal API
7//! exposed via `pub(super)` fields and helper methods.
8
9use std::sync::atomic::{AtomicU16, Ordering};
10use std::time::SystemTime;
11
12/// Map a [`hjkl_buffer::Edit`] to one or more SPEC
13/// [`crate::types::Edit`] (`EditOp`) records.
14///
15/// Most buffer edits map to a single EditOp. Block ops
16/// ([`hjkl_buffer::Edit::InsertBlock`] /
17/// [`hjkl_buffer::Edit::DeleteBlockChunks`]) emit one EditOp per row
18/// touched — they edit non-contiguous cells and a single
19/// `range..range` can't represent the rectangle.
20///
21/// Returns an empty vec when the edit isn't representable (no buffer
22/// variant currently fails this check).
23fn edit_to_editops(edit: &hjkl_buffer::Edit) -> Vec<crate::types::Edit> {
24    use crate::types::{Edit as Op, Pos};
25    use hjkl_buffer::Edit as B;
26    let to_pos = |p: hjkl_buffer::Position| Pos {
27        line: p.row as u32,
28        col: p.col as u32,
29    };
30    match edit {
31        B::InsertChar { at, ch } => vec![Op {
32            range: to_pos(*at)..to_pos(*at),
33            replacement: ch.to_string(),
34        }],
35        B::InsertStr { at, text } => vec![Op {
36            range: to_pos(*at)..to_pos(*at),
37            replacement: text.clone(),
38        }],
39        B::DeleteRange { start, end, .. } => vec![Op {
40            range: to_pos(*start)..to_pos(*end),
41            replacement: String::new(),
42        }],
43        B::Replace { start, end, with } => vec![Op {
44            range: to_pos(*start)..to_pos(*end),
45            replacement: with.clone(),
46        }],
47        B::JoinLines {
48            row,
49            count,
50            with_space,
51        } => {
52            // Joining `count` rows after `row` collapses
53            // [(row+1, 0) .. (row+count, EOL)] into the joined
54            // sentinel. The replacement is either an empty string
55            // (gJ) or " " between segments (J).
56            let start = Pos {
57                line: *row as u32 + 1,
58                col: 0,
59            };
60            let end = Pos {
61                line: (*row + *count) as u32,
62                col: u32::MAX, // covers to EOL of the last source row
63            };
64            vec![Op {
65                range: start..end,
66                replacement: if *with_space {
67                    " ".into()
68                } else {
69                    String::new()
70                },
71            }]
72        }
73        B::SplitLines {
74            row,
75            cols,
76            inserted_spaces: _,
77        } => {
78            // SplitLines reverses a JoinLines: insert a `\n`
79            // (and optional dropped space) at each col on `row`.
80            cols.iter()
81                .map(|c| {
82                    let p = Pos {
83                        line: *row as u32,
84                        col: *c as u32,
85                    };
86                    Op {
87                        range: p..p,
88                        replacement: "\n".into(),
89                    }
90                })
91                .collect()
92        }
93        B::InsertBlock { at, chunks } => {
94            // One EditOp per row in the block — non-contiguous edits.
95            chunks
96                .iter()
97                .enumerate()
98                .map(|(i, chunk)| {
99                    let p = Pos {
100                        line: at.row as u32 + i as u32,
101                        col: at.col as u32,
102                    };
103                    Op {
104                        range: p..p,
105                        replacement: chunk.clone(),
106                    }
107                })
108                .collect()
109        }
110        B::DeleteBlockChunks {
111            at,
112            widths,
113            pads: _,
114        } => {
115            // One EditOp per row, deleting `widths[i]` chars at
116            // `(at.row + i, at.col)`. Best-effort: doesn't account for
117            // `pads` (see `Edit::DeleteBlockChunks` doc) — this mapping is
118            // already documented as a placeholder, and `pads` is only ever
119            // non-zero on a path nothing currently applies (audit-r2 fix 6).
120            widths
121                .iter()
122                .enumerate()
123                .map(|(i, w)| {
124                    let start = Pos {
125                        line: at.row as u32 + i as u32,
126                        col: at.col as u32,
127                    };
128                    let end = Pos {
129                        line: at.row as u32 + i as u32,
130                        col: at.col as u32 + *w as u32,
131                    };
132                    Op {
133                        range: start..end,
134                        replacement: String::new(),
135                    }
136                })
137                .collect()
138        }
139    }
140}
141
142/// Sum of bytes from the start of the buffer to the start of `row`.
143/// Byte offset of the first byte of `row` within the canonical
144/// `lines().join("\n")` byte rendering. Pre-rope this walked every row
145/// from 0 to `row` allocating a `String` per row to read its `.len()` —
146/// O(row) allocations per call, fired from `position_to_byte_coords` on
147/// every `insert_char`. At the bottom of a 1.86 M-line buffer that was
148/// 1.86 M String allocations per keystroke (the dominant cost of the
149/// "edits at the bottom of the file are slow" symptom).
150///
151/// Now O(log N): ropey's `line_to_byte` walks the B-tree's per-node
152/// byte counts. No String materialization.
153#[inline]
154fn buffer_byte_of_row(buf: &hjkl_buffer::View, row: usize) -> usize {
155    let rope = buf.rope();
156    let row = row.min(rope.len_lines());
157    rope.line_to_byte(row)
158}
159
160/// Convert an `hjkl_buffer::Position` (char-indexed col) into byte
161/// coordinates `(byte_within_buffer, (row, col_byte))` against the
162/// **pre-edit** buffer.
163fn position_to_byte_coords(
164    buf: &hjkl_buffer::View,
165    pos: hjkl_buffer::Position,
166) -> (usize, (u32, u32)) {
167    let row = pos.row.min(buf.row_count().saturating_sub(1));
168    let rope = buf.rope();
169    let line = hjkl_buffer::rope_line_str(&rope, row);
170    let col_byte = pos.byte_offset(&line);
171    let byte = buffer_byte_of_row(buf, row) + col_byte;
172    (byte, (row as u32, col_byte as u32))
173}
174
175/// Walk `bytes[..end]` counting newlines and return the (row, col_byte)
176/// position at byte offset `end`. `col_byte` is the byte distance from
177/// the most recent `\n` (or buffer start). Used to translate a byte
178/// offset into a tree-sitter `Point`.
179fn byte_to_row_col(bytes: &[u8], end: usize) -> (u32, u32) {
180    let end = end.min(bytes.len());
181    let mut row: u32 = 0;
182    let mut row_start: usize = 0;
183    for (i, &b) in bytes[..end].iter().enumerate() {
184        if b == b'\n' {
185            row += 1;
186            row_start = i + 1;
187        }
188    }
189    (row, (end - row_start) as u32)
190}
191
192/// Rope-backed minimal content-edit diff for the undo/redo
193/// `restore_text` path. Walks `old_rope` chunk-by-chunk for the
194/// common-prefix / common-suffix scan instead of forcing a full
195/// `content_joined()` materialization (~3 MB per undo on huge files).
196///
197/// `ropey::Rope::bytes()` and `bytes_at(n).reversed()` give O(log N)
198/// seek + O(1)-per-byte step, so the scan cost matches the contiguous
199/// `&[u8]` version without the materialization alloc.
200fn minimal_content_edit_rope(old_rope: &ropey::Rope, new_text: &str) -> crate::types::ContentEdit {
201    let new_bytes = new_text.as_bytes();
202    let old_len = old_rope.len_bytes();
203    let new_len = new_bytes.len();
204    let common = old_len.min(new_len);
205
206    // Common prefix length — forward walk through rope bytes.
207    let mut prefix = 0;
208    let mut fwd = old_rope.bytes();
209    while prefix < common {
210        match fwd.next() {
211            Some(b) if b == new_bytes[prefix] => prefix += 1,
212            _ => break,
213        }
214    }
215    while prefix > 0 && prefix < old_len && (old_rope.byte(prefix) & 0b1100_0000) == 0b1000_0000 {
216        prefix -= 1;
217    }
218
219    // Common suffix length — backward walk through rope bytes.
220    let mut suffix = 0;
221    let max_suffix = (old_len - prefix).min(new_len - prefix);
222    let mut rev = old_rope.bytes_at(old_len).reversed();
223    while suffix < max_suffix {
224        match rev.next() {
225            Some(b) if b == new_bytes[new_len - 1 - suffix] => suffix += 1,
226            _ => break,
227        }
228    }
229    while suffix > 0
230        && suffix < old_len
231        && (old_rope.byte(old_len - suffix) & 0b1100_0000) == 0b1000_0000
232    {
233        suffix -= 1;
234    }
235
236    let start_byte = prefix;
237    let old_end_byte = old_len - suffix;
238    let new_end_byte = new_len - suffix;
239
240    crate::types::ContentEdit {
241        start_byte,
242        old_end_byte,
243        new_end_byte,
244        start_position: rope_byte_to_row_col(old_rope, start_byte),
245        old_end_position: rope_byte_to_row_col(old_rope, old_end_byte),
246        new_end_position: byte_to_row_col(new_bytes, new_end_byte),
247    }
248}
249
250#[inline]
251fn rope_byte_to_row_col(rope: &ropey::Rope, byte_idx: usize) -> (u32, u32) {
252    let byte_idx = byte_idx.min(rope.len_bytes());
253    let line = rope.byte_to_line(byte_idx);
254    let line_start = rope.line_to_byte(line);
255    (line as u32, (byte_idx - line_start) as u32)
256}
257
258/// Compute the byte position after inserting `text` starting at
259/// `start_byte` / `start_pos`. Returns `(end_byte, end_position)`.
260fn advance_by_text(text: &str, start_byte: usize, start_pos: (u32, u32)) -> (usize, (u32, u32)) {
261    let new_end_byte = start_byte + text.len();
262    let newlines = text.bytes().filter(|&b| b == b'\n').count();
263    let end_pos = if newlines == 0 {
264        (start_pos.0, start_pos.1 + text.len() as u32)
265    } else {
266        // Bytes after the last newline determine the trailing column.
267        let last_nl = text.rfind('\n').unwrap();
268        let tail_bytes = (text.len() - last_nl - 1) as u32;
269        (start_pos.0 + newlines as u32, tail_bytes)
270    };
271    (new_end_byte, end_pos)
272}
273
274/// Translate a single `hjkl_buffer::Edit` into one or more
275/// [`crate::types::ContentEdit`] records using the **pre-edit** buffer
276/// state for byte/position lookups. Block ops fan out to one entry per
277/// touched row (matches `edit_to_editops`).
278fn content_edits_from_buffer_edit(
279    buf: &hjkl_buffer::View,
280    edit: &hjkl_buffer::Edit,
281) -> Vec<crate::types::ContentEdit> {
282    use hjkl_buffer::Edit as B;
283    use hjkl_buffer::Position;
284
285    let mut out: Vec<crate::types::ContentEdit> = Vec::new();
286
287    match edit {
288        B::InsertChar { at, ch } => {
289            let (start_byte, start_pos) = position_to_byte_coords(buf, *at);
290            let new_end_byte = start_byte + ch.len_utf8();
291            let new_end_pos = (start_pos.0, start_pos.1 + ch.len_utf8() as u32);
292            out.push(crate::types::ContentEdit {
293                start_byte,
294                old_end_byte: start_byte,
295                new_end_byte,
296                start_position: start_pos,
297                old_end_position: start_pos,
298                new_end_position: new_end_pos,
299            });
300        }
301        B::InsertStr { at, text } => {
302            let (start_byte, start_pos) = position_to_byte_coords(buf, *at);
303            let (new_end_byte, new_end_pos) = advance_by_text(text, start_byte, start_pos);
304            out.push(crate::types::ContentEdit {
305                start_byte,
306                old_end_byte: start_byte,
307                new_end_byte,
308                start_position: start_pos,
309                old_end_position: start_pos,
310                new_end_position: new_end_pos,
311            });
312        }
313        B::DeleteRange { start, end, kind } => {
314            let (start, end) = if start <= end {
315                (*start, *end)
316            } else {
317                (*end, *start)
318            };
319            match kind {
320                hjkl_buffer::MotionKind::Char => {
321                    let (start_byte, start_pos) = position_to_byte_coords(buf, start);
322                    let (old_end_byte, old_end_pos) = position_to_byte_coords(buf, end);
323                    out.push(crate::types::ContentEdit {
324                        start_byte,
325                        old_end_byte,
326                        new_end_byte: start_byte,
327                        start_position: start_pos,
328                        old_end_position: old_end_pos,
329                        new_end_position: start_pos,
330                    });
331                }
332                hjkl_buffer::MotionKind::Line => {
333                    // Linewise delete drops rows [lo..=hi] (both clamped,
334                    // matching `do_delete_range`). When `hi` is not the
335                    // last row the removed bytes are [byte_of_row(lo),
336                    // byte_of_row(hi + 1)). When `hi` IS the last row the
337                    // buffer removes through the true end of the document
338                    // and — when rows survive above — ALSO the '\n' that
339                    // ends row `lo - 1` (so no trailing-newline orphan is
340                    // left), so the edit must start at EOL of row lo-1.
341                    let n = buf.row_count();
342                    let lo = start.row.min(n.saturating_sub(1));
343                    let hi = end.row.min(n.saturating_sub(1));
344                    let rope = buf.rope();
345                    let (start_byte, start_position) = if hi + 1 < n {
346                        (buffer_byte_of_row(buf, lo), (lo as u32, 0))
347                    } else if lo > 0 {
348                        let prev_len = hjkl_buffer::rope_line_bytes(&rope, lo - 1);
349                        (
350                            buffer_byte_of_row(buf, lo) - 1,
351                            ((lo - 1) as u32, prev_len as u32),
352                        )
353                    } else {
354                        (0, (0, 0))
355                    };
356                    let (old_end_byte, old_end_position) = if hi + 1 < n {
357                        (buffer_byte_of_row(buf, hi + 1), ((hi + 1) as u32, 0))
358                    } else {
359                        let len = rope.len_bytes();
360                        (len, rope_byte_to_row_col(&rope, len))
361                    };
362                    out.push(crate::types::ContentEdit {
363                        start_byte,
364                        old_end_byte,
365                        new_end_byte: start_byte,
366                        start_position,
367                        old_end_position,
368                        new_end_position: start_position,
369                    });
370                }
371                hjkl_buffer::MotionKind::Block => {
372                    // Block delete removes a rectangle of chars per row.
373                    // Fan out to one ContentEdit per row, in DESCENDING
374                    // row order: consumers (tree-sitter `tree.edit`, LSP
375                    // didChange, sibling rebase) apply the batch
376                    // sequentially, each edit against the document as
377                    // already modified by the previous ones. Bottom-up,
378                    // every edit's pre-edit byte offsets stay valid
379                    // because prior edits only touched bytes strictly
380                    // after it. (Ascending emission left each later
381                    // row's byte offsets too high by the widths already
382                    // deleted above it.) Rows past the last row are
383                    // skipped, matching `do_delete_range`'s clamp —
384                    // iterating them would emit duplicate edits for the
385                    // clamped last row.
386                    let (left_col, right_col) = (start.col.min(end.col), start.col.max(end.col));
387                    let hi_row = end.row.min(buf.row_count().saturating_sub(1));
388                    for row in (start.row..=hi_row).rev() {
389                        let row_start_pos = Position::new(row, left_col);
390                        let row_end_pos = Position::new(row, right_col + 1);
391                        let (sb, sp) = position_to_byte_coords(buf, row_start_pos);
392                        let (eb, ep) = position_to_byte_coords(buf, row_end_pos);
393                        if eb <= sb {
394                            continue;
395                        }
396                        out.push(crate::types::ContentEdit {
397                            start_byte: sb,
398                            old_end_byte: eb,
399                            new_end_byte: sb,
400                            start_position: sp,
401                            old_end_position: ep,
402                            new_end_position: sp,
403                        });
404                    }
405                }
406            }
407        }
408        B::Replace { start, end, with } => {
409            let (start, end) = if start <= end {
410                (*start, *end)
411            } else {
412                (*end, *start)
413            };
414            let (start_byte, start_pos) = position_to_byte_coords(buf, start);
415            let (old_end_byte, old_end_pos) = position_to_byte_coords(buf, end);
416            let (new_end_byte, new_end_pos) = advance_by_text(with, start_byte, start_pos);
417            out.push(crate::types::ContentEdit {
418                start_byte,
419                old_end_byte,
420                new_end_byte,
421                start_position: start_pos,
422                old_end_position: old_end_pos,
423                new_end_position: new_end_pos,
424            });
425        }
426        B::JoinLines {
427            row,
428            count,
429            with_space,
430        } => {
431            // Mirrors `do_join_lines` exactly: each join removes the
432            // single '\n' byte that ends `row` and, when `with_space`
433            // and BOTH the accumulated line and the incoming line are
434            // non-empty, inserts one space in its place. The joined
435            // line's content is KEPT in the buffer, so the per-join
436            // byte change is exactly `"\n" → ""` or `"\n" → " "` —
437            // never the whole span down to EOL of the last joined row.
438            // One ContentEdit per join, each expressed against the
439            // document as already modified by the previous joins (the
440            // sequential-consumer contract shared by tree-sitter
441            // `tree.edit`, LSP didChange and sibling rebase).
442            let n = buf.row_count();
443            let row = (*row).min(n.saturating_sub(1));
444            let buf_rope = buf.rope();
445            let row_start_byte = buffer_byte_of_row(buf, row);
446            // Evolving byte length of the merged line, and how many
447            // rows the document still has before each join.
448            let mut line_bytes = hjkl_buffer::rope_line_bytes(&buf_rope, row);
449            let mut rows_left = n;
450            for k in 0..(*count).max(1) {
451                if row + 1 >= rows_left {
452                    break; // same stop condition as `do_join_lines`
453                }
454                // Pre-edit index of the line being pulled up.
455                let next_bytes = hjkl_buffer::rope_line_bytes(&buf_rope, row + 1 + k);
456                let start_byte = row_start_byte + line_bytes;
457                let start_pos = (row as u32, line_bytes as u32);
458                let insert_space = *with_space && line_bytes > 0 && next_bytes > 0;
459                let (new_end_byte, new_end_pos) = if insert_space {
460                    (start_byte + 1, (row as u32, line_bytes as u32 + 1))
461                } else {
462                    (start_byte, start_pos)
463                };
464                out.push(crate::types::ContentEdit {
465                    start_byte,
466                    old_end_byte: start_byte + 1, // the '\n'
467                    new_end_byte,
468                    start_position: start_pos,
469                    old_end_position: ((row + 1) as u32, 0),
470                    new_end_position: new_end_pos,
471                });
472                line_bytes += next_bytes + usize::from(insert_space);
473                rows_left -= 1;
474            }
475        }
476        B::SplitLines {
477            row,
478            cols,
479            inserted_spaces,
480        } => {
481            // `do_split_lines` applies `cols` in REVERSE (right-to-left) —
482            // not left-to-right — so later-processed (rightward) splits
483            // never shift the byte offsets of an earlier-processed
484            // (leftward) one. Mirror that order: cols.iter().rev().
485            //
486            // `inserted_spaces[idx]` (per-col — audit-r2 fix 6; NOT a
487            // uniform flag, since a multi-join batch can mix joins that
488            // did and didn't insert a space) tells us whether THIS split
489            // REPLACES a space byte with '\n' (remove the space, then
490            // insert '\n' at the same index) rather than a bare "\n"
491            // insert — but ONLY when that col is still within the row's
492            // *current* (shrinking, as each split truncates the row) char
493            // count AND the char actually there is a space, mirroring
494            // `do_split_lines`'s own defensive double-check. Track a
495            // shrinking `current_lc` (the row's live char count, exactly
496            // as `do_split_lines` recomputes via `rope_line_char_count`)
497            // so this arm reproduces that exactly, byte-for-byte.
498            let row = (*row).min(buf.row_count().saturating_sub(1));
499            let split_rope = buf.rope();
500            let line = hjkl_buffer::rope_line_str(&split_rope, row);
501            let mut current_lc = line.chars().count();
502            for (idx, &col) in cols.iter().enumerate().rev() {
503                let col_inserted_space = inserted_spaces.get(idx).copied().unwrap_or(false);
504                let has_space =
505                    col_inserted_space && col < current_lc && line.chars().nth(col) == Some(' ');
506                // `do_split_lines` never clamps `split_col` when this col's
507                // flag is set (even when out of range — see the
508                // has_space=false-past-EOL case above); only the no-space
509                // branch clamps to the live row length.
510                let split_col = if col_inserted_space {
511                    col
512                } else {
513                    col.min(current_lc)
514                };
515                let start_pos = Position::new(row, split_col);
516                let (start_byte, start_p) = position_to_byte_coords(buf, start_pos);
517                if has_space {
518                    // Space (1 byte) replaced by '\n' (1 byte).
519                    let end_pos = Position::new(row, split_col + 1);
520                    let (old_end_byte, old_end_p) = position_to_byte_coords(buf, end_pos);
521                    out.push(crate::types::ContentEdit {
522                        start_byte,
523                        old_end_byte,
524                        new_end_byte: start_byte + 1,
525                        start_position: start_p,
526                        old_end_position: old_end_p,
527                        new_end_position: (start_p.0 + 1, 0),
528                    });
529                } else {
530                    let (new_end_byte, new_end_pos) = advance_by_text("\n", start_byte, start_p);
531                    out.push(crate::types::ContentEdit {
532                        start_byte,
533                        old_end_byte: start_byte,
534                        new_end_byte,
535                        start_position: start_p,
536                        old_end_position: start_p,
537                        new_end_position: new_end_pos,
538                    });
539                }
540                current_lc = split_col;
541            }
542        }
543        B::InsertBlock { at, chunks } => {
544            // One ContentEdit per chunk, each landing at `(at.row + i,
545            // at.col)` in the pre-edit buffer. Rows share one contiguous
546            // rope, so inserting into an upper row shifts the byte
547            // offsets of every row below it — emit DESCENDING (bottom
548            // row first), same fix as block-delete (commit a57161d8):
549            // a lower row's edit, applied first by a sequential
550            // consumer, never touches bytes above it, so every row's
551            // pre-edit offset (computed once here, against `buf`) stays
552            // valid through the whole batch.
553            for (i, chunk) in chunks.iter().enumerate().rev() {
554                let pos = Position::new(at.row + i, at.col);
555                let (start_byte, start_pos) = position_to_byte_coords(buf, pos);
556                let (new_end_byte, new_end_pos) = advance_by_text(chunk, start_byte, start_pos);
557                out.push(crate::types::ContentEdit {
558                    start_byte,
559                    old_end_byte: start_byte,
560                    new_end_byte,
561                    start_position: start_pos,
562                    old_end_position: start_pos,
563                    new_end_position: new_end_pos,
564                });
565            }
566        }
567        B::DeleteBlockChunks { at, widths, pads } => {
568            // Same descending-order requirement as InsertBlock above.
569            for (i, w) in widths.iter().enumerate().rev() {
570                let row = at.row + i;
571                // `pads[i]` extends the removed span to the left of
572                // at.col (see the `Edit::DeleteBlockChunks` field doc) —
573                // include it so this stays byte-exact for the padded case
574                // too, not just the chunk-only span.
575                let pad = pads.get(i).copied().unwrap_or(0);
576                let start_pos = Position::new(row, at.col.saturating_sub(pad));
577                let end_pos = Position::new(row, at.col + *w);
578                let (sb, sp) = position_to_byte_coords(buf, start_pos);
579                let (eb, ep) = position_to_byte_coords(buf, end_pos);
580                if eb <= sb {
581                    continue;
582                }
583                out.push(crate::types::ContentEdit {
584                    start_byte: sb,
585                    old_end_byte: eb,
586                    new_end_byte: sb,
587                    start_position: sp,
588                    old_end_position: ep,
589                    new_end_position: sp,
590                });
591            }
592        }
593    }
594
595    out
596}
597
598/// Where the cursor should land in the viewport after a `z`-family
599/// scroll (`zz` / `zt` / `zb`).
600#[derive(Debug, Clone, Copy, PartialEq, Eq)]
601pub enum CursorScrollTarget {
602    Center,
603    Top,
604    Bottom,
605}
606
607// ── Trait-surface cast helpers ────────────────────────────────────
608//
609// 0.0.42 (Patch C-δ.7): the helpers introduced in 0.0.41 were
610// promoted to [`crate::buf_helpers`] so `vim.rs` free fns can route
611// their reaches through the same primitives. Re-import via
612// `use` so the editor body keeps its terse call shape.
613
614use crate::buf_helpers::{
615    apply_buffer_edit, buf_cursor_pos, buf_cursor_rc, buf_cursor_row, buf_line, buf_line_bytes,
616    buf_line_chars, buf_row_count, buf_set_cursor_rc,
617};
618
619use hjkl_buffer::char_col_to_visual_col;
620
621/// Return value from the engine's `try_goto_mark_*` methods. Tells the
622/// caller (app layer) whether a cross-buffer switch is required.
623///
624/// - `SameBuffer` — cursor moved (or mark was unset → no-op) within the
625///   same buffer; no buffer switch needed.
626/// - `CrossBuffer` — the mark lives in a different buffer. The app must
627///   switch to the slot whose `buffer_id` matches, then position the cursor
628///   at `(row, col)` using `Editor::jump_cursor`.
629/// - `Unset` — mark not set; no action needed.
630#[derive(Debug, Clone, PartialEq, Eq)]
631pub enum MarkJump {
632    SameBuffer,
633    CrossBuffer {
634        buffer_id: u64,
635        row: usize,
636        col: usize,
637    },
638    Unset,
639}
640
641/// Uppercase (global) vim marks, keyed by `'A'`–`'Z'`; values are
642/// `(buffer_id, row, col)`. Shared across every window's [`Editor`] via
643/// `Arc<Mutex<GlobalMarks>>` — see [`Editor::set_global_marks_arc`]. Named so
644/// the app host can spell the shared-bank type without repeating the nested
645/// generic (mirrors [`crate::Registers`]).
646pub type GlobalMarks = std::collections::BTreeMap<char, (u64, usize, usize)>;
647
648/// Session-global search state: the last committed `/`/`?` pattern, its
649/// direction, and the search-prompt history. Shared across every window's
650/// [`Editor`] via `Arc<Mutex<SearchBank>>` — see [`Editor::set_search_arc`].
651///
652/// Bundled into one struct behind a single lock (rather than four separate
653/// `Arc<Mutex<_>>` fields) because vim always reads/writes these four
654/// together — e.g. committing a search sets both `last` and `forward` in
655/// the same breath, and `n`/`N` reads both. Mirrors [`GlobalMarks`] /
656/// [`crate::Registers`] as the app host's spelling for the shared-bank type.
657#[derive(Debug, Clone)]
658pub struct SearchBank {
659    /// Last committed search pattern, for `n` / `N` (or Find Next).
660    pub last: Option<String>,
661    /// Direction of the last committed search: `true` = forward (`/`),
662    /// `false` = backward (`?`).
663    pub forward: bool,
664    /// Search history, oldest first. Capped at
665    /// [`crate::types::SEARCH_HISTORY_MAX`] entries.
666    pub history: Vec<String>,
667    /// Cursor while walking search history with Up/Down (Ctrl-P/Ctrl-N).
668    pub history_cursor: Option<usize>,
669}
670
671impl Default for SearchBank {
672    fn default() -> Self {
673        Self {
674            last: None,
675            // Matches vim's default: before any search, `n` behaves as if
676            // the last search were forward.
677            forward: true,
678            history: Vec::new(),
679            history_cursor: None,
680        }
681    }
682}
683
684/// Per-buffer changelist bank: `g;`/`g,` history plus the `'.` / `` `. ``
685/// "last change" mark. Shared via `Arc<Mutex<ChangeBank>>` across every
686/// window's [`Editor`] viewing the SAME buffer — vim's changelist and
687/// last-change mark are per-buffer, not per-window, so an edit made in one
688/// split must be visible to `g;` / `` `. `` from any other split on that
689/// buffer (audit B3).
690///
691/// UNLIKE [`GlobalMarks`] / [`Registers`] / [`SearchBank`] / abbrevs /
692/// last-substitute — which are each a single `Arc` shared by literally
693/// every `Editor` in the app, session-global — a `ChangeBank` is
694/// per-buffer: the app layer keys a bank per `buffer_id` and hands each
695/// `Editor` the Arc for its CURRENT buffer, swapping it whenever the
696/// editor's buffer changes (see `App::change_bank_for` /
697/// `Editor::set_change_bank_arc`). Two editors on the same buffer_id share
698/// one bank; editors on different buffers never see each other's entries.
699#[derive(Debug, Clone, Default)]
700pub struct ChangeBank {
701    /// Position of the most recent buffer mutation, matching vim's `:h '.`
702    /// ("the position where the last change was made" — change-start, not
703    /// the post-edit cursor). Surfaced via the `'.` / `` `. `` marks.
704    pub last_edit: Option<(usize, usize)>,
705    /// Bounded ring of recent edit positions (newest at back). `g;` walks
706    /// toward older, `g,` toward newer. Capped at
707    /// [`crate::types::CHANGE_LIST_MAX`].
708    pub list: Vec<(usize, usize)>,
709    /// Index into `list` while walking; `None` outside a walk (any new
710    /// edit clears it and trims forward entries).
711    pub cursor: Option<usize>,
712    /// `U` (`:h U`) bookkeeping: `(row, text)` — the text of `row` before
713    /// the *first* change landed on it since the tracked row last
714    /// changed. Reset (row + fresh snapshot) whenever an edit's pre-edit
715    /// cursor row differs from the currently tracked row.
716    /// [`Editor::undo_line`] swaps this to the pre-`U` text on each call
717    /// so a second `U` redoes what the first one undid.
718    pub u_line: Option<(usize, String)>,
719    /// Post-edit cursor position of the most recent `mutate_edit` call —
720    /// NOT part of any undo/redo snapshot (deliberately: after an undo/
721    /// redo this goes stale and the next edit correctly starts a fresh
722    /// burst). Lets `mutate_edit` tell whether the *next* edit is a
723    /// continuation of the same typing burst (its pre-edit position
724    /// picks up exactly where this one left the cursor) or the start of
725    /// a new one — see the `entry` comment in `mutate_edit` for why this
726    /// matters for `g;` / `` `. ``: a whole `AXYZ<Esc>` insert session is
727    /// ONE vim change, not three, and `g;` from a fresh cursor lands on
728    /// its start column, not the last-typed character's.
729    pub last_edit_end: Option<(usize, usize)>,
730}
731
732/// RAII guard returned by [`Editor::undo_group`]. Holds the shared `Content`
733/// so it can close its group on `Drop` regardless of how the enclosing scope
734/// exits (normal return, early return, or panic). Dropping the OUTERMOST guard
735/// commits the group's single undo entry (or discards it if the group mutated
736/// nothing); inner guards just decrement the depth. See `push_undo`.
737#[must_use]
738pub struct UndoGroup {
739    content: std::sync::Arc<std::sync::Mutex<hjkl_buffer::Buffer>>,
740}
741
742impl Drop for UndoGroup {
743    fn drop(&mut self) {
744        self.content.lock().unwrap().undo_group_exit();
745    }
746}
747
748pub struct Editor<
749    B: crate::types::View = hjkl_buffer::View,
750    H: crate::types::Host = crate::types::DefaultHost,
751> {
752    /// The installed keyboard discipline's FSM state, type-erased (#265 G3).
753    ///
754    /// The engine never names the concrete type: it only projects a
755    /// [`CoarseMode`] and asks for idle resets through
756    /// [`DisciplineState`]. The owning discipline crate downcasts through
757    /// [`Editor::discipline_mut`] to reach its own state (e.g. `hjkl-vim`'s
758    /// `VimState`).
759    ///
760    /// [`CoarseMode`]: crate::CoarseMode
761    /// [`DisciplineState`]: crate::DisciplineState
762    discipline: Box<dyn crate::DisciplineState>,
763    /// Secondary selections for multi-cursor editing (#63).
764    ///
765    /// The **primary** selection is not in here: its head stays `View::cursor`
766    /// (so the ~130 places across the engine and the disciplines that move the
767    /// cursor keep working untouched) and its anchor lives in the discipline's
768    /// own state (vim's `visual_anchor`, helix's `anchor`). That asymmetry is
769    /// deliberate — see [`crate::selection_shift::Sel`].
770    ///
771    /// Each entry carries BOTH ends, so an operator can act on a *range* at every
772    /// cursor, not just the char under it. [`Editor::mutate_edit`] rewrites both
773    /// ends against the pre-edit geometry after every edit, and drops the whole
774    /// selection if either end becomes untrackable — never half of one.
775    ///
776    /// Char columns, matching `View::cursor` and [`hjkl_buffer::Edit`] — NOT
777    /// the grapheme columns that `types::Pos` uses.
778    ///
779    /// Empty for a single-cursor editor, which is every editor today: vim drives
780    /// one caret, so this costs an `is_empty()` check per edit and nothing else.
781    extra_selections: Vec<crate::selection_shift::Sel>,
782    /// Read-only view overlay (git blame, …) layered over the input mode.
783    /// Discipline-agnostic engine substrate (#265 G3): hoisted out of
784    /// `VimState` because the core edit funnel (`mutate_edit`) and render/chrome
785    /// (`is_blame`/`view_mode`) read it, and any discipline can present an
786    /// overlay. Orthogonal to the input mode; auto-reset to `Normal` whenever
787    /// the input mode leaves Normal (see `drop_blame_if_left_normal`).
788    pub(crate) view: crate::ViewMode,
789    /// The changelist / last-change-mark bank: `last_edit`, `list`,
790    /// `cursor`. Discipline-agnostic substrate (#265 G3): the engine-core
791    /// edit path (`mutate_edit`) writes it and any discipline can offer
792    /// "back to last edit" / `g;`/`g,`.
793    ///
794    /// Shared via `Arc<Mutex<_>>` — but PER-BUFFER, not session-global like
795    /// [`Editor::global_marks`] / [`Editor::registers`] (audit B3): vim's
796    /// changelist and `` `. `` mark are per-buffer, so two windows/splits on
797    /// the SAME buffer must see one shared changelist, while windows on
798    /// DIFFERENT buffers must stay isolated. The app layer keys a bank per
799    /// `buffer_id` and swaps this Arc via [`Editor::set_change_bank_arc`]
800    /// whenever the editor's buffer changes. See [`ChangeBank`].
801    pub(crate) change_bank: std::sync::Arc<std::sync::Mutex<ChangeBank>>,
802    /// Undo history: each entry is `(joined_document, cursor)` before the
803    /// edit. Stored as `Arc<String>` so it shares the
804    /// Undo history: snapshots taken via `View::rope()` — `ropey::Rope::clone`
805    /// is O(1) (Arc-clone of the B-tree root). Previously stored
806    /// `Arc<String>` from `content_joined()`, which on the rope storage
807    /// builds the entire document `String` via `rope.to_string()` — that
808    /// turned every `i` / `o` keystroke into a ~3 MB allocation on a
809    /// 1.86 M-line file.
810    // undo_stack, redo_stack, content_dirty, cached_content (as
811    // cached_editor_content), pending_fold_ops, change_log,
812    // pending_content_edits, pending_content_reset are now stored on
813    // Buffer (inside self.buffer) and accessed via View accessor methods.
814    /// Last rendered viewport height (text rows only, no chrome). Written
815    /// by the draw path via [`set_viewport_height`] so the scroll helpers
816    /// can clamp the cursor to stay visible without plumbing the height
817    /// through every call.
818    pub(super) viewport_height: AtomicU16,
819    /// Pending LSP intent set by a normal-mode chord (e.g. `gd` for
820    /// goto-definition). The host app drains this each step and fires
821    /// the matching request against its own LSP client.
822    pub(super) pending_lsp: Option<LspIntent>,
823    /// Re-entrancy guard for [`Editor::undo_line`] (`U`): while its own
824    /// line-replacing edits run through [`Editor::mutate_edit`], the
825    /// generic `ChangeBank::u_line` auto-snapshot logic must NOT treat
826    /// them as a fresh "first change on this row" — `undo_line` manages
827    /// the swap itself.
828    pub(super) suppress_u_line_track: bool,
829    /// View storage.
830    ///
831    /// 0.1.0 (Patch C-δ): generic over `B: View` per SPEC §"Editor
832    /// surface". Default `B = hjkl_buffer::View`. The vim FSM body
833    /// and `Editor::mutate_edit` are concrete on `hjkl_buffer::View`
834    /// for 0.1.0 — see `crate::buf_helpers::apply_buffer_edit`.
835    pub(super) buffer: B,
836    /// Engine-native style intern table. Opaque `Span::style` ids index
837    /// into this table; the render path resolves ids back to
838    /// [`crate::types::Style`]. Ratatui hosts convert at the boundary via
839    /// `hjkl_engine_tui::style_to_ratatui`. Always present — no cfg-mutex.
840    pub(super) style_table: Vec<crate::types::Style>,
841    /// Vim-style register bank — `"`, `"0`–`"9`, `"a`–`"z`. Sources
842    /// every `p` / `P` via the active selector (default unnamed).
843    /// Internal — read via [`Editor::registers`]; mutated by yank /
844    /// delete / paste FSM paths and by [`Editor::seed_yank`].
845    pub(crate) registers: std::sync::Arc<std::sync::Mutex<crate::registers::Registers>>,
846    /// Per-row syntax styling in engine-native form. Always present —
847    /// populated by [`Editor::install_syntax_spans`]. Ratatui hosts use
848    /// `hjkl_engine_tui::EditorRatatuiExt::install_ratatui_syntax_spans`.
849    ///
850    /// # Nothing in this workspace reads it — `sqeel` does
851    ///
852    /// Every reference in this crate is a write: the install, the per-row
853    /// patch, and the row-index shift on edit. That makes the field look
854    /// removable, and it is not. `sqeel-tui` (`kryptic-sh/sqeel`) depends on
855    /// published `hjkl-engine` and reads it directly —
856    /// `std::mem::take(&mut editor.styled_spans)` in its `syntax.rs`, plus two
857    /// `.clone()` sites in its `lib.rs`. Deleting the field breaks that crate
858    /// the moment it upgrades its pin.
859    ///
860    /// So do not act on a workspace-only grep here. If this should go, give
861    /// `sqeel` a supported accessor first, land that, and only then remove the
862    /// public field.
863    pub styled_spans: Vec<Vec<(usize, usize, crate::types::Style)>>,
864    /// Per-editor settings tweakable via `:set`. Exposed by reference
865    /// so handlers (indent, search) read the live value rather than a
866    /// snapshot taken at startup. Read via [`Editor::settings`];
867    /// mutate via [`Editor::settings_mut`].
868    pub(crate) settings: Settings,
869    /// Global (uppercase) marks that carry a `buffer_id` so they can jump
870    /// across buffers. Keyed by `'A'`–`'Z'`; values are
871    /// `(buffer_id, row, col)`. Set by `m{A-Z}`, resolved by
872    /// `try_goto_mark_line` / `try_goto_mark_char`.
873    ///
874    /// Shared via `Arc<Mutex<_>>` across every window's `Editor` (mirrors
875    /// [`Editor::registers`]) — vim's uppercase marks are session-global, so
876    /// setting `mA` in one split and jumping `'A` from another must see the
877    /// same map. Internal — read/mutated via [`Editor::global_mark`] /
878    /// [`Editor::set_global_mark`] / [`Editor::global_marks_iter`]; wired by
879    /// [`Editor::set_global_marks_arc`].
880    pub(crate) global_marks: std::sync::Arc<std::sync::Mutex<GlobalMarks>>,
881
882    // ── Navigation history / viewport (discipline-agnostic, #265) ────────────
883    //
884    // Hoisted off `VimState` because they are not vim concepts: a jumplist is
885    // navigation history (VSCode's Go Back / Go Forward wants the same list),
886    // and the viewport flags are render state. A future helix/vscode
887    // discipline needs these without depending on hjkl-vim, so they live on
888    // the engine seam.
889    /// Positions pushed on "big" motions. Newest at the back — `Ctrl-o` pops
890    /// from here.
891    pub(crate) jump_back: Vec<(usize, usize)>,
892    /// Forward stack, refilled by `Ctrl-o` so `Ctrl-i` can return.
893    pub(crate) jump_fwd: Vec<(usize, usize)>,
894    /// When set, the viewport does not scroll-follow the cursor.
895    pub(crate) viewport_pinned: bool,
896    /// One-shot hint that the last scroll should be animated by the renderer.
897    pub(crate) scroll_anim_hint: bool,
898
899    // ── Search state (discipline-agnostic, #265) ─────────────────────────────
900    //
901    // Every editor has find. A vscode/helix discipline needs the pattern,
902    // direction and history without depending on hjkl-vim.
903    /// Live `/` or `?` prompt while the user is typing a pattern.
904    pub(crate) search_prompt: Option<crate::search::SearchPrompt>,
905    /// Last committed search pattern + direction + history (the `"/`
906    /// register), bundled into [`SearchBank`].
907    ///
908    /// Shared via `Arc<Mutex<_>>` across every window's `Editor` (mirrors
909    /// [`Editor::global_marks`]) — vim's last search is session-global, so
910    /// `/foo<CR>` in one split and `n` in another must see the same
911    /// pattern. Internal — read/mutated via [`Editor::last_search`] /
912    /// [`Editor::set_last_search`] / friends; wired by
913    /// [`Editor::set_search_arc`].
914    pub(crate) search: std::sync::Arc<std::sync::Mutex<SearchBank>>,
915
916    // ── Input timing (discipline-agnostic) ───────────────────────────────────
917    //
918    // Any chorded FSM needs a timeout clock, not just vim.
919    /// Instant of the last input, when the host supplies a monotonic clock.
920    pub(crate) last_input_at: Option<std::time::Instant>,
921    /// Host-supplied elapsed time at the last input (no_std hosts).
922    pub(crate) last_input_host_at: Option<core::time::Duration>,
923
924    /// Last `:s` command, for `:&` / `:&&`. This is ex-command state owned by
925    /// the hjkl-ex seam, not vim FSM state.
926    ///
927    /// Shared via `Arc<Mutex<_>>` across every window's `Editor` (mirrors
928    /// [`Editor::global_marks`]) — vim's last substitute is session-global,
929    /// so running `:s` in one split and `:&` in another must see the same
930    /// command. Internal — read/mutated via [`Editor::last_substitute`] /
931    /// [`Editor::set_last_substitute`]; wired by
932    /// [`Editor::set_last_substitute_arc`].
933    pub(crate) last_substitute:
934        std::sync::Arc<std::sync::Mutex<Option<crate::substitute::SubstituteCmd>>>,
935
936    // ── Autopair / abbreviations (discipline-agnostic, #265) ─────────────────
937    //
938    // Neither is a vim concept. Autopair is an editor feature gated by
939    // `Settings::autopair` (VSCode has it too), and the abbreviation table is
940    // driven by hjkl-ex's `:abbreviate` / `:iabbrev` — hjkl-ex is in fact the
941    // only caller of the add/remove/clear accessors.
942    /// Close-brackets queued by autopair, as `(row, col, ch)`. Typing the
943    /// matching close char consumes the queued one instead of inserting.
944    pub(crate) pending_closes: Vec<(usize, usize, char)>,
945    /// Active abbreviation table (insert-mode + cmdline entries).
946    ///
947    /// Shared via `Arc<Mutex<_>>` across every window's `Editor` (mirrors
948    /// [`Editor::last_substitute`]) — vim's abbreviations are session-global,
949    /// so `:iabbrev` defined in one split must expand in every other split.
950    /// Internal — read/mutated via [`Editor::abbrevs`] / [`Editor::add_abbrev`]
951    /// / [`Editor::remove_abbrev`] / [`Editor::clear_abbrevs`]; wired by
952    /// [`Editor::set_abbrevs_arc`].
953    pub(crate) abbrevs: std::sync::Arc<std::sync::Mutex<Vec<crate::abbrev::Abbrev>>>,
954
955    /// Whether the unnamed register's current content is linewise. This is
956    /// register metadata, not vim FSM state — any discipline that yanks and
957    /// pastes needs it (#265).
958    ///
959    /// Deliberately per-window, NOT shared via `Arc` (#279 slice 4
960    /// investigation): it is transient scratch state saved/restored around a
961    /// single operator (see `visual_ops.rs`, `text_object_ops.rs`), not the
962    /// source of truth for paste. The actual paste decision (`do_paste` in
963    /// hjkl-vim/src/vim/command.rs) reads `linewise` off the *selected
964    /// register slot* — which already lives in the shared `registers` Arc
965    /// above — so a whole-line yank in one window correctly pastes linewise
966    /// in a sibling window without this field needing to be shared too.
967    pub(crate) yank_linewise: bool,
968
969    /// The `buffer_id` this editor instance is currently attached to.
970    /// Updated by the host app on every `switch_to` / slot creation so
971    /// global-mark writes record the correct id without requiring the app
972    /// to pass the id on every keystroke.
973    pub(crate) current_buffer_id: u64,
974    // change_log moved to Buffer; accessed via self.buffer.take_change_log() etc.
975    /// Vim's "sticky column" (curswant). `None` before the first
976    /// motion — the next vertical motion bootstraps from the live
977    /// cursor column. Horizontal motions refresh this to the new
978    /// column; vertical motions read it back so bouncing through a
979    /// shorter row doesn't drag the cursor to col 0. Hoisted out of
980    /// `hjkl_buffer::View` (and `VimState`) in 0.0.28 — Editor is
981    /// the single owner now. View motion methods that need it
982    /// take a `&mut Option<usize>` parameter.
983    pub(crate) sticky_col: Option<usize>,
984    /// Host adapter for clipboard, cursor-shape, time, viewport, and
985    /// search-prompt / cancellation side-channels.
986    ///
987    /// 0.1.0 (Patch C-δ): generic over `H: Host` per SPEC §"Editor
988    /// surface". Default `H = DefaultHost`. The pre-0.1.0 `EngineHost`
989    /// dyn-shim is gone — every method now dispatches through `H`'s
990    /// `Host` trait surface directly.
991    pub(crate) host: H,
992    /// Last public mode the cursor-shape emitter saw. Drives
993    /// [`Editor::emit_cursor_shape_if_changed`] so `Host::emit_cursor_shape`
994    /// fires exactly once per mode transition without sprinkling the
995    /// call across every `vim.mode = ...` site.
996    pub(crate) last_emitted_mode: crate::CoarseMode,
997    /// Search FSM state (pattern + per-row match cache + wrapscan).
998    /// 0.0.35: relocated out of `hjkl_buffer::View` per
999    /// `DESIGN_33_METHOD_CLASSIFICATION.md` step 1.
1000    /// 0.0.37: the buffer-side bridge (`View::search_pattern`) is
1001    /// gone; `BufferView` now takes the active regex as a `&Regex`
1002    /// parameter, sourced from `Editor::search_state().pattern`.
1003    pub(crate) search_state: crate::search::SearchState,
1004    /// Per-row syntax span overlay. Source of truth for the host's
1005    /// renderer ([`hjkl_buffer::BufferView::spans`]). Populated by
1006    /// [`Editor::install_syntax_spans`] (ratatui hosts use
1007    /// `hjkl_engine_tui::EditorRatatuiExt::install_ratatui_syntax_spans`)
1008    /// and, in due course, by `Host::syntax_highlights` once the engine
1009    /// drives that path directly.
1010    ///
1011    /// 0.0.37: lifted out of `hjkl_buffer::View` per step 3 of
1012    /// `DESIGN_33_METHOD_CLASSIFICATION.md`. The buffer-side cache +
1013    /// `View::set_spans` / `View::spans` accessors are gone.
1014    pub(crate) buffer_spans: Vec<Vec<hjkl_buffer::Span>>,
1015    // pending_content_edits and pending_content_reset moved to Buffer;
1016    // accessed via self.buffer.take_pending_content_edits() etc.
1017    /// Row range touched by the most recent `auto_indent_rows` call.
1018    /// `(top_row, bot_row)` inclusive. Set by the engine after every
1019    /// auto-indent operation; drained (and cleared) by the host via
1020    /// [`Editor::take_last_indent_range`] so it can display a brief
1021    /// visual flash over the reindented rows.
1022    pub(crate) last_indent_range: Option<(usize, usize)>,
1023    /// User-visible errors raised by engine code that has no way to reach
1024    /// the host's message bar. Drained by the host via
1025    /// [`Editor::take_errors`] after each key; same shape as
1026    /// [`Editor::take_fold_ops`] and [`Editor::take_last_indent_range`].
1027    ///
1028    /// The `Host` trait's only host-facing hook is `emit_intent`, and every
1029    /// implementor in the workspace sets `type Intent = ()`, so it carries
1030    /// nothing. This queue is what a discipline crate (which cannot depend
1031    /// on the host's message bus) uses instead.
1032    pub(crate) pending_errors: Vec<String>,
1033}
1034
1035/// Vim-style options surfaced by `:set`. New fields land here as
1036/// individual ex commands gain `:set` plumbing.
1037#[derive(Debug, Clone)]
1038pub struct Settings {
1039    /// Spaces per shift step for `>>` / `<<` / `Ctrl-T` / `Ctrl-D`.
1040    pub shiftwidth: usize,
1041    /// Visual width of a `\t` character. Stored for future render
1042    /// hookup; not yet consumed by the buffer renderer.
1043    pub tabstop: usize,
1044    /// When true, `/` / `?` patterns and `:s/.../.../` ignore case
1045    /// without an explicit `i` flag.
1046    pub ignore_case: bool,
1047    /// When true *and* `ignore_case` is true, an uppercase letter in
1048    /// the pattern flips that search back to case-sensitive. Matches
1049    /// vim's `:set smartcase`. Default `false`.
1050    pub smartcase: bool,
1051    /// Highlight every match of the armed search pattern. Matches vim's
1052    /// `:set hlsearch`. Default `true`.
1053    ///
1054    /// Distinct from `:nohlsearch`, which disarms the *pattern* for this
1055    /// search; this suppresses the highlight while leaving the pattern armed,
1056    /// so `n` / `N` keep working. The host reads it when building the render
1057    /// frame.
1058    pub hlsearch: bool,
1059    /// Highlight matches as the search pattern is typed, before it is
1060    /// submitted. Matches vim's `:set incsearch`. Default `true`. The host
1061    /// reads it in its search-prompt live-preview path.
1062    pub incsearch: bool,
1063    /// Honour a `vim:` / `ex:` / `vi:` modeline in files as they are opened.
1064    /// Matches vim's `:set modeline`. Default `true`.
1065    ///
1066    /// Read by the host when it opens a buffer, so changing it affects
1067    /// **subsequently** opened files — vim's behaviour, since the scan has
1068    /// already happened for a file that is open.
1069    pub modeline: bool,
1070    /// How many lines at each end of a file are scanned for a modeline.
1071    /// Matches vim's `:set modelines`. Default `5`.
1072    pub modelines: u32,
1073    /// Wrap searches past buffer ends. Matches vim's `:set wrapscan`.
1074    /// Default `true`.
1075    pub wrapscan: bool,
1076    /// Wrap column for `gq{motion}` text reflow. Vim's default is 79.
1077    pub textwidth: usize,
1078    /// When `true`, the Tab key in insert mode inserts `tabstop` spaces
1079    /// instead of a literal `\t`. Matches vim's `:set expandtab`.
1080    /// Default `false`.
1081    pub expandtab: bool,
1082    /// Soft tab stop in spaces. When `> 0`, Tab inserts spaces to the
1083    /// next softtabstop boundary (when `expandtab`), and Backspace at the
1084    /// end of a softtabstop-aligned space run deletes the entire run as
1085    /// if it were one tab. `0` disables. Matches vim's `:set softtabstop`.
1086    pub softtabstop: usize,
1087    /// Soft-wrap mode the renderer + scroll math + `gj` / `gk` use.
1088    /// Default is [`hjkl_buffer::Wrap::None`] — long lines extend
1089    /// past the right edge and `top_col` clips the left side.
1090    /// `:set wrap` flips to char-break wrap; `:set linebreak` flips
1091    /// to word-break wrap; `:set nowrap` resets.
1092    pub wrap: hjkl_buffer::Wrap,
1093    /// When true, the engine drops every edit before it touches the
1094    /// buffer — undo, dirty flag, and change log all stay clean.
1095    /// Matches vim's `:set readonly` / `:set ro`. Default `false`.
1096    pub readonly: bool,
1097    /// When `false`, ALL buffer modifications are blocked, including entering
1098    /// insert/replace mode. Matches vim's `:set nomodifiable` / `:set noma`.
1099    /// Default `true`.
1100    pub modifiable: bool,
1101    /// When `true`, pressing Enter in insert mode copies the leading
1102    /// whitespace of the current line onto the new line. Matches vim's
1103    /// `:set autoindent`. Default `true` (vim parity).
1104    pub autoindent: bool,
1105    /// When `true`, bumps indent by one `shiftwidth` after a line ending
1106    /// in `{` / `(` / `[`, and strips one indent unit when the user types
1107    /// `}` / `)` / `]` on a whitespace-only line. See `compute_enter_indent`
1108    /// in `vim.rs` for the tree-sitter plug-in seam. Default `true`.
1109    pub smartindent: bool,
1110    /// Cap on undo-stack length. Older entries are pruned past this
1111    /// bound. `0` means unlimited. Matches vim's `:set undolevels`.
1112    /// Default `1000`.
1113    pub undo_levels: u32,
1114    /// When `true`, cursor motions inside insert mode break the
1115    /// current undo group (so a single `u` only reverses the run of
1116    /// keystrokes that preceded the motion). Default `true`.
1117    /// Currently a no-op — engine doesn't yet break the undo group
1118    /// on insert-mode motions; field is wired through `:set
1119    /// undobreak` for forward compatibility.
1120    pub undo_break_on_motion: bool,
1121    /// Vim-flavoured "what counts as a word" character class.
1122    /// Comma-separated tokens: `@` = `is_alphabetic()`, `_` = literal
1123    /// `_`, `48-57` = decimal char range, bare integer = single char
1124    /// code, single ASCII punctuation = literal. Default
1125    /// `"@,48-57,_,192-255"` matches vim.
1126    pub iskeyword: String,
1127    /// Multi-key sequence timeout (e.g. `gg`, `dd`). When the user
1128    /// pauses longer than this between keys, any pending prefix is
1129    /// abandoned and the next key starts a fresh sequence. Matches
1130    /// vim's `:set timeoutlen` / `:set tm` (millis). Default 1000ms.
1131    pub timeout_len: core::time::Duration,
1132    /// When true, render absolute line numbers in the gutter. Matches
1133    /// vim's `:set number` / `:set nu`. Default `true`.
1134    pub number: bool,
1135    /// When true, render line numbers as offsets from the cursor row.
1136    /// Combined with `number`, the cursor row shows its absolute number
1137    /// while other rows show the relative offset (vim's `nu+rnu` hybrid).
1138    /// Matches vim's `:set relativenumber` / `:set rnu`. Default `false`.
1139    pub relativenumber: bool,
1140    /// Minimum gutter width in cells for the line-number column.
1141    /// Width grows past this to fit the largest displayed number.
1142    /// Matches vim's `:set numberwidth` / `:set nuw`. Default `4`.
1143    /// Range 1..=20.
1144    pub numberwidth: usize,
1145    /// Highlight the row where the cursor sits. Matches vim's `:set cursorline`.
1146    ///
1147    /// Default `true` — a deliberate hjkl divergence from vim, which defaults
1148    /// to `nocursorline`. Must stay in lockstep with
1149    /// [`crate::types::Options::default`].
1150    pub cursorline: bool,
1151    /// Highlight the column where the cursor sits. Matches vim's `:set cursorcolumn`.
1152    /// Default `false` — vim parity (`nocursorcolumn`).
1153    pub cursorcolumn: bool,
1154    /// Sign-column display mode. Matches vim's `:set signcolumn`.
1155    /// Default [`crate::types::SignColumnMode::Auto`].
1156    pub signcolumn: crate::types::SignColumnMode,
1157    /// Number of cells reserved for a fold-marker gutter.
1158    /// Matches vim's `:set foldcolumn`. Default `0`.
1159    pub foldcolumn: u32,
1160    /// How folds are automatically generated. Default `Expr` (tree-sitter).
1161    /// Alias `fdm`. Matches vim's `:set foldmethod`.
1162    pub foldmethod: crate::types::FoldMethod,
1163    /// Enable automatic folds. Default `true`. Alias `fen`.
1164    /// Matches vim's `:set foldenable`.
1165    pub foldenable: bool,
1166    /// Level at which auto-folds start open. `99` = all open (default). Alias `fls`.
1167    /// Matches vim's `:set foldlevelstart`.
1168    pub foldlevelstart: u32,
1169    /// Open/close markers for `foldmethod=marker`, comma-separated `open,close`.
1170    /// Matches vim's `:set foldmarker` / `fmr`. Default `"{{{,}}}"`.
1171    pub foldmarker: String,
1172    /// Comma-separated 1-based column indices for vertical rulers.
1173    /// Matches vim's `:set colorcolumn`. Default `""`.
1174    pub colorcolumn: String,
1175    /// Format options flags (subset of vim's `formatoptions`).
1176    /// `r` — auto-continue line comments on `<Enter>` in insert mode.
1177    /// `o` — auto-continue line comments on `o` / `O` in normal mode.
1178    /// Default: both on (`"ro"`).
1179    pub formatoptions: String,
1180    /// Active filetype (language name) for the current buffer.
1181    /// Used by comment-continuation and future language-aware features.
1182    /// Matches vim's `:set filetype` / `:set ft`. Default `""` (plain text).
1183    pub filetype: String,
1184    /// Override comment-string for the current buffer.
1185    ///
1186    /// When non-empty, used by `toggle_comment_range` instead of the
1187    /// per-filetype default from `hjkl_lang::comment::commentstring_for_lang`.
1188    /// Follows vim's `:set commentstring=…` — use `%s` as the text placeholder
1189    /// (e.g. `"// %s"`) for compatibility; the toggle strips/inserts only the
1190    /// prefix/suffix portion (before/after `%s`).  An empty string means "use
1191    /// the filetype default".  Default `""`.
1192    pub commentstring: String,
1193    /// Program run by `:make` (vim's `makeprg`). Its stdout+stderr are parsed
1194    /// via the errorformat into the quickfix list. Default `"cargo check"`.
1195    pub makeprg: String,
1196    /// Comma-separated list of errorformat patterns used by `:cexpr` /
1197    /// `:lgetexpr` etc. to parse text into quickfix entries. Follows vim's
1198    /// `'errorformat'` / `'efm'`. Default: `"%f:%l:%c:%m,%f:%l:%m,%l:%c:%m"`.
1199    pub errorformat: String,
1200    /// When `true`, typing an opening bracket or quote automatically inserts
1201    /// the matching close character and parks the cursor between them.
1202    /// Matches vim's `set autopairs` (Neovim) / nvim-autopairs behaviour.
1203    /// Default `true`.
1204    pub autopair: bool,
1205    /// When `true`, typing `>` to close an HTML/XML opening tag automatically
1206    /// inserts `</tagname>` after the cursor. Only fires for filetypes in the
1207    /// HTML/XML family (`html`, `xml`, `svg`, `jsx`, `tsx`, `vue`, `svelte`).
1208    /// Matches common editor "autoclose tag" behaviour. Default: `true` for
1209    /// those filetypes (the caller gates on filetype), `true` stored here so
1210    /// `:set noautoclose-tag` can disable it globally.
1211    pub autoclose_tag: bool,
1212    /// Minimum context rows kept visible above/below the cursor when scrolling.
1213    /// Capped at (height - 1) / 2 for tiny viewports. `0` = no margin.
1214    /// Matches vim's `:set scrolloff` / `:set so`. Default `5`.
1215    pub scrolloff: usize,
1216    /// Minimum context columns kept visible left/right of the cursor (no-wrap
1217    /// mode only). `0` = no margin (vim default). Matches `:set sidescrolloff`.
1218    /// Default `0`.
1219    pub sidescrolloff: usize,
1220    /// Auto-reload a clean buffer when its file changes on disk. Matches vim's
1221    /// `:set autoread`. Default `true`. Consumed by the host's `:checktime`.
1222    pub autoreload: bool,
1223    /// Enable vim-sneak style two-char digraph jump via `s` (forward) and
1224    /// `S` (backward). When `true` (default), `s`/`S` no longer behave as
1225    /// vim's built-in substitute-char / substitute-line; `;`/`,` smart-fall-
1226    /// back to sneak-repeat when the last horizontal motion was a sneak.
1227    /// Set `:set nomotion_sneak` to revert `s`/`S` to stock vim behavior.
1228    /// Default `true` — **BREAKING** for users relying on `s` = substitute-char.
1229    pub motion_sneak: bool,
1230    /// Render invisible characters (tabs, trailing spaces, EOL markers).
1231    /// Matches vim's `:set list` / `:set nolist`. Default `false`.
1232    pub list: bool,
1233    /// Show Nerd-Font filetype icons in the tabline. `:set tabline_icons` /
1234    /// `:set notabline_icons`. Default `true`.
1235    pub tabline_icons: bool,
1236    /// Show inline git blame as end-of-line virtual text on the cursor line
1237    /// (gitsigns-style). Default `true`. (#202)
1238    pub blame_inline: bool,
1239    /// Inline diagnostic ghost-text mode (Error-Lens style `// message` at the
1240    /// end of the line). Default [`crate::types::DiagInlineMode::All`].
1241    pub diagnostics_inline: crate::types::DiagInlineMode,
1242    /// Characters used to represent invisibles when `list` is on.
1243    /// Matches vim's `:set listchars` / `:set lcs`.
1244    pub listchars: crate::types::ListChars,
1245    /// Render thin vertical indent guides at every `shiftwidth`-aligned
1246    /// column. hjkl-specific. Default `true`.
1247    pub indent_guides: bool,
1248    /// Character used to draw indent guides. Default `'│'`.
1249    pub indent_guide_char: char,
1250    /// Enable inline color-literal preview. hjkl-specific. Default `true`.
1251    pub colorizer: bool,
1252    /// Filetype allowlist for the colorizer. Default CSS/template languages.
1253    pub colorizer_filetypes: Vec<String>,
1254    /// Run hjkl-mangler formatter before each `:w` save. Default `false`.
1255    pub format_on_save: bool,
1256    /// Strip trailing whitespace before each `:w` save. Default `false`.
1257    pub trim_trailing_whitespace: bool,
1258    /// Enable helix-style rainbow bracket coloring. hjkl-specific. Default `true`.
1259    pub rainbow_brackets: bool,
1260    /// Milliseconds of inactivity before swap-file write. Default `4000`.
1261    /// Matches Vim's `updatetime`; alias `ut`.
1262    pub updatetime: u32,
1263    /// Highlight matching bracket pair under the cursor. hjkl-specific. Default `true`.
1264    /// `:set nomatchparen` / `:set mps` to toggle. Only the char-scan path
1265    /// (C-style brackets) is active; tag-pair matching is pending #240.
1266    pub matchparen: bool,
1267    /// Vim `'fixendofline'` / `'fixeol'`. Default `true`: add the missing
1268    /// final newline on write. See [`crate::types::Options::fixendofline`] —
1269    /// its buffer-local partner `'endofline'` is host state, not a setting.
1270    pub fixendofline: bool,
1271    /// Smooth-scroll animation duration for page/recenter motions, ms.
1272    /// `:set scroll_duration_ms`. Default `0` (instant — animation off).
1273    pub scroll_duration_ms: u16,
1274    /// When `true`, char-wise Visual selections are treated as
1275    /// **half-open** (exclusive end): the cell at the cursor/head position
1276    /// is NOT included in the selection. This matches VSCode / kakoune
1277    /// bar-cursor semantics where the caret sits *between* characters.
1278    /// Default `false` (vim inclusive). The vim oracle path must leave this
1279    /// at `false`; set it programmatically for VSCode keybinding mode.
1280    pub selection_exclusive: bool,
1281    /// How coarsely a single `u` (or Ctrl+Z) step walks back through
1282    /// changes made during an insert session.
1283    ///
1284    /// - `InsertSession` (default, vim parity): one undo step reverts the
1285    ///   entire session from `i` to `<Esc>`. This is byte-identical to
1286    ///   vim's behaviour and must never be changed for the vim path.
1287    /// - `Word`: mid-session undo breaks are inserted at word boundaries
1288    ///   (non-whitespace char following whitespace, or a newline). One
1289    ///   step of `u` then reverts roughly one word of typing at a time —
1290    ///   matching VSCode's "edit-chunked Ctrl+Z" experience.
1291    ///
1292    /// The vim oracle path **must** leave this at `InsertSession`.
1293    /// VSCode keybinding mode sets it to `Word` via
1294    /// `propagate_vscode_settings`. Other future FSMs may choose freely.
1295    pub undo_granularity: UndoGranularity,
1296}
1297
1298/// Controls the granularity of per-insert-session undo steps.
1299///
1300/// Discipline-agnostic: vim uses `InsertSession`, VSCode uses `Word`.
1301/// Future FSMs (emacs, kakoune, …) may adopt either or add new variants.
1302#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
1303pub enum UndoGranularity {
1304    /// One `u` step reverts the entire insert session (vim default).
1305    #[default]
1306    InsertSession,
1307    /// Mid-session undo breaks at word boundaries (non-whitespace after
1308    /// whitespace, or newline). Matches VSCode's Ctrl+Z granularity.
1309    Word,
1310}
1311
1312/// Translate the engine-internal soft-wrap mode into the SPEC one.
1313///
1314/// The two enums are 1:1; this exists so the mapping lives in exactly one
1315/// place instead of being copy-pasted at every `Settings` ↔ `Options`
1316/// boundary. Inverse of [`wrap_from_mode`].
1317fn wrap_to_mode(wrap: hjkl_buffer::Wrap) -> crate::types::WrapMode {
1318    match wrap {
1319        hjkl_buffer::Wrap::None => crate::types::WrapMode::None,
1320        hjkl_buffer::Wrap::Char => crate::types::WrapMode::Char,
1321        hjkl_buffer::Wrap::Word => crate::types::WrapMode::Word,
1322    }
1323}
1324
1325/// Translate a SPEC soft-wrap mode into the engine-internal one.
1326/// Inverse of [`wrap_to_mode`].
1327fn wrap_from_mode(mode: crate::types::WrapMode) -> hjkl_buffer::Wrap {
1328    match mode {
1329        crate::types::WrapMode::None => hjkl_buffer::Wrap::None,
1330        crate::types::WrapMode::Char => hjkl_buffer::Wrap::Char,
1331        crate::types::WrapMode::Word => hjkl_buffer::Wrap::Word,
1332    }
1333}
1334
1335impl Default for Settings {
1336    fn default() -> Self {
1337        Self {
1338            shiftwidth: 4,
1339            tabstop: 4,
1340            softtabstop: 4,
1341            ignore_case: true,
1342            smartcase: true,
1343            hlsearch: true,
1344            incsearch: true,
1345            modeline: true,
1346            modelines: 5,
1347            wrapscan: true,
1348            textwidth: 79,
1349            expandtab: true,
1350            wrap: hjkl_buffer::Wrap::None,
1351            readonly: false,
1352            modifiable: true,
1353            autoindent: true,
1354            smartindent: true,
1355            undo_levels: 1000,
1356            undo_break_on_motion: true,
1357            iskeyword: "@,48-57,_,192-255".to_string(),
1358            timeout_len: core::time::Duration::from_millis(1000),
1359            number: true,
1360            relativenumber: false,
1361            numberwidth: 4,
1362            cursorline: true,
1363            cursorcolumn: false,
1364            signcolumn: crate::types::SignColumnMode::Auto,
1365            foldcolumn: 0,
1366            foldmethod: crate::types::FoldMethod::Expr,
1367            foldenable: true,
1368            foldlevelstart: 99,
1369            foldmarker: "{{{,}}}".to_string(),
1370            colorcolumn: String::new(),
1371            formatoptions: "ro".to_string(),
1372            filetype: String::new(),
1373            commentstring: String::new(),
1374            makeprg: "cargo check".to_string(),
1375            errorformat: "%f:%l:%c:%m,%f:%l:%m,%l:%c:%m".to_string(),
1376            autopair: true,
1377            autoclose_tag: true,
1378            scrolloff: 5,
1379            sidescrolloff: 0,
1380            autoreload: true,
1381            motion_sneak: true,
1382            list: false,
1383            tabline_icons: true,
1384            blame_inline: true,
1385            diagnostics_inline: crate::types::DiagInlineMode::All,
1386            listchars: crate::types::ListChars::default(),
1387            indent_guides: true,
1388            indent_guide_char: '│',
1389            colorizer: true,
1390            colorizer_filetypes: vec![
1391                "css".to_string(),
1392                "scss".to_string(),
1393                "sass".to_string(),
1394                "less".to_string(),
1395                "html".to_string(),
1396                "vue".to_string(),
1397                "svelte".to_string(),
1398                "tailwindcss".to_string(),
1399                "toml".to_string(),
1400                "lua".to_string(),
1401                "vim".to_string(),
1402            ],
1403            format_on_save: true,
1404            trim_trailing_whitespace: false,
1405            rainbow_brackets: true,
1406            updatetime: 4000,
1407            matchparen: true,
1408            fixendofline: true,
1409            scroll_duration_ms: 0,
1410            selection_exclusive: false,
1411            undo_granularity: UndoGranularity::InsertSession,
1412        }
1413    }
1414}
1415
1416impl Settings {
1417    /// Read these settings as a SPEC [`crate::types::Options`] snapshot.
1418    /// Pure [`Settings`] surface — usable without an [`Editor`] (#151 Phase
1419    /// D / Stage 2b: `BufferSlot` holds a bare `Settings` template for
1420    /// windowless slots). [`Editor::current_options`] delegates here.
1421    ///
1422    /// **Exhaustive by construction** — every [`crate::types::Options`] field
1423    /// is listed explicitly, with no `..Options::default()` backfill. That
1424    /// matters because callers do read-modify-apply through this seam
1425    /// (`current_options()` → tweak one field → `apply_options()`); a
1426    /// default-filled field would silently reset every option the caller
1427    /// didn't touch. [`Settings::apply_options`] is the exact inverse: adding
1428    /// a field to one without the other breaks the round trip pinned by
1429    /// `settings_options_round_trip_is_identity`.
1430    ///
1431    pub fn to_options(&self) -> crate::types::Options {
1432        crate::types::Options {
1433            tabstop: self.tabstop as u32,
1434            shiftwidth: self.shiftwidth as u32,
1435            expandtab: self.expandtab,
1436            softtabstop: self.softtabstop as u32,
1437            iskeyword: self.iskeyword.clone(),
1438            ignorecase: self.ignore_case,
1439            smartcase: self.smartcase,
1440            hlsearch: self.hlsearch,
1441            incsearch: self.incsearch,
1442            wrapscan: self.wrapscan,
1443            autoindent: self.autoindent,
1444            smartindent: self.smartindent,
1445            timeout_len: self.timeout_len,
1446            undo_levels: self.undo_levels,
1447            undo_break_on_motion: self.undo_break_on_motion,
1448            readonly: self.readonly,
1449            modifiable: self.modifiable,
1450            wrap: wrap_to_mode(self.wrap),
1451            textwidth: self.textwidth as u32,
1452            number: self.number,
1453            relativenumber: self.relativenumber,
1454            numberwidth: self.numberwidth,
1455            cursorline: self.cursorline,
1456            cursorcolumn: self.cursorcolumn,
1457            signcolumn: self.signcolumn,
1458            foldcolumn: self.foldcolumn,
1459            foldmethod: self.foldmethod,
1460            foldenable: self.foldenable,
1461            foldlevelstart: self.foldlevelstart,
1462            foldmarker: self.foldmarker.clone(),
1463            colorcolumn: self.colorcolumn.clone(),
1464            formatoptions: self.formatoptions.clone(),
1465            filetype: self.filetype.clone(),
1466            scrolloff: self.scrolloff,
1467            sidescrolloff: self.sidescrolloff,
1468            modeline: self.modeline,
1469            modelines: self.modelines,
1470            autoreload: self.autoreload,
1471            motion_sneak: self.motion_sneak,
1472            list: self.list,
1473            listchars: self.listchars.clone(),
1474            indent_guides: self.indent_guides,
1475            indent_guide_char: self.indent_guide_char,
1476            colorizer: self.colorizer,
1477            colorizer_filetypes: self.colorizer_filetypes.clone(),
1478            format_on_save: self.format_on_save,
1479            trim_trailing_whitespace: self.trim_trailing_whitespace,
1480            rainbow_brackets: self.rainbow_brackets,
1481            updatetime: self.updatetime,
1482            matchparen: self.matchparen,
1483            fixendofline: self.fixendofline,
1484        }
1485    }
1486
1487    /// Apply a SPEC [`crate::types::Options`] overlay onto these settings.
1488    /// Pure [`Settings`] surface — see [`Settings::to_options`].
1489    /// [`Editor::apply_options`] delegates here.
1490    ///
1491    /// Writes every `Options` field that has a `Settings` counterpart, so it
1492    /// is the exact inverse of [`Settings::to_options`]. `Settings`-only
1493    /// fields (`commentstring`, `makeprg`, `errorformat`, `autopair`,
1494    /// `autoclose_tag`, `tabline_icons`, `blame_inline`,
1495    /// `diagnostics_inline`, `scroll_duration_ms`, `selection_exclusive`,
1496    /// `undo_granularity`) are host-set and deliberately left untouched.
1497    pub fn apply_options(&mut self, opts: &crate::types::Options) {
1498        self.shiftwidth = opts.shiftwidth as usize;
1499        self.tabstop = opts.tabstop as usize;
1500        self.softtabstop = opts.softtabstop as usize;
1501        self.textwidth = opts.textwidth as usize;
1502        self.expandtab = opts.expandtab;
1503        self.ignore_case = opts.ignorecase;
1504        self.smartcase = opts.smartcase;
1505        self.hlsearch = opts.hlsearch;
1506        self.incsearch = opts.incsearch;
1507        self.modeline = opts.modeline;
1508        self.modelines = opts.modelines;
1509        self.wrapscan = opts.wrapscan;
1510        self.wrap = wrap_from_mode(opts.wrap);
1511        self.readonly = opts.readonly;
1512        self.modifiable = opts.modifiable;
1513        self.autoindent = opts.autoindent;
1514        self.smartindent = opts.smartindent;
1515        self.undo_levels = opts.undo_levels;
1516        self.undo_break_on_motion = opts.undo_break_on_motion;
1517        self.iskeyword.clone_from(&opts.iskeyword);
1518        self.timeout_len = opts.timeout_len;
1519        self.number = opts.number;
1520        self.relativenumber = opts.relativenumber;
1521        self.numberwidth = opts.numberwidth;
1522        self.cursorline = opts.cursorline;
1523        self.cursorcolumn = opts.cursorcolumn;
1524        self.signcolumn = opts.signcolumn;
1525        self.foldcolumn = opts.foldcolumn;
1526        self.foldmethod = opts.foldmethod;
1527        self.foldenable = opts.foldenable;
1528        self.foldlevelstart = opts.foldlevelstart;
1529        self.foldmarker.clone_from(&opts.foldmarker);
1530        self.colorcolumn.clone_from(&opts.colorcolumn);
1531        self.formatoptions.clone_from(&opts.formatoptions);
1532        self.filetype.clone_from(&opts.filetype);
1533        self.scrolloff = opts.scrolloff;
1534        self.sidescrolloff = opts.sidescrolloff;
1535        self.autoreload = opts.autoreload;
1536        self.motion_sneak = opts.motion_sneak;
1537        self.list = opts.list;
1538        self.listchars = opts.listchars.clone();
1539        self.indent_guides = opts.indent_guides;
1540        self.indent_guide_char = opts.indent_guide_char;
1541        self.colorizer = opts.colorizer;
1542        self.colorizer_filetypes
1543            .clone_from(&opts.colorizer_filetypes);
1544        self.format_on_save = opts.format_on_save;
1545        self.trim_trailing_whitespace = opts.trim_trailing_whitespace;
1546        self.rainbow_brackets = opts.rainbow_brackets;
1547        self.updatetime = opts.updatetime;
1548        self.matchparen = opts.matchparen;
1549        self.fixendofline = opts.fixendofline;
1550    }
1551}
1552
1553/// Translate a SPEC [`crate::types::Options`] into the engine's
1554/// internal [`Settings`] representation. Field-by-field map; the
1555/// shapes are isomorphic except for type widths
1556/// (`u32` vs `usize`, [`crate::types::WrapMode`] vs
1557/// [`hjkl_buffer::Wrap`]). 0.1.0 (Patch C-δ) collapses both into one
1558/// type once the `Editor<B, H>::new(buffer, host, options)` constructor
1559/// is the canonical entry point.
1560fn settings_from_options(o: &crate::types::Options) -> Settings {
1561    Settings {
1562        shiftwidth: o.shiftwidth as usize,
1563        tabstop: o.tabstop as usize,
1564        softtabstop: o.softtabstop as usize,
1565        ignore_case: o.ignorecase,
1566        smartcase: o.smartcase,
1567        hlsearch: o.hlsearch,
1568        incsearch: o.incsearch,
1569        modeline: o.modeline,
1570        modelines: o.modelines,
1571        wrapscan: o.wrapscan,
1572        textwidth: o.textwidth as usize,
1573        expandtab: o.expandtab,
1574        wrap: wrap_from_mode(o.wrap),
1575        readonly: o.readonly,
1576        modifiable: o.modifiable,
1577        autoindent: o.autoindent,
1578        smartindent: o.smartindent,
1579        undo_levels: o.undo_levels,
1580        undo_break_on_motion: o.undo_break_on_motion,
1581        iskeyword: o.iskeyword.clone(),
1582        timeout_len: o.timeout_len,
1583        number: o.number,
1584        relativenumber: o.relativenumber,
1585        numberwidth: o.numberwidth,
1586        cursorline: o.cursorline,
1587        cursorcolumn: o.cursorcolumn,
1588        signcolumn: o.signcolumn,
1589        foldcolumn: o.foldcolumn,
1590        foldmethod: o.foldmethod,
1591        foldenable: o.foldenable,
1592        foldlevelstart: o.foldlevelstart,
1593        foldmarker: o.foldmarker.clone(),
1594        colorcolumn: o.colorcolumn.clone(),
1595        formatoptions: o.formatoptions.clone(),
1596        filetype: o.filetype.clone(),
1597        commentstring: String::new(),
1598        makeprg: "cargo check".to_string(),
1599        errorformat: "%f:%l:%c:%m,%f:%l:%m,%l:%c:%m".to_string(),
1600        autopair: true,
1601        autoclose_tag: true,
1602        scrolloff: o.scrolloff,
1603        sidescrolloff: o.sidescrolloff,
1604        autoreload: o.autoreload,
1605        motion_sneak: o.motion_sneak,
1606        list: o.list,
1607        tabline_icons: true,
1608        blame_inline: true,
1609        diagnostics_inline: crate::types::DiagInlineMode::All,
1610        listchars: o.listchars.clone(),
1611        indent_guides: o.indent_guides,
1612        indent_guide_char: o.indent_guide_char,
1613        colorizer: o.colorizer,
1614        colorizer_filetypes: o.colorizer_filetypes.clone(),
1615        format_on_save: o.format_on_save,
1616        trim_trailing_whitespace: o.trim_trailing_whitespace,
1617        rainbow_brackets: o.rainbow_brackets,
1618        updatetime: o.updatetime,
1619        matchparen: o.matchparen,
1620        fixendofline: o.fixendofline,
1621        scroll_duration_ms: 0,
1622        // `selection_exclusive` is not part of `Options` — it is set
1623        // programmatically by the host (e.g. VSCode keybinding mode via
1624        // `propagate_vscode_settings`). Default to `false` (vim inclusive).
1625        selection_exclusive: false,
1626        // `undo_granularity` is not part of `Options` — set programmatically
1627        // by the host. Default: `InsertSession` (vim parity).
1628        undo_granularity: UndoGranularity::InsertSession,
1629    }
1630}
1631
1632/// Host-observable LSP requests triggered by editor bindings. The
1633/// hjkl-engine crate doesn't talk to an LSP itself — it just raises an
1634/// intent that the TUI layer picks up and routes to `sqls`.
1635#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1636pub enum LspIntent {
1637    /// `gd` — textDocument/definition at the cursor.
1638    GotoDefinition,
1639}
1640
1641impl<H: crate::types::Host> Editor<hjkl_buffer::View, H> {
1642    /// Build an [`Editor`] from a buffer, host adapter, and SPEC options.
1643    ///
1644    /// 0.1.0 (Patch C-δ): canonical, frozen constructor per SPEC §"Editor
1645    /// surface". Replaces the pre-0.1.0 `Editor::new(KeybindingMode)` /
1646    /// `with_host` / `with_options` triad — there is no shim.
1647    ///
1648    /// Consumers that don't need a custom host pass
1649    /// [`crate::types::DefaultHost::new()`]; consumers that don't need
1650    /// custom options pass [`crate::types::Options::default()`].
1651    pub fn new(buffer: hjkl_buffer::View, host: H, options: crate::types::Options) -> Self {
1652        let settings = settings_from_options(&options);
1653        Self {
1654            // No discipline: the engine cannot name one. Callers that want vim
1655            // keys build through `hjkl_vim::vim_editor` (or call
1656            // `hjkl_vim::install_vim_discipline`), which fills this slot.
1657            discipline: Box::new(crate::NoDiscipline),
1658            extra_selections: Vec::new(),
1659            view: crate::ViewMode::default(),
1660            change_bank: std::sync::Arc::new(std::sync::Mutex::new(ChangeBank::default())),
1661            viewport_height: AtomicU16::new(0),
1662            pending_lsp: None,
1663            suppress_u_line_track: false,
1664            buffer,
1665            style_table: Vec::new(),
1666            registers: std::sync::Arc::new(std::sync::Mutex::new(
1667                crate::registers::Registers::default(),
1668            )),
1669            styled_spans: Vec::new(),
1670            settings,
1671            global_marks: std::sync::Arc::new(std::sync::Mutex::new(
1672                std::collections::BTreeMap::new(),
1673            )),
1674            jump_back: Vec::new(),
1675            jump_fwd: Vec::new(),
1676            viewport_pinned: false,
1677            scroll_anim_hint: false,
1678            search_prompt: None,
1679            search: std::sync::Arc::new(std::sync::Mutex::new(SearchBank::default())),
1680            last_input_at: None,
1681            last_input_host_at: None,
1682            last_substitute: std::sync::Arc::new(std::sync::Mutex::new(None)),
1683            pending_closes: Vec::new(),
1684            abbrevs: std::sync::Arc::new(std::sync::Mutex::new(Vec::new())),
1685            yank_linewise: false,
1686            current_buffer_id: 0,
1687            sticky_col: None,
1688            host,
1689            last_emitted_mode: crate::CoarseMode::Normal,
1690            search_state: crate::search::SearchState::new(),
1691            buffer_spans: Vec::new(),
1692            last_indent_range: None,
1693            pending_errors: Vec::new(),
1694        }
1695    }
1696}
1697
1698impl<B: crate::types::View, H: crate::types::Host> Editor<B, H> {
1699    /// Borrow the buffer (typed `&B`). Host renders through this via
1700    /// `hjkl_buffer::BufferView` when `B = hjkl_buffer::View`.
1701    pub fn buffer(&self) -> &B {
1702        &self.buffer
1703    }
1704
1705    /// Mutably borrow the buffer (typed `&mut B`).
1706    pub fn buffer_mut(&mut self) -> &mut B {
1707        &mut self.buffer
1708    }
1709
1710    /// Borrow the host adapter directly (typed `&H`).
1711    pub fn host(&self) -> &H {
1712        &self.host
1713    }
1714
1715    /// Mutably borrow the host adapter (typed `&mut H`).
1716    pub fn host_mut(&mut self) -> &mut H {
1717        &mut self.host
1718    }
1719}
1720
1721impl<H: crate::types::Host> Editor<hjkl_buffer::View, H> {
1722    /// Update the active `iskeyword` spec for word motions
1723    /// (`w`/`b`/`e`/`ge` and engine-side `*`/`#` pickup). 0.0.28
1724    /// hoisted iskeyword storage out of `View` — `Editor` is the
1725    /// single owner now. Equivalent to assigning
1726    /// `settings_mut().iskeyword` directly; the dedicated setter is
1727    /// retained for source-compatibility with 0.0.27 callers.
1728    pub fn set_iskeyword(&mut self, spec: impl Into<String>) {
1729        self.settings.iskeyword = spec.into();
1730    }
1731
1732    /// Emit `Host::emit_cursor_shape` if the public mode has changed
1733    /// since the last emit. Engine calls this at the end of every input
1734    /// step so mode transitions surface to the host without sprinkling
1735    /// the call across every `vim.mode = ...` site.
1736    pub fn emit_cursor_shape_if_changed(&mut self) {
1737        // Coarse, not vim: the engine emits render chrome for whatever
1738        // discipline is installed (#265).
1739        let mode = self.coarse_mode();
1740        if mode == self.last_emitted_mode {
1741            return;
1742        }
1743        let exclusive = self.settings.selection_exclusive;
1744        let shape = match mode {
1745            crate::CoarseMode::Insert => crate::types::CursorShape::Bar,
1746            // VSCode: exclusive-visual also uses a bar caret (caret between chars).
1747            crate::CoarseMode::Select if exclusive => crate::types::CursorShape::Bar,
1748            _ => crate::types::CursorShape::Block,
1749        };
1750        self.host.emit_cursor_shape(shape);
1751        self.last_emitted_mode = mode;
1752    }
1753
1754    /// Record a yank/cut payload. Forwards the text to
1755    /// [`crate::types::Host::write_clipboard`] so the platform-clipboard
1756    /// integration can store or transmit it.
1757    pub fn record_yank_to_host(&mut self, text: String) {
1758        self.host.write_clipboard(text);
1759    }
1760
1761    /// Vim's sticky column (curswant). `None` before the first motion;
1762    /// hosts shouldn't normally need to read this directly — it's
1763    /// surfaced for migration off `View::sticky_col` and for
1764    /// snapshot tests.
1765    pub fn sticky_col(&self) -> Option<usize> {
1766        self.sticky_col
1767    }
1768
1769    /// Replace the sticky column. Hosts should rarely touch this —
1770    /// motion code maintains it through the standard horizontal /
1771    /// vertical motion paths.
1772    pub fn set_sticky_col(&mut self, col: Option<usize>) {
1773        self.sticky_col = col;
1774    }
1775
1776    /// Host hook: replace the cached syntax-derived block ranges that
1777    /// `:foldsyntax` consumes. the host calls this on every re-parse;
1778    /// the cost is just a `Vec` swap.
1779    /// Look up a named mark by character. Returns `(row, col)` if
1780    /// set; `None` otherwise. Both lowercase (`'a`–`'z`) and
1781    /// uppercase (`'A`–`'Z`) marks live in the same unified
1782    /// [`Editor::marks`] map as of 0.0.36.
1783    pub fn mark(&self, c: char) -> Option<(usize, usize)> {
1784        self.buffer.mark(c)
1785    }
1786
1787    /// Set the named mark `c` to `(row, col)`. Used by the FSM's
1788    /// `m{a-zA-Z}` keystroke and by [`Editor::restore_snapshot`].
1789    pub fn set_mark(&mut self, c: char, pos: (usize, usize)) {
1790        self.buffer.set_mark(c, pos);
1791    }
1792
1793    /// Remove the named mark `c` (no-op if unset).
1794    pub fn clear_mark(&mut self, c: char) {
1795        self.buffer.clear_mark(c);
1796    }
1797
1798    /// Look up an uppercase global mark by letter. Returns
1799    /// `(buffer_id, row, col)` if set; `None` otherwise.
1800    pub fn global_mark(&self, c: char) -> Option<(u64, usize, usize)> {
1801        self.global_marks.lock().unwrap().get(&c).copied()
1802    }
1803
1804    /// Set an uppercase global mark `c` to `(buffer_id, row, col)`.
1805    pub fn set_global_mark(&mut self, c: char, buffer_id: u64, pos: (usize, usize)) {
1806        self.global_marks
1807            .lock()
1808            .unwrap()
1809            .insert(c, (buffer_id, pos.0, pos.1));
1810    }
1811
1812    /// Point this editor at a shared global-marks bank. All editors in the
1813    /// app share one bank (mirrors [`Editor::set_registers_arc`]) so
1814    /// uppercase marks set in one window/split are visible from every other
1815    /// window — vim's `mA`/`'A` are session-global, not per-window.
1816    pub fn set_global_marks_arc(
1817        &mut self,
1818        global_marks: std::sync::Arc<std::sync::Mutex<GlobalMarks>>,
1819    ) {
1820        self.global_marks = global_marks;
1821    }
1822
1823    /// Return the `buffer_id` this editor is currently attached to.
1824    pub fn current_buffer_id(&self) -> u64 {
1825        self.current_buffer_id
1826    }
1827
1828    /// Update the `buffer_id` this editor is attached to. Called by the
1829    /// app on every `switch_to` so global-mark sets record the correct id.
1830    pub fn set_current_buffer_id(&mut self, id: u64) {
1831        self.current_buffer_id = id;
1832    }
1833
1834    /// Iterate all global marks (`'A'`–`'Z'`), yielding
1835    /// `(mark_char, buffer_id, row, col)`.
1836    pub fn global_marks_iter(&self) -> Vec<(char, u64, usize, usize)> {
1837        self.global_marks
1838            .lock()
1839            .unwrap()
1840            .iter()
1841            .map(|(c, &(bid, r, col))| (*c, bid, r, col))
1842            .collect()
1843    }
1844
1845    /// Discard the most recent undo entry. Used by ex commands that
1846    /// pre-emptively pushed an undo state (`:s`, `:r`) but ended up
1847    /// matching nothing — popping prevents a no-op undo step from
1848    /// polluting the user's history.
1849    ///
1850    /// Returns `true` if an entry was discarded.
1851    pub fn pop_last_undo(&mut self) -> bool {
1852        self.buffer.pop_committed()
1853    }
1854
1855    /// Read all named marks set this session — both lowercase
1856    /// (`'a`–`'z`) and uppercase (`'A`–`'Z`). Iteration is
1857    /// deterministic (BTreeMap-ordered) so snapshot / `:marks`
1858    /// output is stable.
1859    pub fn marks(&self) -> impl Iterator<Item = (char, (usize, usize))> {
1860        self.buffer.marks_cloned().into_iter()
1861    }
1862
1863    /// Position of the last edit (where `.` would replay). `None` if
1864    /// no edit has happened yet on this buffer. Per-buffer (audit B3) —
1865    /// reads the shared [`ChangeBank`] so a `` `. `` jump in one split sees
1866    /// an edit made in a sibling split on the same buffer.
1867    pub fn last_edit_pos(&self) -> Option<(usize, usize)> {
1868        self.change_bank.lock().unwrap().last_edit
1869    }
1870
1871    /// Read-only view of the file-marks table — uppercase / "file"
1872    /// marks (`'A`–`'Z`) the host has set this session. Returns an
1873    /// iterator of `(mark_char, (row, col))` pairs.
1874    ///
1875    /// Mutate via the FSM (`m{A-Z}` keystroke) or via
1876    /// [`Editor::restore_snapshot`].
1877    ///
1878    /// 0.0.36: file marks now live in the unified [`Editor::marks`]
1879    /// map; this accessor is kept for source compatibility and
1880    /// filters the unified map to uppercase entries.
1881    pub fn file_marks(&self) -> impl Iterator<Item = (char, (usize, usize))> {
1882        self.buffer
1883            .marks_cloned()
1884            .into_iter()
1885            .filter(|(c, _)| c.is_ascii_uppercase())
1886    }
1887
1888    /// Read-only view of the cached syntax-derived block ranges that
1889    /// `:foldsyntax` consumes. Returns the slice the host last
1890    /// installed via [`Editor::set_syntax_fold_ranges`]; empty when
1891    /// no syntax integration is active.
1892    pub fn syntax_fold_ranges(&self) -> Vec<(usize, usize)> {
1893        self.buffer.syntax_fold_ranges_cloned()
1894    }
1895
1896    pub fn set_syntax_fold_ranges(&mut self, ranges: Vec<(usize, usize)>) {
1897        self.buffer.set_syntax_fold_ranges(ranges);
1898    }
1899
1900    /// Live settings (read-only). `:set` mutates these via
1901    /// [`Editor::settings_mut`].
1902    pub fn settings(&self) -> &Settings {
1903        &self.settings
1904    }
1905
1906    /// Live settings (mutable). `:set` flows through here to mutate
1907    /// shiftwidth / tabstop / textwidth / ignore_case / wrap. Hosts
1908    /// configuring at startup typically construct a [`Settings`]
1909    /// snapshot and overwrite via `*editor.settings_mut() = …`.
1910    pub fn settings_mut(&mut self) -> &mut Settings {
1911        &mut self.settings
1912    }
1913
1914    /// Set the active filetype (language name) for the current buffer.
1915    /// Used by comment-continuation and future language-aware features.
1916    /// Equivalent to `:set filetype=<lang>`. Pass `""` to clear.
1917    pub fn set_filetype(&mut self, lang: &str) {
1918        self.settings.filetype = lang.to_string();
1919    }
1920
1921    /// Returns `true` when `:set readonly` is active. Convenience
1922    /// accessor for hosts that cannot import the internal [`Settings`]
1923    /// type. Phase 5 binary uses this to gate `:w` writes.
1924    pub fn is_readonly(&self) -> bool {
1925        self.settings.readonly
1926    }
1927
1928    /// Returns `true` when the buffer is modifiable (default). When `false`
1929    /// (`:set nomodifiable`), ALL edits and insert-mode entry are blocked.
1930    pub fn is_modifiable(&self) -> bool {
1931        self.settings.modifiable
1932    }
1933
1934    /// Borrow the engine search state. Hosts inspecting the
1935    /// committed `/` / `?` pattern (e.g. for status-line display) or
1936    /// feeding the active regex into `BufferView::search_pattern`
1937    /// read it from here.
1938    pub fn search_state(&self) -> &crate::search::SearchState {
1939        &self.search_state
1940    }
1941
1942    /// Mutable engine search state. Hosts driving search
1943    /// programmatically (test fixtures, scripted demos) write the
1944    /// pattern through here.
1945    pub fn search_state_mut(&mut self) -> &mut crate::search::SearchState {
1946        &mut self.search_state
1947    }
1948
1949    /// Install `pattern` as the active search regex on the engine
1950    /// state and clear the cached row matches. Pass `None` to clear.
1951    /// 0.0.37: dropped the buffer-side mirror that 0.0.35 introduced
1952    /// — `BufferView` now takes the regex through its `search_pattern`
1953    /// field per step 3 of `DESIGN_33_METHOD_CLASSIFICATION.md`.
1954    pub fn set_search_pattern(&mut self, pattern: Option<regex::Regex>) {
1955        self.search_state.set_pattern(pattern);
1956    }
1957
1958    /// Drive `n` (or the `/` commit equivalent) — advance the cursor
1959    /// to the next match of `search_state.pattern` from the cursor's
1960    /// current position. Returns `true` when a match was found.
1961    /// `skip_current = true` excludes a match the cursor sits on.
1962    /// Opens any fold hiding the match row (vim-correct: search reveals folds).
1963    pub fn search_advance_forward(&mut self, skip_current: bool) -> bool {
1964        let found =
1965            crate::search::search_forward(&mut self.buffer, &mut self.search_state, skip_current);
1966        if found {
1967            let row = crate::types::Cursor::cursor(&self.buffer).line as usize;
1968            self.buffer.reveal_row(row);
1969            self.sync_sticky_col_to_cursor();
1970        }
1971        found
1972    }
1973
1974    /// Drive `N` — symmetric counterpart of [`Editor::search_advance_forward`].
1975    /// Opens any fold hiding the match row (vim-correct: search reveals folds).
1976    pub fn search_advance_backward(&mut self, skip_current: bool) -> bool {
1977        let found =
1978            crate::search::search_backward(&mut self.buffer, &mut self.search_state, skip_current);
1979        if found {
1980            let row = crate::types::Cursor::cursor(&self.buffer).line as usize;
1981            self.buffer.reveal_row(row);
1982            self.sync_sticky_col_to_cursor();
1983        }
1984        found
1985    }
1986
1987    /// Reset `sticky_col` (vim's `curswant`) to the column the cursor is
1988    /// currently on.
1989    ///
1990    /// A search hit is an explicit jump, and vim resets `curswant` on every
1991    /// explicit jump — so the next `j`/`k` aims at the match's column rather
1992    /// than at wherever the cursor sat before the search.
1993    ///
1994    /// This lives on the *advance* rather than at each call site because
1995    /// there are four of them across two crates (`App::commit_search`, the
1996    /// `+/pattern` startup search, the vim search prompt, and the `n`/`N`
1997    /// motion) and only the last happened to be correct — it runs through the
1998    /// vim motion dispatch, which ends in a `move_cursor` call that sets
1999    /// `sticky_col`. Putting it here makes the guarantee structural instead of
2000    /// remembered; the motion path then re-sets the same value, which is a
2001    /// no-op.
2002    fn sync_sticky_col_to_cursor(&mut self) {
2003        let pos = buf_cursor_pos(&self.buffer);
2004        let line = buf_line(&self.buffer, pos.row).unwrap_or_default();
2005        self.sticky_col = Some(char_col_to_visual_col(
2006            &line,
2007            pos.col,
2008            self.settings().tabstop,
2009        ));
2010    }
2011
2012    /// Snapshot of the unnamed register (the default `p` / `P` source).
2013    pub fn yank(&self) -> String {
2014        self.registers.lock().unwrap().unnamed.text.clone()
2015    }
2016
2017    /// Run `f` with shared read access to the register bank — `"`,
2018    /// `"0`–`"9`, `"a`–`"z`. The lock is scoped to the closure — the guard
2019    /// can never escape into caller code, so it can't be held across
2020    /// unrelated editor calls (re-entrancy/deadlock footgun). Never call
2021    /// back into other `ed.` methods that might lock the register bank
2022    /// from inside `f` — extract owned data first if you need to.
2023    pub fn with_registers<R>(&self, f: impl FnOnce(&crate::registers::Registers) -> R) -> R {
2024        f(&self.registers.lock().unwrap())
2025    }
2026
2027    /// Mutable counterpart of [`Editor::with_registers`]. Same
2028    /// closure-scoping invariant: never re-enter the editor from inside
2029    /// `f`, or the mutex will deadlock.
2030    pub fn with_registers_mut<R>(
2031        &self,
2032        f: impl FnOnce(&mut crate::registers::Registers) -> R,
2033    ) -> R {
2034        f(&mut self.registers.lock().unwrap())
2035    }
2036
2037    /// Point this editor at a shared register bank. All editors in the
2038    /// app share one bank so yank/paste work cross-buffer without copying.
2039    pub fn set_registers_arc(
2040        &mut self,
2041        registers: std::sync::Arc<std::sync::Mutex<crate::registers::Registers>>,
2042    ) {
2043        self.registers = registers;
2044    }
2045
2046    /// Host hook: load the OS clipboard's contents into the `"+` / `"*`
2047    /// register slot. the host calls this before letting vim consume a
2048    /// paste so `"*p` / `"+p` reflect the live clipboard rather than a
2049    /// stale snapshot from the last yank.
2050    pub fn sync_clipboard_register(&mut self, text: String, linewise: bool) {
2051        self.registers.lock().unwrap().set_clipboard(text, linewise);
2052    }
2053
2054    /// Snapshot of the change list (positions of recent edits) plus the
2055    /// current walk cursor. Newest entry is at the back. Per-buffer (audit
2056    /// B3) — reads the shared [`ChangeBank`], so this reflects edits made
2057    /// from any window/split on the same buffer.
2058    ///
2059    /// Returns owned data rather than a borrow: the bank lives behind a
2060    /// `Mutex`, so a borrow can't outlive the guard (mirrors
2061    /// [`Editor::global_marks_iter`] / [`Editor::abbrevs`]).
2062    pub fn change_list(&self) -> (Vec<(usize, usize)>, Option<usize>) {
2063        let bank = self.change_bank.lock().unwrap();
2064        (bank.list.clone(), bank.cursor)
2065    }
2066
2067    /// Replace the unnamed register without touching any other slot.
2068    /// For host-driven imports (e.g. system clipboard); operator
2069    /// code uses [`record_yank`] / [`record_delete`].
2070    pub fn set_yank(&mut self, text: impl Into<String>) {
2071        let text = text.into();
2072        let linewise = self.yank_linewise;
2073        self.registers.lock().unwrap().unnamed = crate::registers::Slot {
2074            text,
2075            linewise,
2076            ..Default::default()
2077        };
2078    }
2079
2080    /// Record a yank into `"` and `"0`, plus the named target if the
2081    /// user prefixed `"reg`. Updates `vim.yank_linewise` for the
2082    /// paste path.
2083    pub fn record_yank(&mut self, text: String, linewise: bool, target: Option<char>) {
2084        self.yank_linewise = linewise;
2085        self.registers
2086            .lock()
2087            .unwrap()
2088            .record_yank(text, linewise, target);
2089    }
2090
2091    /// Record a blockwise (visual-block) yank. `width` is the block's
2092    /// column width — every row segment pads to it (with trailing spaces)
2093    /// on paste. `text` is the row segments joined with `\n` (kept as-is
2094    /// for charwise-fallback / RPC). Clears the cached linewise flag.
2095    pub fn record_yank_block(&mut self, text: String, width: usize, target: Option<char>) {
2096        self.yank_linewise = false;
2097        self.registers
2098            .lock()
2099            .unwrap()
2100            .record_yank_block(text, width, target);
2101    }
2102
2103    /// Direct write to a named OR numbered register slot — bypasses the
2104    /// unnamed `"` and `"0` updates that `record_yank` does. Used by the
2105    /// macro recorder so finishing a `q{reg}` recording doesn't pollute
2106    /// the user's last yank.
2107    ///
2108    /// vim's `q{0-9a-zA-Z"}` accepts digit targets too (`:h q`) — `q1`
2109    /// records into `"1`, shadowing whatever the delete/change ring had
2110    /// there, exactly like `qa` overwrites `"a` (audit-r2 fix 5). Digits
2111    /// route to the SAME slots `Registers::read` resolves `'0'`-`'9'`
2112    /// against (`yank_zero` / `delete_ring`), so `@1` replays what `q1`
2113    /// recorded.
2114    pub fn set_named_register_text(&mut self, reg: char, text: String) {
2115        let mut regs = self.registers.lock().unwrap();
2116        if let Some(slot) = match reg {
2117            'a'..='z' => Some(&mut regs.named[(reg as u8 - b'a') as usize]),
2118            'A'..='Z' => Some(&mut regs.named[(reg.to_ascii_lowercase() as u8 - b'a') as usize]),
2119            '0' => Some(&mut regs.yank_zero),
2120            '1'..='9' => Some(&mut regs.delete_ring[(reg as u8 - b'1') as usize]),
2121            _ => None,
2122        } {
2123            slot.text = text;
2124            slot.linewise = false;
2125        }
2126    }
2127
2128    /// Record a delete / change into `"` and, by size, the `"1`–`"9`
2129    /// ring or the `"-` small-delete register. Honours the active
2130    /// named-register prefix.
2131    pub fn record_delete(&mut self, text: String, linewise: bool, target: Option<char>) {
2132        self.yank_linewise = linewise;
2133        self.registers
2134            .lock()
2135            .unwrap()
2136            .record_delete(text, linewise, target);
2137    }
2138
2139    /// Record a blockwise (visual-block) delete / change. See
2140    /// [`Editor::record_yank_block`] for the `width` / `text` contract.
2141    pub fn record_delete_block(&mut self, text: String, width: usize, target: Option<char>) {
2142        self.yank_linewise = false;
2143        self.registers
2144            .lock()
2145            .unwrap()
2146            .record_delete_block(text, width, target);
2147    }
2148
2149    /// Install styled syntax spans using the engine-native
2150    /// [`crate::types::Style`]. Always available — engine is ratatui-free.
2151    /// Ratatui hosts use
2152    /// `hjkl_engine_tui::EditorRatatuiExt::install_ratatui_syntax_spans`
2153    /// which converts at the boundary and delegates here.
2154    ///
2155    /// Renamed from `install_engine_syntax_spans` in 0.0.32 — at the
2156    /// 0.1.0 freeze the unprefixed name is the universally-available
2157    /// engine-native variant.
2158    ///
2159    /// `spans` is any iterator of per-row iterators, so renderer adapters can
2160    /// hand over a lazily converted view of their own span table instead of
2161    /// materialising a whole engine-typed copy first.
2162    pub fn install_syntax_spans<I, R>(&mut self, spans: I)
2163    where
2164        I: IntoIterator<Item = R>,
2165        R: IntoIterator<Item = (usize, usize, crate::types::Style)>,
2166    {
2167        let rows = spans.into_iter();
2168        let cap = rows.size_hint().0;
2169        let mut by_row: Vec<Vec<hjkl_buffer::Span>> = Vec::with_capacity(cap);
2170        let mut engine_spans: Vec<Vec<(usize, usize, crate::types::Style)>> =
2171            Vec::with_capacity(cap);
2172        for (row, row_spans) in rows.enumerate() {
2173            let (translated, translated_e) = self.translate_row_spans(row, row_spans);
2174            by_row.push(translated);
2175            engine_spans.push(translated_e);
2176        }
2177        self.buffer_spans = by_row;
2178        self.styled_spans = engine_spans;
2179    }
2180
2181    /// Clamp + intern one row's spans into the `(buffer_spans, styled_spans)`
2182    /// pair stored for that row. Shared by
2183    /// [`Self::install_syntax_spans`] and [`Self::patch_syntax_spans_range`].
2184    ///
2185    /// Note: do NOT pre-collect line lengths for the whole buffer. Every
2186    /// row-length lookup takes the content mutex; pre-collecting for a
2187    /// 10k-row file turns one install into 10k locks (visible as j/k cursor
2188    /// lag). The lookup here is lazy — a row with no spans never touches the
2189    /// buffer — and memoized per row, so the cost stays proportional to
2190    /// populated rows, not file size.
2191    ///
2192    /// The length comes from [`buf_line_bytes`] (→ `Query::line_bytes`,
2193    /// overridden for `hjkl_buffer::View` to read the rope's line length
2194    /// under one lock with no allocation), *not* from `buf_line(row).len()`,
2195    /// which cloned the whole row into a `String` just to read its length.
2196    /// Both are BYTE counts — `Span::{start,end}_byte` and the tree-sitter
2197    /// ranges they come from are byte offsets, so the clamp unit is
2198    /// unchanged. See `line_bytes_matches_line_len` in `buffer_impl` for the
2199    /// pinned equivalence (and the one documented divergence: rows ended by
2200    /// a non-LF Unicode line break, where `line_bytes` excludes the
2201    /// terminator byte the `String` form kept — the clamp can only get
2202    /// tighter, never looser).
2203    fn translate_row_spans<R>(
2204        &mut self,
2205        row: usize,
2206        row_spans: R,
2207    ) -> (
2208        Vec<hjkl_buffer::Span>,
2209        Vec<(usize, usize, crate::types::Style)>,
2210    )
2211    where
2212        R: IntoIterator<Item = (usize, usize, crate::types::Style)>,
2213    {
2214        let it = row_spans.into_iter();
2215        let cap = it.size_hint().0;
2216        let mut translated = Vec::with_capacity(cap);
2217        let mut translated_e = Vec::with_capacity(cap);
2218        let mut line_len: Option<usize> = None;
2219        for (start, end, style) in it {
2220            let len = match line_len {
2221                Some(l) => l,
2222                None => {
2223                    let l = buf_line_bytes(&self.buffer, row);
2224                    line_len = Some(l);
2225                    l
2226                }
2227            };
2228            // `len + 1` is admitted, anything past it still clamps to `len`.
2229            // Exactly `len + 1` is how a span table marks a multi-row span
2230            // covering this row's end (a markdown fenced code block, a
2231            // multi-line string): the renderer reads that one extra byte —
2232            // the newline slot — as "paint this bg across the rest of the
2233            // row" instead of stopping at the last character, and a blank
2234            // row inside such a span carries `0..1` and nothing else.
2235            // Clamping it to `len` erased both, so a block's tint ended at
2236            // each line's last char and skipped blank lines outright.
2237            // Larger ends stay clamped, so a `usize::MAX` "to end of line"
2238            // sentinel does not accidentally read as a block row.
2239            let end_clamped = if end == len + 1 { end } else { end.min(len) };
2240            if end_clamped <= start {
2241                continue;
2242            }
2243            let id = self.intern_style(style);
2244            translated.push(hjkl_buffer::Span::new(start, end_clamped, id));
2245            translated_e.push((start, end_clamped, style));
2246        }
2247        (translated, translated_e)
2248    }
2249
2250    /// Patch only `rows` of the installed `buffer_spans` / `styled_spans`,
2251    /// leaving rows outside that range untouched. `spans` is indexed by
2252    /// row offset within `rows` — `spans[0]` is for `rows.start`,
2253    /// `spans[1]` for `rows.start + 1`, etc.
2254    ///
2255    /// Use this instead of [`Self::install_syntax_spans`] when a sync
2256    /// `query_viewport` produced spans for the visible region only.
2257    /// Walking the full `line_count` and re-installing every row on
2258    /// every j/k that nudges the viewport dominated the per-keystroke
2259    /// cost on large files; patching just the changed range keeps the
2260    /// cost proportional to viewport size, not file size.
2261    ///
2262    /// Ensures `buffer_spans` / `styled_spans` are sized to the buffer's
2263    /// current `line_count` (resizes if a row-count edit shifted them).
2264    ///
2265    /// `spans` is any iterator of per-row iterators, so renderer adapters can
2266    /// hand over a lazily converted view of their own span table instead of
2267    /// materialising a whole engine-typed copy first.
2268    pub fn patch_syntax_spans_range<I, R>(&mut self, rows: std::ops::Range<usize>, spans: I)
2269    where
2270        I: IntoIterator<Item = R>,
2271        R: IntoIterator<Item = (usize, usize, crate::types::Style)>,
2272    {
2273        let line_count = buf_row_count(&self.buffer);
2274        if self.buffer_spans.len() != line_count {
2275            self.buffer_spans.resize_with(line_count, Vec::new);
2276        }
2277        if self.styled_spans.len() != line_count {
2278            self.styled_spans.resize_with(line_count, Vec::new);
2279        }
2280        for (i, row_spans) in spans.into_iter().enumerate() {
2281            let row = rows.start + i;
2282            if row >= line_count {
2283                break;
2284            }
2285            let (translated, translated_e) = self.translate_row_spans(row, row_spans);
2286            self.buffer_spans[row] = translated;
2287            self.styled_spans[row] = translated_e;
2288        }
2289    }
2290
2291    /// Translate the cached `buffer_spans` / `styled_spans` row indices
2292    /// in-place to track a batch of [`crate::types::ContentEdit`]s without
2293    /// blanking the cache.
2294    ///
2295    /// Why: spans are installed by the async syntax worker, which can lag
2296    /// the buffer by one or more frames after an edit. If the edit changes
2297    /// the row count and we keep the old span rows in place, the renderer
2298    /// paints last-frame's spans at the wrong line — visibly garbled colours.
2299    /// The historical fix was to blank `buffer_spans` whenever a row-count
2300    /// change came through, but that produces a white flash on every Enter
2301    /// or backspace-at-BOL.
2302    ///
2303    /// What this does instead: for each edit, insert empty span rows where
2304    /// the edit grew the buffer and drain rows where it shrank, so the
2305    /// surviving rows still index the right line. Spans on the edited row
2306    /// itself stay (they'll show stale colours for that one row until the
2307    /// worker delivers a fresh parse, which is invisible compared to the
2308    /// blank flash).
2309    ///
2310    /// Edits are applied in order — each edit's `(row, col)` positions are
2311    /// taken to be relative to the post-state of the prior edits in the
2312    /// batch (matching the order the engine emitted them).
2313    pub fn shift_syntax_spans_for_edits(&mut self, edits: &[crate::types::ContentEdit]) {
2314        for edit in edits {
2315            let oer = edit.old_end_position.0 as usize;
2316            let ner = edit.new_end_position.0 as usize;
2317            if ner == oer {
2318                continue;
2319            }
2320            let start_row = edit.start_position.0 as usize;
2321            let start_col = edit.start_position.1 as usize;
2322            // Insert/drain index depends on whether the edit starts at
2323            // the BEGINNING of `start_row` or somewhere INSIDE it.
2324            //   col == 0 → edit is at the very start of `start_row`; new
2325            //              rows go BEFORE row `start_row`, so the affected
2326            //              indices begin AT `start_row`.
2327            //   col > 0 → edit is inside `start_row`; new rows go AFTER
2328            //              `start_row`, so affected indices begin at
2329            //              `start_row + 1`.
2330            //
2331            // Pre-fix this always used `oer + 1` (the col-> 0 branch),
2332            // which left row `start_row`'s spans at its old index while
2333            // the file's row `start_row` was now the freshly-pasted
2334            // content — visible as wrong-row colour mappings after
2335            // `ggP` / `P` / any insert at column 0.
2336            let affected_idx = if start_col == 0 {
2337                start_row
2338            } else {
2339                start_row + 1
2340            };
2341            if ner > oer {
2342                let n = ner - oer;
2343                // O(len + n) via splice; the prior per-row `insert(idx, ...)`
2344                // loop was O(n × (len - idx)), which on a 60k-row paste at
2345                // the BOL became ~1.8 G memmove ops (87 % of paste CPU per
2346                // samply). Splice memmove-shifts once, then fills.
2347                let idx = affected_idx.min(self.buffer_spans.len());
2348                self.buffer_spans
2349                    .splice(idx..idx, std::iter::repeat_with(Vec::new).take(n));
2350                let idx_s = affected_idx.min(self.styled_spans.len());
2351                self.styled_spans
2352                    .splice(idx_s..idx_s, std::iter::repeat_with(Vec::new).take(n));
2353            } else {
2354                let n = oer - ner;
2355                let len_b = self.buffer_spans.len();
2356                let start_b = affected_idx.min(len_b);
2357                let end_b = (start_b + n).min(len_b);
2358                if end_b > start_b {
2359                    self.buffer_spans.drain(start_b..end_b);
2360                }
2361                let len_s = self.styled_spans.len();
2362                let start_s = affected_idx.min(len_s);
2363                let end_s = (start_s + n).min(len_s);
2364                if end_s > start_s {
2365                    self.styled_spans.drain(start_s..end_s);
2366                }
2367            }
2368        }
2369    }
2370
2371    /// Read-only view of the style table in engine-native form —
2372    /// id `i` → `style_table[i]`. Always available, no cfg gate.
2373    ///
2374    /// Ratatui hosts that need `ratatui::style::Style` values convert
2375    /// entries via `hjkl_engine_tui::style_to_ratatui`.
2376    pub fn style_table(&self) -> &[crate::types::Style] {
2377        &self.style_table
2378    }
2379
2380    /// Per-row syntax span overlay, one `Vec<Span>` per buffer row.
2381    /// Hosts feed this slice into [`hjkl_buffer::BufferView::spans`]
2382    /// per draw frame.
2383    ///
2384    /// 0.0.37: replaces `editor.buffer().spans()` per step 3 of
2385    /// `DESIGN_33_METHOD_CLASSIFICATION.md`. The buffer no longer
2386    /// caches spans; they live on the engine and route through the
2387    /// `Host::syntax_highlights` pipeline.
2388    pub fn buffer_spans(&self) -> &[Vec<hjkl_buffer::Span>] {
2389        &self.buffer_spans
2390    }
2391
2392    /// Intern a SPEC [`crate::types::Style`] and return its opaque id.
2393    /// Engine-native — the unified `style_table` is always engine-native.
2394    /// Linear-scan dedup — the table grows only as new tree-sitter token
2395    /// kinds appear, so it stays tiny. Ratatui callers convert at the
2396    /// boundary with `hjkl_engine_tui::style_from_ratatui` and pass the
2397    /// engine-native style here.
2398    ///
2399    /// Renamed from `intern_engine_style` in 0.0.32 — at 0.1.0 freeze
2400    /// the unprefixed name is the universally-available engine-native
2401    /// variant.
2402    pub fn intern_style(&mut self, style: crate::types::Style) -> u32 {
2403        if let Some(idx) = self.style_table.iter().position(|s| *s == style) {
2404            return idx as u32;
2405        }
2406        self.style_table.push(style);
2407        (self.style_table.len() - 1) as u32
2408    }
2409
2410    /// Look up an interned style by id and return it as a SPEC
2411    /// [`crate::types::Style`]. Returns `None` for ids past the end
2412    /// of the table.
2413    pub fn engine_style_at(&self, id: u32) -> Option<crate::types::Style> {
2414        self.style_table.get(id as usize).copied()
2415    }
2416
2417    /// Force the host viewport's top row without touching the
2418    /// cursor. Used by tests that simulate a scroll without the
2419    /// SCROLLOFF cursor adjustment that `scroll_down` / `scroll_up`
2420    /// apply.
2421    ///
2422    /// 0.0.34 (Patch C-δ.1): writes through `Host::viewport_mut`
2423    /// instead of the (now-deleted) `View::viewport_mut`.
2424    pub fn set_viewport_top(&mut self, row: usize) {
2425        let last = buf_row_count(&self.buffer).saturating_sub(1);
2426        let target = row.min(last);
2427        self.host.viewport_mut().top_row = target;
2428    }
2429
2430    /// Set the cursor to `(row, col)`, clamped to the buffer's
2431    /// content. Hosts use this for goto-line, jump-to-mark, and
2432    /// programmatic cursor placement.
2433    ///
2434    /// Resets `sticky_col` (curswant) to `col` — every explicit jump
2435    /// (goto-line, jump-to-mark, search hit, click, `]d`) follows vim
2436    /// semantics. Only `j`/`k`/`+`/`-` READ `sticky_col`; everything
2437    /// else resets it to the column where the cursor actually landed.
2438    pub fn jump_cursor(&mut self, row: usize, col: usize) {
2439        buf_set_cursor_rc(&mut self.buffer, row, col);
2440        let line = buf_line(&self.buffer, row).unwrap_or_default();
2441        self.sticky_col = Some(char_col_to_visual_col(&line, col, self.settings().tabstop));
2442    }
2443
2444    /// Set the cursor to `(row, col)` without modifying `sticky_col`.
2445    ///
2446    /// Use this for host-side state restores (viewport sync, snapshot
2447    /// replay) where the cursor was already at this position semantically
2448    /// and the host's sticky tracking should remain authoritative.
2449    ///
2450    /// For user-facing jumps (goto-line, search hit, picker `<CR>`, `]d`,
2451    /// click), use [`Editor::jump_cursor`] which DOES reset `sticky_col`
2452    /// per vim curswant semantics.
2453    pub fn set_cursor_quiet(&mut self, row: usize, col: usize) {
2454        buf_set_cursor_rc(&mut self.buffer, row, col);
2455    }
2456
2457    /// `(row, col)` cursor read sourced from the migration buffer.
2458    /// Equivalent to `self.textarea.cursor()` when the two are in
2459    /// sync — which is the steady state during Phase 7f because
2460    /// every step opens with `sync_buffer_content_from_textarea` and
2461    /// every ported motion pushes the result back. Prefer this over
2462    /// `self.textarea.cursor()` so call sites keep working unchanged
2463    /// once the textarea field is ripped.
2464    pub fn cursor(&self) -> (usize, usize) {
2465        buf_cursor_rc(&self.buffer)
2466    }
2467
2468    /// The character under the cursor, or `None` at/after end of line (or on
2469    /// an empty line). Used by callers that need vim's on-blank distinctions
2470    /// (e.g. `cw` only acts like `ce` when the cursor is on a non-blank).
2471    pub fn char_at_cursor(&self) -> Option<char> {
2472        let (row, col) = self.cursor();
2473        crate::buf_helpers::buf_line(&self.buffer, row).and_then(|l| l.chars().nth(col))
2474    }
2475
2476    /// Drain any pending LSP intent raised by the last key. Returns
2477    /// `None` when no intent is armed.
2478    pub fn take_lsp_intent(&mut self) -> Option<LspIntent> {
2479        self.pending_lsp.take()
2480    }
2481
2482    /// Drain every [`crate::types::FoldOp`] raised since the last
2483    /// call. Hosts that mirror the engine's fold storage (or that
2484    /// project folds onto a separate fold tree, LSP folding ranges,
2485    /// …) drain this each step and dispatch as their own
2486    /// [`crate::types::Host::Intent`] requires.
2487    ///
2488    /// The engine has already applied every op locally against the
2489    /// in-tree [`hjkl_buffer::View`] fold storage via
2490    /// [`crate::buffer_impl::BufferFoldProviderMut`], so hosts that
2491    /// don't track folds independently can ignore the queue
2492    /// (or simply never call this drain).
2493    ///
2494    /// Introduced in 0.0.38 (Patch C-δ.4).
2495    pub fn take_fold_ops(&mut self) -> Vec<crate::types::FoldOp> {
2496        self.buffer.take_fold_ops()
2497    }
2498
2499    /// Dispatch a [`crate::types::FoldOp`] through the canonical fold
2500    /// surface: queue it for host observation (drained by
2501    /// [`Editor::take_fold_ops`]) and apply it locally against the
2502    /// in-tree buffer fold storage via
2503    /// [`crate::buffer_impl::BufferFoldProviderMut`]. Engine call sites
2504    /// (vim FSM `z…` chords, `:fold*` Ex commands, edit-pipeline
2505    /// invalidation) route every fold mutation through this method.
2506    ///
2507    /// Introduced in 0.0.38 (Patch C-δ.4).
2508    pub fn apply_fold_op(&mut self, op: crate::types::FoldOp) {
2509        use crate::types::FoldProvider;
2510        self.buffer.push_fold_op(op);
2511        let mut provider = crate::buffer_impl::BufferFoldProviderMut::new(&mut self.buffer);
2512        provider.apply(op);
2513        // BUG 2 fix: after a close/toggle-that-closes, the cursor may sit on a
2514        // hidden row (inside the fold body). Vim snaps the cursor to the fold's
2515        // first line (start_row). Do it here so every call site — keyboard `za`/
2516        // `zc` AND the gutter-click path — converges on the same behaviour.
2517        //
2518        // audit-r2 fix 3(b): with NESTED folds (e.g. `zM` closing every fold at
2519        // once), the innermost fold's start_row can itself be hidden by an
2520        // OUTER closed fold, so a single snap can land the cursor on another
2521        // hidden row. Repeatedly snap to the start_row of whichever fold hides
2522        // the CURRENT candidate row, always picking the fold with the smallest
2523        // start_row among those that hide it (the outermost one covering it) —
2524        // each step strictly decreases the row, so this is naturally bounded
2525        // by the row count; `max_iters` is just a defensive backstop.
2526        let mut cursor_row = buf_cursor_row(&self.buffer);
2527        let mut snapped = false;
2528        // One lock, no clone, for the whole snap loop — this used to clone
2529        // the fold `Vec` once per iteration (O(folds²) clones).
2530        self.buffer.with_folds(|folds| {
2531            for _ in 0..(folds.len() + 1) {
2532                let Some(fold) = folds
2533                    .iter()
2534                    .filter(|f| f.hides(cursor_row))
2535                    .min_by_key(|f| f.start_row)
2536                else {
2537                    break;
2538                };
2539                cursor_row = fold.start_row;
2540                snapped = true;
2541            }
2542        });
2543        if snapped {
2544            buf_set_cursor_rc(&mut self.buffer, cursor_row, 0);
2545            self.sticky_col = Some(0);
2546        }
2547    }
2548
2549    /// Refresh the host viewport's height from the cached
2550    /// `viewport_height_value()`. Called from the per-step
2551    /// boilerplate; was the textarea → buffer mirror before Phase 7f
2552    /// put View in charge. 0.0.28 hoisted sticky_col out of
2553    /// `View`. 0.0.34 (Patch C-δ.1) routes the height write through
2554    /// `Host::viewport_mut`.
2555    ///
2556    /// `viewport_height_value()` is an `AtomicU16` that starts at 0 and
2557    /// is only ever written by [`Editor::set_viewport_height`], which a
2558    /// real TUI render loop calls every frame. Headless / embedded
2559    /// hosts (tests, the oracle, `--nvim-api`) never call it, so 0 here
2560    /// means "unset", not "the window is zero rows tall". Treat it as
2561    /// such and leave the host's own (already-correct) viewport height
2562    /// alone — otherwise `M`/`L` and scrolloff math on those hosts see
2563    /// a phantom zero-height window and collapse to `H`.
2564    pub fn sync_buffer_from_textarea(&mut self) {
2565        let height = self.viewport_height_value();
2566        if height != 0 {
2567            self.host.viewport_mut().height = height;
2568        }
2569    }
2570
2571    /// Was the full textarea → buffer content sync. View is the
2572    /// content authority now; this remains as a no-op so the per-step
2573    /// call sites don't have to be ripped in the same patch.
2574    pub fn sync_buffer_content_from_textarea(&mut self) {
2575        self.sync_buffer_from_textarea();
2576    }
2577
2578    /// Push a `(row, col)` onto the back-jumplist so `Ctrl-o` returns
2579    /// to it later. Used by host-driven jumps (e.g. `gd`) that move
2580    /// the cursor without going through the vim engine's motion
2581    /// machinery, where push_jump fires automatically.
2582    pub fn record_jump(&mut self, pos: (usize, usize)) {
2583        const JUMPLIST_MAX: usize = 100;
2584        self.jump_back.push(pos);
2585        if self.jump_back.len() > JUMPLIST_MAX {
2586            self.jump_back.remove(0);
2587        }
2588        self.jump_fwd.clear();
2589    }
2590
2591    /// Host apps call this each draw with the current text area height so
2592    /// scroll helpers can clamp the cursor without recomputing layout.
2593    pub fn set_viewport_height(&self, height: u16) {
2594        self.viewport_height.store(height, Ordering::Relaxed);
2595    }
2596
2597    /// Last height published by `set_viewport_height` (in rows).
2598    pub fn viewport_height_value(&self) -> u16 {
2599        self.viewport_height.load(Ordering::Relaxed)
2600    }
2601
2602    /// Apply `edit` against the buffer and return the inverse so the
2603    /// host can push it onto an undo stack. Side effects: dirty
2604    /// flag, change-list ring, mark / jump-list shifts, change_log
2605    /// append, fold invalidation around the touched rows.
2606    ///
2607    /// The primary edit funnel — both FSM operators and ex commands
2608    /// route mutations through here so the side effects fire
2609    /// uniformly.
2610    pub fn mutate_edit(&mut self, edit: hjkl_buffer::Edit) -> hjkl_buffer::Edit {
2611        // `nomodifiable` OR the BLAME view overlay short-circuits every
2612        // mutation funnel: no buffer change, no dirty flag, no undo entry,
2613        // no change-log emission. We swallow the requested `edit` and hand
2614        // back a self-inverse no-op (`InsertStr` of an empty string at the
2615        // current cursor) so callers that push the return value onto an undo
2616        // stack still get a structurally valid round trip.
2617        // Note: `readonly` no longer blocks edits here — it only gates `:w`.
2618        if !self.settings.modifiable || self.view == crate::ViewMode::Blame {
2619            let _ = edit;
2620            return hjkl_buffer::Edit::InsertStr {
2621                at: buf_cursor_pos(&self.buffer),
2622                text: String::new(),
2623            };
2624        }
2625        // Multi-cursor (#63): every edit cascades, so the secondary selections
2626        // have to be rewritten against the *pre-edit* geometry or they end up
2627        // pointing at the wrong text. This is the single edit funnel, so doing it
2628        // here covers every mutation in the engine by construction. BOTH ends move
2629        // together, and a selection the shift cannot track exactly is dropped
2630        // whole, never guessed and never half-tracked — see `selection_shift`.
2631        if !self.extra_selections.is_empty() {
2632            let edit_ref = &edit;
2633            // `JoinLines` geometry depends on how long each row was *before* the
2634            // join, so the metrics have to be read here — after `apply_buffer_edit`
2635            // they describe the wrong buffer.
2636            let rows = buf_row_count(&self.buffer);
2637            let lens: Vec<usize> = (0..rows).map(|r| buf_line_chars(&self.buffer, r)).collect();
2638            self.extra_selections.retain_mut(|s| {
2639                match crate::selection_shift::shift_sel(
2640                    *s,
2641                    edit_ref,
2642                    |r| lens.get(r).copied().unwrap_or(0),
2643                    rows,
2644                ) {
2645                    Some(shifted) => {
2646                        *s = shifted;
2647                        true
2648                    }
2649                    None => false,
2650                }
2651            });
2652        }
2653        let pre_row = buf_cursor_row(&self.buffer);
2654        let pre_rows = buf_row_count(&self.buffer);
2655        // `U` (`:h U`) bookkeeping: remember `pre_row`'s text before the
2656        // first change lands on it, so `undo_line` can restore it later.
2657        // Reset (fresh snapshot) whenever a change lands on a DIFFERENT
2658        // row than the one currently tracked. `undo_line` sets
2659        // `suppress_u_line_track` around its own restoring edits so this
2660        // generic path doesn't clobber the toggle swap it just performed.
2661        if !self.suppress_u_line_track {
2662            let mut bank = self.change_bank.lock().unwrap();
2663            let fresh = !matches!(&bank.u_line, Some((row, _)) if *row == pre_row);
2664            if fresh {
2665                bank.u_line = Some((pre_row, buf_line(&self.buffer, pre_row).unwrap_or_default()));
2666            }
2667        }
2668        // Capture the pre-edit cursor for the dot mark (`'.` / `` `. ``).
2669        // Vim's `:h '.` says "the position where the last change was made",
2670        // meaning the change-start, not the post-insert cursor. We snap it
2671        // here before `apply_buffer_edit` moves the cursor.
2672        let (pre_edit_row, pre_edit_col) = buf_cursor_rc(&self.buffer);
2673        // Map the underlying buffer edit to a SPEC EditOp for
2674        // change-log emission before consuming it. Coarse — see
2675        // change_log field doc on the struct. Skipped entirely when no
2676        // host subscribed (default): the Vec build + payload clone were
2677        // the per-edit cost the opt-in exists to remove.
2678        if self.buffer.change_log_enabled() {
2679            self.buffer.extend_change_log(edit_to_editops(&edit));
2680        }
2681        // Compute ContentEdit fan-out from the pre-edit buffer state.
2682        // Done before `apply_buffer_edit` consumes `edit` so we can
2683        // inspect the operation's fields and the buffer's pre-edit row
2684        // bytes (needed for byte_of_row / col_byte conversion). Edits
2685        // are pushed onto pending_content_edits for host drain.
2686        let content_edits = content_edits_from_buffer_edit(&self.buffer, &edit);
2687        self.buffer.extend_pending_content_edits(content_edits);
2688        // 0.0.42 (Patch C-δ.7): the `apply_edit` reach is centralized
2689        // in [`crate::buf_helpers::apply_buffer_edit`] (option (c) of
2690        // the 0.0.42 plan — see that fn's doc comment). The free fn
2691        // takes `&mut hjkl_buffer::View` so the editor body itself
2692        // no longer carries a `self.buffer.<inherent>` hop.
2693        let inverse = apply_buffer_edit(&mut self.buffer, edit);
2694        let (pos_row, pos_col) = buf_cursor_rc(&self.buffer);
2695        let post_edit_pos = (pos_row, pos_col);
2696        // Row-count delta the edit produced, needed both to decide how
2697        // folds react (below) and to shift marks/jumplist (below).
2698        // Computed here, right after the buffer mutation, so both use
2699        // the same value.
2700        let post_rows = buf_row_count(&self.buffer);
2701        let delta = post_rows as isize - pre_rows as isize;
2702        if delta == 0 {
2703            // No row-count change: approximate vim's "opening the fold
2704            // you just edited inside" by dropping any fold covering
2705            // either the pre-edit or post-edit cursor row. This catches
2706            // the common single-line edit shapes but is a blunt
2707            // approximation — see `apply_fold_op`'s Invalidate doc.
2708            //
2709            // When the edit DOES change the row count, folds instead go
2710            // through `shift_marks_after_edit` -> `rebase_folds` below,
2711            // which grows/shrinks/clips/drops a fold precisely instead of
2712            // always dropping it (#audit-r2 fix 1).
2713            let lo = pre_row.min(pos_row);
2714            let hi = pre_row.max(pos_row);
2715            self.apply_fold_op(crate::types::FoldOp::Invalidate {
2716                start_row: lo,
2717                end_row: hi,
2718            });
2719        }
2720        // Dot mark / changelist record the PRE-edit position (change
2721        // start), matching vim's `:h '.` semantics — verified against real
2722        // nvim across single-/multi-char inserts, appends, `dw`, `dd`, and
2723        // `x`: `g;` / `` `. `` always land at the change's *start*, never
2724        // wherever the cursor ended up after typing. Previously `'.` used
2725        // the post-edit cursor (diverged from nvim on `iX<Esc>j`) and `g;`
2726        // used it too (diverged on any multi-char change: `AY<Esc>` at the
2727        // end of a 3-char line landed `g;` on col 4, past the Y, instead
2728        // of col 3, on it).
2729        //
2730        // A whole insert-mode session (`AXYZ<Esc>`) is vim's ONE change,
2731        // not three, even though each keystroke is its own `mutate_edit`
2732        // call — confirmed against real nvim (a second `g;` right after
2733        // `AXYZ<Esc>` errors "at start of changelist" rather than finding
2734        // a second entry). Detect burst continuation by comparing this
2735        // edit's pre-edit position against the PREVIOUS call's post-edit
2736        // position: an unbroken typing stream leaves the cursor exactly
2737        // where the next keystroke's edit begins. A `cw`-style
2738        // delete-then-insert combo also chains this way naturally (the
2739        // delete's post-edit cursor is the insert's start), so it lands
2740        // `g;` at the deletion point — matching vim's "one logical
2741        // change" treatment of the whole combo.
2742        //
2743        // Per-buffer (audit B3): both the dot mark and the change-list ring
2744        // live in the shared `ChangeBank`, so an edit here is visible to
2745        // `` `. `` / `g;` from any other window/split on this same buffer.
2746        let mut bank = self.change_bank.lock().unwrap();
2747        let same_burst = bank.last_edit_end == Some((pre_edit_row, pre_edit_col));
2748        if !same_burst {
2749            bank.last_edit = Some((pre_edit_row, pre_edit_col));
2750            // Append to the change-list ring (skip when the cursor sits on
2751            // the same cell as the last entry — back-to-back keystrokes on
2752            // one column shouldn't pollute the ring). A new edit while
2753            // walking the ring trims the forward half, vim style.
2754            let entry = (pre_edit_row, pre_edit_col);
2755            if bank.list.last() != Some(&entry) {
2756                if let Some(idx) = bank.cursor.take() {
2757                    bank.list.truncate(idx + 1);
2758                }
2759                bank.list.push(entry);
2760                let len = bank.list.len();
2761                if len > crate::types::CHANGE_LIST_MAX {
2762                    bank.list.drain(0..len - crate::types::CHANGE_LIST_MAX);
2763                }
2764            }
2765        }
2766        bank.cursor = None;
2767        bank.last_edit_end = Some(post_edit_pos);
2768        drop(bank);
2769        // Shift / drop marks + jump-list entries (and folds, via
2770        // `rebase_folds` inside `shift_marks_after_edit`) to track the row
2771        // delta the edit produced. Without this, every line-changing
2772        // edit silently invalidates `'a`-style positions.
2773        if delta != 0 {
2774            self.shift_marks_after_edit(pre_row, delta);
2775        }
2776        self.mark_content_dirty();
2777        inverse
2778    }
2779
2780    /// Migrate user marks + jumplist entries when an edit at row
2781    /// `edit_start` changes the buffer's row count by `delta` (positive
2782    /// for inserts, negative for deletes). Marks tied to a deleted row
2783    /// are dropped; marks past the affected band shift by `delta`.
2784    ///
2785    /// `pub(crate)` so the substitute applicator (`substitute.rs`) can rebase
2786    /// positions after its whole-content `replace_all`, which — unlike this
2787    /// method's `mutate_edit` caller — never reaches here on its own.
2788    pub(crate) fn shift_marks_after_edit(&mut self, edit_start: usize, delta: isize) {
2789        if delta == 0 {
2790            return;
2791        }
2792        // Deleted-row band (only meaningful for delta < 0). Inclusive
2793        // start, exclusive end.
2794        let drop_end = if delta < 0 {
2795            edit_start.saturating_add((-delta) as usize)
2796        } else {
2797            edit_start
2798        };
2799        let shift_threshold = drop_end.max(edit_start.saturating_add(1));
2800
2801        self.buffer
2802            .rebase_marks(edit_start, drop_end, shift_threshold, delta);
2803
2804        // Manual folds (`zf`) are row-ranges living on the same shared
2805        // buffer as marks; without this shift a fold below/above an edit
2806        // keeps stale row numbers forever (#audit-r2 fix 1). `delta != 0`
2807        // here means `mutate_edit` skipped its cursor-band `Invalidate`
2808        // (that only fires for same-row-count edits), so every surviving
2809        // fold reaches this call and is shifted/clipped/grown/shrunk
2810        // (or dropped, if the edit's deleted band fully consumed it) by
2811        // `rebase_folds` precisely instead of just vanishing.
2812        self.buffer
2813            .rebase_folds(edit_start, drop_end, shift_threshold, delta);
2814
2815        // Shift global marks that belong to the current buffer.
2816        let cur_bid = self.current_buffer_id;
2817        let mut global_marks = self.global_marks.lock().unwrap();
2818        let mut global_to_drop: Vec<char> = Vec::new();
2819        for (c, (bid, row, _col)) in global_marks.iter_mut() {
2820            if *bid != cur_bid {
2821                continue;
2822            }
2823            if (edit_start..drop_end).contains(row) {
2824                global_to_drop.push(*c);
2825            } else if *row >= shift_threshold {
2826                *row = ((*row as isize) + delta).max(0) as usize;
2827            }
2828        }
2829        for c in global_to_drop {
2830            global_marks.remove(&c);
2831        }
2832        drop(global_marks);
2833
2834        let shift_jumps = |entries: &mut Vec<(usize, usize)>| {
2835            entries.retain(|(row, _)| !(edit_start..drop_end).contains(row));
2836            for (row, _) in entries.iter_mut() {
2837                if *row >= shift_threshold {
2838                    *row = ((*row as isize) + delta).max(0) as usize;
2839                }
2840            }
2841        };
2842        shift_jumps(&mut self.jump_back);
2843        shift_jumps(&mut self.jump_fwd);
2844    }
2845
2846    /// Single choke-point for "the buffer just changed". Sets the
2847    /// dirty flag and drops the cached `content_arc` snapshot so
2848    /// subsequent reads rebuild from the live textarea. Callers
2849    /// mutating `textarea` directly (e.g. the TUI's bracketed-paste
2850    /// path) must invoke this to keep the cache honest.
2851    pub fn mark_content_dirty(&mut self) {
2852        self.buffer.mark_content_dirty();
2853    }
2854
2855    /// Returns true if content changed since the last call, then clears the flag.
2856    pub fn take_dirty(&mut self) -> bool {
2857        self.buffer.take_dirty()
2858    }
2859
2860    /// Drain the one-shot smooth-scroll hint (#195). True if the last step ran
2861    /// a page/recenter motion the app may animate.
2862    pub fn take_scroll_anim_hint(&mut self) -> bool {
2863        let h = self.scroll_anim_hint;
2864        self.scroll_anim_hint = false;
2865        h
2866    }
2867
2868    // ── Jumplist / viewport-pin (discipline-agnostic seam, #265) ─────────────
2869    //
2870    // Navigation history and viewport pinning are not vim concepts — VSCode's
2871    // Go Back / Go Forward wants the same jumplist, and any discipline can pin
2872    // the viewport. These accessors live on the engine so a future
2873    // helix/vscode discipline reaches them without depending on hjkl-vim. The
2874    // vim *keybindings* on top (`Ctrl-o` / `Ctrl-i`) stay in hjkl-vim.
2875
2876    /// Read-only view of the jumplist as `(jump_back, jump_fwd)`. Newest entry
2877    /// is at the back of each. Backs `:jumps`.
2878    #[allow(clippy::type_complexity)]
2879    pub fn jump_list(&self) -> (&[(usize, usize)], &[(usize, usize)]) {
2880        (&self.jump_back, &self.jump_fwd)
2881    }
2882
2883    /// Position the cursor was at when the user last jumped back. `None`
2884    /// before any jump.
2885    pub fn last_jump_back(&self) -> Option<(usize, usize)> {
2886        self.jump_back.last().copied()
2887    }
2888
2889    /// Read-only view of the jump-back stack.
2890    pub fn jump_back_list(&self) -> &[(usize, usize)] {
2891        &self.jump_back
2892    }
2893
2894    /// Mutable access to the jump-back stack.
2895    pub fn jump_back_list_mut(&mut self) -> &mut Vec<(usize, usize)> {
2896        &mut self.jump_back
2897    }
2898
2899    /// Read-only view of the jump-forward stack.
2900    pub fn jump_fwd_list(&self) -> &[(usize, usize)] {
2901        &self.jump_fwd
2902    }
2903
2904    /// Mutable access to the jump-forward stack.
2905    pub fn jump_fwd_list_mut(&mut self) -> &mut Vec<(usize, usize)> {
2906        &mut self.jump_fwd
2907    }
2908
2909    /// Whether the viewport is pinned (suppresses scroll-follow).
2910    pub fn viewport_pinned(&self) -> bool {
2911        self.viewport_pinned
2912    }
2913
2914    /// Set the viewport-pinned flag.
2915    pub fn set_viewport_pinned(&mut self, v: bool) {
2916        self.viewport_pinned = v;
2917    }
2918
2919    /// Queue an LSP intent for the host to service on the next tick.
2920    pub fn set_pending_lsp(&mut self, intent: Option<crate::editor::LspIntent>) {
2921        self.pending_lsp = intent;
2922    }
2923
2924    /// Record the row range touched by the most recent auto-indent, for the
2925    /// host to pick up via `take_last_indent_range`.
2926    pub fn set_last_indent_range(&mut self, range: Option<(usize, usize)>) {
2927        self.last_indent_range = range;
2928    }
2929
2930    /// Walk cursor into the change list (`g;` / `g,`), or `None` when not
2931    /// walking. Per-buffer (audit B3) — reads the shared [`ChangeBank`].
2932    pub fn change_list_cursor(&self) -> Option<usize> {
2933        self.change_bank.lock().unwrap().cursor
2934    }
2935
2936    /// Set the change-list walk cursor. Per-buffer (audit B3) — writes the
2937    /// shared [`ChangeBank`], so the walk position is visible to (and can be
2938    /// continued from) any other window/split on the same buffer.
2939    pub fn set_change_list_cursor(&mut self, idx: Option<usize>) {
2940        self.change_bank.lock().unwrap().cursor = idx;
2941    }
2942
2943    /// Point this editor at a shared per-buffer changelist bank. UNLIKE the
2944    /// other `set_*_arc` setters (registers/global-marks/last-substitute/
2945    /// abbrevs/search — one Arc for the whole app session), this one is
2946    /// per-buffer: the caller must fetch-or-create the bank keyed by the
2947    /// target `buffer_id` and swap it in whenever the editor's buffer
2948    /// changes (audit B3). See [`ChangeBank`].
2949    pub fn set_change_bank_arc(&mut self, bank: std::sync::Arc<std::sync::Mutex<ChangeBank>>) {
2950        self.change_bank = bank;
2951    }
2952
2953    /// Arm the one-shot hint that the next scroll should be animated.
2954    pub fn set_scroll_anim_hint(&mut self, v: bool) {
2955        self.scroll_anim_hint = v;
2956    }
2957
2958    /// Set the read-only view overlay (Normal / Blame).
2959    pub fn set_view_mode(&mut self, v: crate::ViewMode) {
2960        self.view = v;
2961    }
2962
2963    /// The active abbreviation table. Returns an owned clone (the value
2964    /// lives behind a shared `Mutex`, so a borrow can't outlive the guard —
2965    /// mirrors [`Editor::global_marks_iter`]).
2966    pub fn abbrevs(&self) -> Vec<crate::abbrev::Abbrev> {
2967        self.abbrevs.lock().unwrap().clone()
2968    }
2969
2970    /// Whether any abbreviations are defined. Cheap emptiness check that
2971    /// locks but does NOT clone — the insert hot path calls this per
2972    /// keystroke, so it must not allocate. Use instead of `abbrevs().is_empty()`.
2973    pub fn abbrevs_is_empty(&self) -> bool {
2974        self.abbrevs.lock().unwrap().is_empty()
2975    }
2976
2977    /// Point this editor at a shared abbreviations bank. All editors in the
2978    /// app share one bank (mirrors [`Editor::set_last_substitute_arc`]) so
2979    /// `:iabbrev` / `:abbreviate` defined in one window/split expand in
2980    /// every other window — vim's abbreviations are session-global, not
2981    /// per-window.
2982    pub fn set_abbrevs_arc(
2983        &mut self,
2984        abbrevs: std::sync::Arc<std::sync::Mutex<Vec<crate::abbrev::Abbrev>>>,
2985    ) {
2986        self.abbrevs = abbrevs;
2987    }
2988
2989    /// Autopair's queued close-brackets, as `(row, col, ch)`. A discipline's
2990    /// insert path consumes a queued close when the user types the matching
2991    /// character instead of inserting a second one.
2992    pub fn pending_closes(&self) -> &[(usize, usize, char)] {
2993        &self.pending_closes
2994    }
2995
2996    /// Mutable access to autopair's queued close-brackets.
2997    pub fn pending_closes_mut(&mut self) -> &mut Vec<(usize, usize, char)> {
2998        &mut self.pending_closes
2999    }
3000
3001    /// Whether the unnamed register's content is linewise.
3002    pub fn yank_linewise(&self) -> bool {
3003        self.yank_linewise
3004    }
3005
3006    /// Set the linewise flag for the unnamed register.
3007    pub fn set_yank_linewise(&mut self, v: bool) {
3008        self.yank_linewise = v;
3009    }
3010
3011    // ── Search state (discipline-agnostic seam, #265) ────────────────────────
3012    //
3013    // Every editor has find. These live on the engine so a helix/vscode
3014    // discipline reaches the pattern, direction and history without depending
3015    // on hjkl-vim. The vim *keybindings* on top (`/`, `?`, `n`, `N`, `*`) stay
3016    // in hjkl-vim.
3017
3018    /// The live `/` or `?` search-prompt state, if a prompt is open.
3019    pub fn search_prompt_state(&self) -> Option<&crate::search::SearchPrompt> {
3020        self.search_prompt.as_ref()
3021    }
3022
3023    /// Mutable access to the live search-prompt state.
3024    pub fn search_prompt_state_mut(&mut self) -> Option<&mut crate::search::SearchPrompt> {
3025        self.search_prompt.as_mut()
3026    }
3027
3028    /// Take (and close) the search-prompt state.
3029    pub fn take_search_prompt_state(&mut self) -> Option<crate::search::SearchPrompt> {
3030        self.search_prompt.take()
3031    }
3032
3033    /// Install (or clear) the search-prompt state.
3034    pub fn set_search_prompt_state(&mut self, prompt: Option<crate::search::SearchPrompt>) {
3035        self.search_prompt = prompt;
3036    }
3037
3038    /// The last committed search pattern, for `n` / `N` (or Find Next).
3039    /// Returns an owned clone (the value lives behind a shared `Mutex`, so a
3040    /// borrow can't outlive the guard — mirrors [`Editor::global_marks_iter`]).
3041    pub fn last_search_pattern(&self) -> Option<String> {
3042        self.search.lock().unwrap().last.clone()
3043    }
3044
3045    /// Set the last search pattern without touching direction or highlight.
3046    pub fn set_last_search_pattern_only(&mut self, pattern: Option<String>) {
3047        self.search.lock().unwrap().last = pattern;
3048    }
3049
3050    /// Set the last search direction without touching the pattern.
3051    pub fn set_last_search_forward_only(&mut self, forward: bool) {
3052        self.search.lock().unwrap().forward = forward;
3053    }
3054
3055    /// The search history (oldest first). Returns an owned clone (the value
3056    /// lives behind a shared `Mutex`, so a borrow can't outlive the guard).
3057    pub fn search_history(&self) -> Vec<String> {
3058        self.search.lock().unwrap().history.clone()
3059    }
3060
3061    /// Cursor position while walking search history with Up/Down.
3062    pub fn search_history_cursor(&self) -> Option<usize> {
3063        self.search.lock().unwrap().history_cursor
3064    }
3065
3066    /// Set the search-history walk cursor.
3067    pub fn set_search_history_cursor(&mut self, idx: Option<usize>) {
3068        self.search.lock().unwrap().history_cursor = idx;
3069    }
3070
3071    // ── Input timing (discipline-agnostic seam) ──────────────────────────────
3072    //
3073    // Any chorded FSM needs a timeout clock, not just vim.
3074
3075    /// Instant of the last input, when the host supplies a monotonic clock.
3076    pub fn last_input_at(&self) -> Option<std::time::Instant> {
3077        self.last_input_at
3078    }
3079
3080    /// Set the instant of the last input.
3081    pub fn set_last_input_at(&mut self, t: Option<std::time::Instant>) {
3082        self.last_input_at = t;
3083    }
3084
3085    /// Host-supplied elapsed time at the last input (no_std hosts).
3086    pub fn last_input_host_at(&self) -> Option<core::time::Duration> {
3087        self.last_input_host_at
3088    }
3089
3090    /// Set the host-supplied elapsed time at the last input.
3091    pub fn set_last_input_host_at(&mut self, d: Option<core::time::Duration>) {
3092        self.last_input_host_at = d;
3093    }
3094
3095    // ── Scrolling (discipline-agnostic seam, #265) ───────────────────────────
3096    //
3097    // Scrolling a viewport is not a vim concept — every discipline does it.
3098    // These carry zero vim FSM state (the one field they used to touch,
3099    // `scroll_anim_hint`, now lives on the Editor), so they belong here. The
3100    // vim *keybindings* on top (`Ctrl-F`/`Ctrl-B`, `Ctrl-D`/`Ctrl-U`,
3101    // `Ctrl-E`/`Ctrl-Y`) stay in hjkl-vim.
3102
3103    /// Rows spanned by half a viewport, times `count` (min 1).
3104    pub fn viewport_half_rows(&self, count: usize) -> usize {
3105        let h = self.viewport_height_value() as usize;
3106        (h / 2).max(1).saturating_mul(count.max(1))
3107    }
3108
3109    /// Rows spanned by a full viewport (less a two-line overlap), times
3110    /// `count` (min 1).
3111    pub fn viewport_full_rows(&self, count: usize) -> usize {
3112        let h = self.viewport_height_value() as usize;
3113        h.saturating_sub(2).max(1).saturating_mul(count.max(1))
3114    }
3115
3116    /// Move the cursor `delta` rows (clamped to the buffer), landing on the
3117    /// first non-blank of the target row and resetting the sticky column.
3118    pub fn scroll_cursor_rows(&mut self, delta: isize) {
3119        if delta == 0 {
3120            return;
3121        }
3122        self.sync_buffer_content_from_textarea();
3123        let (row, _) = self.cursor();
3124        let last_row = buf_row_count(&self.buffer).saturating_sub(1);
3125        let target = (row as isize + delta).max(0).min(last_row as isize) as usize;
3126        buf_set_cursor_rc(&mut self.buffer, target, 0);
3127        crate::motions::move_first_non_blank(&mut self.buffer);
3128        let pos = buf_cursor_pos(&self.buffer);
3129        let line = buf_line(&self.buffer, pos.row).unwrap_or_default();
3130        self.sticky_col = Some(char_col_to_visual_col(
3131            &line,
3132            pos.col,
3133            self.settings().tabstop,
3134        ));
3135    }
3136
3137    /// Scroll the cursor by one full viewport height (height − 2 rows,
3138    /// preserving a two-line overlap). `count` multiplies the step.
3139    pub fn scroll_full_page(&mut self, dir: crate::types::ScrollDir, count: usize) {
3140        self.scroll_anim_hint = true;
3141        let rows = self.viewport_full_rows(count) as isize;
3142        match dir {
3143            crate::types::ScrollDir::Down => self.scroll_cursor_rows(rows),
3144            crate::types::ScrollDir::Up => self.scroll_cursor_rows(-rows),
3145        }
3146    }
3147
3148    /// Scroll the cursor by half the viewport height. `count` multiplies.
3149    pub fn scroll_half_page(&mut self, dir: crate::types::ScrollDir, count: usize) {
3150        self.scroll_anim_hint = true;
3151        let rows = self.viewport_half_rows(count) as isize;
3152        match dir {
3153            crate::types::ScrollDir::Down => self.scroll_cursor_rows(rows),
3154            crate::types::ScrollDir::Up => self.scroll_cursor_rows(-rows),
3155        }
3156    }
3157
3158    /// Scroll the viewport `count` lines without moving the cursor (the cursor
3159    /// is clamped into the new visible region if it would fall outside).
3160    pub fn scroll_line(&mut self, dir: crate::types::ScrollDir, count: usize) {
3161        let n = count.max(1);
3162        let total = buf_row_count(&self.buffer);
3163        let last = total.saturating_sub(1);
3164        let h = self.viewport_height_value() as usize;
3165        let cur_top = self.host().viewport().top_row;
3166        let new_top = match dir {
3167            crate::types::ScrollDir::Down => (cur_top + n).min(last),
3168            crate::types::ScrollDir::Up => cur_top.saturating_sub(n),
3169        };
3170        self.set_viewport_top(new_top);
3171        // Clamp cursor to stay within the new visible region.
3172        let (row, _) = self.cursor();
3173        let bot = (new_top + h).saturating_sub(1).min(last);
3174        let clamped = row.max(new_top).min(bot);
3175        if clamped != row {
3176            // `<C-e>` / `<C-y>` are screen-line vertical motions, so pushing
3177            // the cursor onto a new row follows the `j` / `k` rule: aim at
3178            // `curswant`, clamp to the row, keep the un-clamped want. This
3179            // used to re-use the old column verbatim, which both ignored
3180            // `curswant` and parked the cursor past end-of-line on a shorter
3181            // row. Found by the `esc_returns_to_normal` proptest via the
3182            // phase-0 curswant assertion.
3183            self.move_cursor(crate::cursor_move::Move::Vertical { row: clamped });
3184        }
3185    }
3186
3187    /// Drain the queue of [`crate::types::ContentEdit`]s emitted since
3188    /// the last call. Each entry corresponds to a single buffer
3189    /// mutation funnelled through [`Editor::mutate_edit`]; block edits
3190    /// fan out to one entry per row touched.
3191    ///
3192    /// Hosts call this each frame (after [`Editor::take_content_reset`])
3193    /// to fan edits into a tree-sitter parser via `Tree::edit`.
3194    pub fn take_content_edits(&mut self) -> Vec<crate::types::ContentEdit> {
3195        self.buffer.take_pending_content_edits()
3196    }
3197
3198    /// Returns `true` if a bulk buffer replacement happened since the
3199    /// last call (e.g. `set_content` / `restore` / undo restore), then
3200    /// clears the flag. When this returns `true`, hosts should drop
3201    /// any retained syntax tree before consuming
3202    /// [`Editor::take_content_edits`].
3203    pub fn take_content_reset(&mut self) -> bool {
3204        self.buffer.take_pending_content_reset()
3205    }
3206
3207    /// Pull-model coarse change observation. If content changed since
3208    /// the last call, returns `Some(Arc<String>)` with the new content
3209    /// and clears the dirty flag; otherwise returns `None`.
3210    ///
3211    /// Hosts that need fine-grained edit deltas (e.g., DOM patching at
3212    /// the character level) should diff against their own previous
3213    /// snapshot. The SPEC `take_changes() -> Vec<EditOp>` API lands
3214    /// once every edit path inside the engine is instrumented; this
3215    /// coarse form covers the pull-model use case in the meantime.
3216    pub fn take_content_change(&mut self) -> Option<std::sync::Arc<String>> {
3217        if !self.buffer.content_dirty() {
3218            return None;
3219        }
3220        let arc = self.content_arc();
3221        self.buffer.set_content_dirty(false);
3222        Some(arc)
3223    }
3224
3225    /// Width in cells of the line-number gutter for the current buffer
3226    /// and settings. Matches what [`Editor::cursor_screen_pos`] reserves
3227    /// in front of the text column. Returns `0` when both `number` and
3228    /// `relativenumber` are off.
3229    pub fn lnum_width(&self) -> u16 {
3230        if self.settings.number || self.settings.relativenumber {
3231            let needed = buf_row_count(&self.buffer).to_string().len() + 1;
3232            needed.max(self.settings.numberwidth) as u16
3233        } else {
3234            0
3235        }
3236    }
3237
3238    /// Returns the cursor's row within the visible textarea (0-based), updating
3239    /// the stored viewport top so subsequent calls remain accurate.
3240    pub fn cursor_screen_row(&mut self, height: u16) -> u16 {
3241        let cursor = buf_cursor_row(&self.buffer);
3242        let top = self.host.viewport().top_row;
3243        cursor
3244            .saturating_sub(top)
3245            .min((height as usize).saturating_sub(1)) as u16
3246    }
3247
3248    /// Returns the cursor's screen position `(x, y)` for the textarea
3249    /// described by `(area_x, area_y, area_width, area_height)`.
3250    /// Accounts for line-number gutter, viewport scroll, and any extra
3251    /// gutter width to the left of the number column (sign column, fold
3252    /// column). Returns `None` if the cursor is outside the visible
3253    /// viewport. Always available (engine-native; no ratatui dependency).
3254    ///
3255    /// `extra_gutter_width` is added to the number-column width before
3256    /// computing the cursor x position. Callers (e.g. `apps/hjkl/src/render.rs`)
3257    /// pass `sign_w + fold_w` here so the cursor lands on the correct cell
3258    /// when a dedicated sign or fold column is present.
3259    ///
3260    /// Renamed from `cursor_screen_pos_xywh` in 0.0.32.
3261    pub fn cursor_screen_pos(
3262        &self,
3263        area_x: u16,
3264        area_y: u16,
3265        area_width: u16,
3266        area_height: u16,
3267        extra_gutter_width: u16,
3268    ) -> Option<(u16, u16)> {
3269        let (pos_row, pos_col) = buf_cursor_rc(&self.buffer);
3270        let v = self.host.viewport();
3271        if pos_row < v.top_row || pos_col < v.top_col {
3272            return None;
3273        }
3274        let lnum_width = self.lnum_width();
3275        // Full offset from the left edge of the window to the first text cell.
3276        let gutter_total = lnum_width + extra_gutter_width;
3277        // Screen row delta: delegate to the single fold- and wrap-aware
3278        // calculator that already drives scrolling + scrolloff, rather than
3279        // recomputing `pos_row - top_row` here. That naive delta ignored rows
3280        // collapsed by closed folds, painting the cursor block N rows too low
3281        // while the (fold-aware) text + line-highlight rendered correctly.
3282        // One source of truth → no drift between scroll math and cursor math. (#244)
3283        let folds = crate::buffer_impl::SnapshotFoldProvider::from_buffer(&self.buffer);
3284        let dy = crate::viewport_math::cursor_screen_row_from(&self.buffer, &folds, v, v.top_row)?
3285            as u16;
3286        // Convert char column to visual column so cursor lands on the
3287        // correct cell when the line contains tabs (which the renderer
3288        // expands to TAB_WIDTH stops). Tab width must match the renderer.
3289        let cursor_rope = self.buffer.rope();
3290        let pos_row_safe = pos_row.min(cursor_rope.len_lines().saturating_sub(1));
3291        let line = hjkl_buffer::rope_line_str(&cursor_rope, pos_row_safe);
3292        let tab_width = if v.tab_width == 0 {
3293            4
3294        } else {
3295            v.tab_width as usize
3296        };
3297        let visual_pos = visual_col_for_char(&line, pos_col, tab_width);
3298        let visual_top = visual_col_for_char(&line, v.top_col, tab_width);
3299        let dx = (visual_pos - visual_top) as u16;
3300        if dy >= area_height || dx + gutter_total >= area_width {
3301            return None;
3302        }
3303        Some((area_x + gutter_total + dx, area_y + dy))
3304    }
3305
3306    /// Discipline-agnostic coarse mode for app chrome (status badge, cursor
3307    /// shape). App code that only needs "inserting / selecting / idle" — not the
3308    /// precise vim mode — should read this so it works identically under any
3309    /// keybinding discipline (vim, vscode, future helix/emacs). See
3310    /// [`crate::CoarseMode`] (epic #265 G3). Today this projects from the vim
3311    /// mode; once FSM state is pluggable each discipline supplies its own.
3312    pub fn coarse_mode(&self) -> crate::CoarseMode {
3313        self.discipline.coarse_mode()
3314    }
3315
3316    /// The secondary selections, in char columns. Empty for a single-cursor
3317    /// editor.
3318    ///
3319    /// The primary selection is *not* included: its head is [`Editor::cursor`]
3320    /// and its anchor lives in the discipline — see the `extra_selections` field
3321    /// docs for why.
3322    pub fn extra_selections(&self) -> &[crate::selection_shift::Sel] {
3323        &self.extra_selections
3324    }
3325
3326    /// The **heads** of the secondary selections — the carets a user sees.
3327    ///
3328    /// Convenience view over [`Editor::extra_selections`] for callers that only
3329    /// care where the carets are (rendering, tests).
3330    pub fn extra_cursors(&self) -> Vec<hjkl_buffer::Position> {
3331        self.extra_selections.iter().map(|s| s.head).collect()
3332    }
3333
3334    /// Replace the whole secondary set.
3335    ///
3336    /// Selections whose head duplicates the primary head, or an earlier entry's
3337    /// head, are dropped: two carets on one spot would apply every edit twice at
3338    /// the same place. Same invariant [`Editor::add_cursor`] enforces, applied to
3339    /// a bulk write — a discipline recomputing every selection after a motion
3340    /// (helix does this on every keystroke) must not be able to smuggle a
3341    /// duplicate in through the back door.
3342    ///
3343    /// Any two selections whose *ranges* overlap (not just their heads) are
3344    /// merged into their union rather than kept as separate entries (audit
3345    /// A7) — [`Editor::edit_at_all_selections`]'s bottom-up fan-out assumes
3346    /// selections are disjoint, and an overlapping pair would corrupt each
3347    /// other's still-queued coordinates as edits land.
3348    pub fn set_extra_selections(&mut self, sels: Vec<crate::selection_shift::Sel>) {
3349        let (row, col) = self.cursor();
3350        let primary = hjkl_buffer::Position::new(row, col);
3351        let mut deduped: Vec<crate::selection_shift::Sel> = Vec::new();
3352        for s in sels {
3353            if s.head == primary || deduped.iter().any(|e| e.head == s.head) {
3354                continue;
3355            }
3356            deduped.push(s);
3357        }
3358        self.extra_selections = crate::selection_shift::merge_overlapping(deduped);
3359    }
3360
3361    /// Add a secondary selection. Same dedup rule as [`Editor::add_cursor`],
3362    /// plus the overlap-merge guard documented on [`Editor::set_extra_selections`]
3363    /// (audit A7): a selection whose range overlaps an existing secondary is
3364    /// merged into it instead of being kept as a second, aliasing entry.
3365    pub fn add_selection(&mut self, sel: crate::selection_shift::Sel) {
3366        let (row, col) = self.cursor();
3367        if sel.head == hjkl_buffer::Position::new(row, col)
3368            || self.extra_selections.iter().any(|s| s.head == sel.head)
3369        {
3370            return;
3371        }
3372        self.extra_selections.push(sel);
3373        self.extra_selections =
3374            crate::selection_shift::merge_overlapping(std::mem::take(&mut self.extra_selections));
3375    }
3376
3377    /// Add a secondary cursor: a zero-width selection at `pos`. Ignores a
3378    /// position that duplicates the primary head or an existing secondary head,
3379    /// so a set never carries two carets at one spot — that would apply an edit
3380    /// twice at the same place.
3381    pub fn add_cursor(&mut self, pos: hjkl_buffer::Position) {
3382        self.add_selection(crate::selection_shift::Sel::caret(pos));
3383    }
3384
3385    /// Drop every secondary selection, collapsing back to the primary.
3386    pub fn clear_extra_cursors(&mut self) {
3387        self.extra_selections.clear();
3388    }
3389
3390    /// Apply an edit at **every** cursor — the primary and all secondaries —
3391    /// and leave each cursor where its own edit left it (#63).
3392    ///
3393    /// `make` is handed each cursor's position and returns the edit to apply
3394    /// there, so the caller writes the edit once and it fans out:
3395    ///
3396    /// ```ignore
3397    /// ed.edit_at_all_cursors(|at| Edit::InsertStr { at, text: "x".into() });
3398    /// ```
3399    ///
3400    /// Returns the inverse of each applied edit, in application order, so a
3401    /// caller can push them as one undo step. This does **not** touch the undo
3402    /// stack itself — `mutate_edit` never does, and a multi-cursor keystroke is
3403    /// one user action, so the discipline pushes undo once before calling.
3404    ///
3405    /// # Why the order matters
3406    ///
3407    /// Edits are applied **bottom-up** (last cursor in the document first). An
3408    /// edit at position P only moves positions at or after P, so working
3409    /// backwards leaves every not-yet-visited cursor's coordinates still valid.
3410    /// Going top-down would invalidate them all after the first edit.
3411    ///
3412    /// Each cursor that has already been edited is parked in `extra_cursors`,
3413    /// so [`Editor::mutate_edit`]'s shift keeps it correct as the remaining
3414    /// (earlier) edits land. The bookkeeping is the same machinery, reused.
3415    ///
3416    /// # Degradation
3417    ///
3418    /// If any cursor becomes untrackable mid-apply (see `selection_shift`), the
3419    /// secondaries are dropped and the editor collapses to the primary rather
3420    /// than carrying on with a caret that no longer knows where it is.
3421    pub fn edit_at_all_cursors(
3422        &mut self,
3423        make: impl Fn(hjkl_buffer::Position) -> hjkl_buffer::Edit,
3424    ) -> Vec<hjkl_buffer::Edit> {
3425        let (pr, pc) = self.cursor();
3426        let primary = hjkl_buffer::Position::new(pr, pc);
3427        let (inverses, _) = self.edit_at_all_selections(primary, |s| make(s.head));
3428        inverses
3429    }
3430
3431    /// Apply an edit at **every selection** — the primary and all secondaries —
3432    /// where `make` sees the whole selection, not just its head (#63).
3433    ///
3434    /// This is what an operator needs: `d` on three selections has to delete
3435    /// three *ranges*, and only the caller-visible [`Sel`] carries both ends.
3436    /// [`Editor::edit_at_all_cursors`] is the caret-only special case of this.
3437    ///
3438    /// `primary_anchor` is passed in — and the primary's *new* anchor is returned
3439    /// — because the primary selection's anchor lives in the discipline's state,
3440    /// not the engine's (see the `extra_selections` field docs).
3441    ///
3442    /// Returns `(inverse of each applied edit in application order, new primary
3443    /// anchor)`. This does **not** touch the undo stack — `mutate_edit` never
3444    /// does, and a multi-cursor keystroke is one user action, so the discipline
3445    /// pushes undo once before calling.
3446    ///
3447    /// # Why the order matters
3448    ///
3449    /// Edits are applied **bottom-up** (last selection in the document first). An
3450    /// edit at position P only moves positions at or after P, so working
3451    /// backwards leaves every not-yet-visited selection's coordinates still valid.
3452    /// Going top-down would invalidate them all after the first edit.
3453    ///
3454    /// Each selection that has already been edited is parked in
3455    /// `extra_selections`, so [`Editor::mutate_edit`]'s shift keeps it correct as
3456    /// the remaining (earlier) edits land.
3457    ///
3458    /// # What happens to the anchors
3459    ///
3460    /// Each selection's anchor is shifted through *its own* edit with the same
3461    /// insertion-point semantics [`crate::selection_shift`] uses everywhere: an
3462    /// anchor swallowed by a deletion collapses onto the deletion start, which is
3463    /// exactly where the head lands — so `d` / `c` leave a caret at each edit
3464    /// site, with no bookkeeping. An anchor sitting exactly at an insertion point
3465    /// slides right with the text. A caller that needs a selection *preserved*
3466    /// across a same-length rewrite (helix's `~`, `>`) should re-set the
3467    /// selections afterwards via [`Editor::set_extra_selections`] rather than
3468    /// rely on that shift.
3469    ///
3470    /// # Degradation
3471    ///
3472    /// If any selection becomes untrackable mid-apply (see `selection_shift`), the
3473    /// secondaries are dropped and the editor collapses to the primary rather than
3474    /// carrying on with a selection that no longer knows where it is.
3475    ///
3476    /// [`Sel`]: crate::selection_shift::Sel
3477    pub fn edit_at_all_selections(
3478        &mut self,
3479        primary_anchor: hjkl_buffer::Position,
3480        make: impl Fn(crate::selection_shift::Sel) -> hjkl_buffer::Edit,
3481    ) -> (Vec<hjkl_buffer::Edit>, hjkl_buffer::Position) {
3482        use crate::selection_shift::Sel;
3483
3484        let (pr, pc) = self.cursor();
3485        let primary = Sel::new(primary_anchor, hjkl_buffer::Position::new(pr, pc));
3486
3487        let mut all: Vec<Sel> = std::iter::once(primary)
3488            .chain(self.extra_selections.iter().copied())
3489            .collect();
3490        // Bottom-up by where each selection's edit *starts* — its earlier end.
3491        // For a caret that is just the head, so this is the same order as before.
3492        all.sort_by_key(|s| std::cmp::Reverse((s.start().row, s.start().col)));
3493
3494        // Rebuilt as we go: a selection lands in here the moment its edit is done,
3495        // which enrols it in the shift for every later edit.
3496        self.extra_selections.clear();
3497
3498        let mut inverses = Vec::with_capacity(all.len());
3499        let mut primary_idx: Option<usize> = None;
3500        let mut lost_a_selection = false;
3501
3502        for (i, s) in all.iter().copied().enumerate() {
3503            // Every previous iteration should have parked exactly one selection.
3504            // If the count slipped, `mutate_edit` dropped one it could not track.
3505            if self.extra_selections.len() != i {
3506                lost_a_selection = true;
3507                break;
3508            }
3509            let edit = make(s);
3510            // The anchor has to be shifted against the PRE-edit geometry, same as
3511            // the parked selections are — so read the metrics before applying.
3512            let rows = buf_row_count(&self.buffer);
3513            let lens: Vec<usize> = (0..rows).map(|r| buf_line_chars(&self.buffer, r)).collect();
3514            let shifted_anchor = crate::selection_shift::shift_position(
3515                s.anchor,
3516                &edit,
3517                |r| lens.get(r).copied().unwrap_or(0),
3518                rows,
3519            );
3520
3521            self.set_cursor_quiet(s.head.row, s.head.col);
3522            inverses.push(self.mutate_edit(edit));
3523            let (nr, nc) = self.cursor();
3524
3525            let Some(anchor) = shifted_anchor else {
3526                lost_a_selection = true;
3527                break;
3528            };
3529            if s == primary && primary_idx.is_none() {
3530                primary_idx = Some(self.extra_selections.len());
3531            }
3532            self.extra_selections
3533                .push(Sel::new(anchor, hjkl_buffer::Position::new(nr, nc)));
3534        }
3535
3536        match (lost_a_selection, primary_idx) {
3537            (false, Some(idx)) if idx < self.extra_selections.len() => {
3538                // Pull the primary back out of the parked set; the rest stay.
3539                let landed = self.extra_selections.remove(idx);
3540                self.set_cursor_quiet(landed.head.row, landed.head.col);
3541                (inverses, landed.anchor)
3542            }
3543            _ => {
3544                // Something went untrackable: collapse to a single selection rather
3545                // than leave one pointing at text it no longer owns.
3546                self.extra_selections.clear();
3547                let (row, col) = self.cursor();
3548                (inverses, hjkl_buffer::Position::new(row, col))
3549            }
3550        }
3551    }
3552
3553    /// The installed discipline's FSM state, type-erased.
3554    ///
3555    /// A discipline crate reaches its own concrete state by downcasting:
3556    /// `ed.discipline().as_any().downcast_ref::<VimState>()`.
3557    pub fn discipline(&self) -> &dyn crate::DisciplineState {
3558        &*self.discipline
3559    }
3560
3561    /// Mutable counterpart of [`Editor::discipline`].
3562    pub fn discipline_mut(&mut self) -> &mut dyn crate::DisciplineState {
3563        &mut *self.discipline
3564    }
3565
3566    /// Install a keyboard discipline, replacing whatever was there.
3567    ///
3568    /// Host apps call this once at construction (e.g.
3569    /// `hjkl_vim::install_vim_discipline(&mut ed)`); an `Editor` that never
3570    /// receives discipline input keeps the default
3571    /// [`NoDiscipline`](crate::NoDiscipline).
3572    pub fn set_discipline(&mut self, discipline: Box<dyn crate::DisciplineState>) {
3573        self.discipline = discipline;
3574    }
3575
3576    /// The active read-only view overlay (see [`crate::ViewMode`]). Independent
3577    /// of [`Editor::vim_mode`]; the host renderer reads this as the source of
3578    /// truth for whether to draw the git-blame framing.
3579    pub fn view_mode(&self) -> crate::ViewMode {
3580        self.view
3581    }
3582
3583    /// `true` when the git-blame read-only overlay is active. Masked on the
3584    /// input mode: BLAME is only meaningful in Normal, so this returns `false`
3585    /// the instant the editor enters Insert/Visual/etc., even before the
3586    /// overlay flag is dropped. Use this for both rendering and mode-label.
3587    pub fn is_blame(&self) -> bool {
3588        self.view == crate::ViewMode::Blame && self.coarse_mode() == crate::CoarseMode::Normal
3589    }
3590
3591    /// Enter the git-blame read-only overlay. No-op unless the editor is in
3592    /// Normal mode (BLAME is a Normal-only view). While active, every mutation
3593    /// funnel is blocked and the host renders the per-commit framing.
3594    pub fn enter_blame(&mut self) {
3595        if self.coarse_mode() == crate::CoarseMode::Normal {
3596            self.view = crate::ViewMode::Blame;
3597        }
3598    }
3599
3600    /// Leave the git-blame overlay, returning to a plain Normal view. Idempotent.
3601    pub fn exit_blame(&mut self) {
3602        self.view = crate::ViewMode::Normal;
3603    }
3604
3605    /// Bounds of the active visual-block rectangle as
3606    /// `(top_row, bot_row, left_col, right_col)` — all inclusive.
3607    /// `None` when we're not in VisualBlock mode.
3608    /// Read-only view of the live `/` or `?` prompt. `None` outside
3609    /// search-prompt mode.
3610    pub fn search_prompt(&self) -> Option<&crate::search::SearchPrompt> {
3611        self.search_prompt.as_ref()
3612    }
3613
3614    /// Most recent committed search pattern (persists across `n` / `N`
3615    /// and across prompt exits). `None` before the first search. Returns an
3616    /// owned clone (the value lives behind a shared `Mutex`, so a borrow
3617    /// can't outlive the guard — mirrors [`Editor::global_marks_iter`]).
3618    pub fn last_search(&self) -> Option<String> {
3619        self.search.lock().unwrap().last.clone()
3620    }
3621
3622    /// Whether the last committed search was a forward `/` (`true`) or
3623    /// a backward `?` (`false`). `n` and `N` consult this to honour the
3624    /// direction the user committed.
3625    pub fn last_search_forward(&self) -> bool {
3626        self.search.lock().unwrap().forward
3627    }
3628
3629    /// Set the most recent committed search text + direction. Used by
3630    /// host-driven prompts (e.g. apps/hjkl's `/` `?` prompt that lives
3631    /// outside the engine's vim FSM) so `n` / `N` repeat the host's
3632    /// most recent commit with the right direction. Pass `None` /
3633    /// `true` to clear.
3634    pub fn set_last_search(&mut self, text: Option<String>, forward: bool) {
3635        let mut bank = self.search.lock().unwrap();
3636        bank.last = text;
3637        bank.forward = forward;
3638    }
3639
3640    /// Point this editor at a shared search bank. All editors in the app
3641    /// share one bank (mirrors [`Editor::set_last_substitute_arc`]) so `/`
3642    /// / `?` committed in one window/split and `n` / `N` typed in another
3643    /// see the same pattern — vim's last search (the `"/` register) is
3644    /// session-global, not per-window.
3645    pub fn set_search_arc(&mut self, search: std::sync::Arc<std::sync::Mutex<SearchBank>>) {
3646        self.search = search;
3647    }
3648
3649    /// The most recent successful `:s` command. `None` before the first substitute.
3650    /// Used by `:&` / `:&&` to repeat it. Returns an owned clone (the value
3651    /// lives behind a shared `Mutex`, so a borrow can't outlive the guard —
3652    /// mirrors [`Editor::global_marks_iter`]).
3653    pub fn last_substitute(&self) -> Option<crate::substitute::SubstituteCmd> {
3654        self.last_substitute.lock().unwrap().clone()
3655    }
3656
3657    /// The previous `:s` replacement text, or `""` when no substitute has run
3658    /// yet. Feeds the magic `~` expansion on the PATTERN side of `:s` and
3659    /// `/`/`?` searches — pass it to
3660    /// [`crate::search::resolve_case_mode`]. (The replacement-side `~`/`&`
3661    /// features read the same [`Editor::last_substitute`] bank.)
3662    pub fn last_substitute_replacement(&self) -> String {
3663        self.last_substitute
3664            .lock()
3665            .unwrap()
3666            .as_ref()
3667            .map(|c| c.replacement.clone())
3668            .unwrap_or_default()
3669    }
3670
3671    /// Store the last successful substitute so `:&` / `:&&` can repeat it.
3672    pub fn set_last_substitute(&mut self, cmd: crate::substitute::SubstituteCmd) {
3673        *self.last_substitute.lock().unwrap() = Some(cmd);
3674    }
3675
3676    /// Point this editor at a shared last-substitute bank. All editors in
3677    /// the app share one bank (mirrors [`Editor::set_global_marks_arc`]) so
3678    /// `:&` run in one window repeats the `:s` most recently executed in any
3679    /// window — vim's last substitute is session-global, not per-window.
3680    pub fn set_last_substitute_arc(
3681        &mut self,
3682        last_substitute: std::sync::Arc<std::sync::Mutex<Option<crate::substitute::SubstituteCmd>>>,
3683    ) {
3684        self.last_substitute = last_substitute;
3685    }
3686
3687    /// Number of rows (lines) in the buffer.
3688    ///
3689    /// Convenience accessor for call sites that only need the row count without
3690    /// routing through the `Query` trait directly (e.g. the VSCode selection
3691    /// dispatcher computing buffer-end positions).
3692    pub fn row_count(&self) -> usize {
3693        buf_row_count(&self.buffer)
3694    }
3695
3696    /// Row `row` as an owned `String` (no trailing newline), or `None` when
3697    /// `row` is out of bounds.
3698    ///
3699    /// Mode-agnostic buffer read. Hosts and discipline crates (e.g. the vim
3700    /// accessors on `hjkl_vim::VimEditorExt`) use this instead of reaching for
3701    /// the engine's private `buf_line` helper.
3702    pub fn line(&self, row: usize) -> Option<String> {
3703        buf_line(&self.buffer, row)
3704    }
3705
3706    pub fn content(&self) -> String {
3707        let n = buf_row_count(&self.buffer);
3708        let mut s = String::new();
3709        for r in 0..n {
3710            if r > 0 {
3711                s.push('\n');
3712            }
3713            s.push_str(&crate::types::Query::line(&self.buffer, r as u32));
3714        }
3715        s.push('\n');
3716        s
3717    }
3718
3719    /// Same logical output as [`content`], but returns a cached
3720    /// `Arc<String>` so back-to-back reads within an un-mutated window
3721    /// are ref-count bumps instead of multi-MB joins. The cache is
3722    /// invalidated by every [`mark_content_dirty`] call.
3723    pub fn content_arc(&mut self) -> std::sync::Arc<String> {
3724        if let Some(arc) = self.buffer.cached_editor_content() {
3725            return arc;
3726        }
3727        let arc = std::sync::Arc::new(self.content());
3728        self.buffer
3729            .set_cached_editor_content(std::sync::Arc::clone(&arc));
3730        arc
3731    }
3732
3733    pub fn set_content(&mut self, text: &str) {
3734        crate::types::BufferEdit::replace_all(&mut self.buffer, text);
3735        self.buffer.clear_undo_redo();
3736        // Whole-buffer replace supersedes any queued ContentEdits.
3737        self.buffer.clear_pending_content_edits();
3738        self.buffer.set_pending_content_reset(true);
3739        self.mark_content_dirty();
3740    }
3741
3742    /// Whole-buffer replace that **preserves the undo history**.
3743    ///
3744    /// Equivalent to [`Editor::set_content`] but pushes the current buffer
3745    /// state onto the undo stack first, so a subsequent `u` walks back to
3746    /// the pre-replacement content. Use this for any operation the user
3747    /// expects to undo as a single step — e.g. external formatter output
3748    /// (`hjkl-mangler`) installed via the async [`crate::app::FormatWorker`].
3749    ///
3750    /// Like `push_undo`, this clears the redo stack (vim semantics: any
3751    /// new edit invalidates redo).
3752    pub fn set_content_undoable(&mut self, text: &str) {
3753        self.push_undo();
3754        crate::types::BufferEdit::replace_all(&mut self.buffer, text);
3755        // Whole-buffer replace supersedes any queued ContentEdits.
3756        self.buffer.clear_pending_content_edits();
3757        self.buffer.set_pending_content_reset(true);
3758        self.mark_content_dirty();
3759    }
3760
3761    /// Drain the pending change log produced by buffer mutations.
3762    ///
3763    /// Returns a `Vec<EditOp>` covering edits applied since the last
3764    /// call. Empty when no edits ran. Pull-model, complementary to
3765    /// [`Editor::take_content_change`] which gives back the new full
3766    /// content.
3767    ///
3768    /// Recording is opt-in: nothing in hjkl reads this log, so it defaults
3769    /// OFF and every `mutate_edit` would otherwise pay a payload clone plus
3770    /// a `Vec` build for an entry no host consumes. A host that wants the
3771    /// log calls `buffer_mut().set_change_log_enabled(true)` once.
3772    ///
3773    /// Mapping coverage:
3774    /// - InsertChar / InsertStr → exact `EditOp` with empty range +
3775    ///   replacement.
3776    /// - DeleteRange (`Char` kind) → exact range + empty replacement.
3777    /// - Replace → exact range + new replacement.
3778    /// - DeleteRange (`Line`/`Block`), JoinLines, SplitLines,
3779    ///   InsertBlock, DeleteBlockChunks → best-effort placeholder
3780    ///   covering the touched range. Hosts wanting per-cell deltas
3781    ///   should diff their own `lines()` snapshot.
3782    pub fn take_changes(&mut self) -> Vec<crate::types::Edit> {
3783        self.buffer.take_change_log()
3784    }
3785
3786    /// Read the engine's current settings as a SPEC
3787    /// [`crate::types::Options`].
3788    ///
3789    /// Bridges between the legacy [`Settings`] (which carries fewer
3790    /// fields than SPEC) and the planned 0.1.0 trait surface. Fields
3791    /// not present in `Settings` fall back to vim defaults (e.g.,
3792    /// `expandtab=false`, `wrapscan=true`, `timeout_len=1000ms`).
3793    /// Once trait extraction lands, this becomes the canonical config
3794    /// reader and `Settings` retires.
3795    pub fn current_options(&self) -> crate::types::Options {
3796        self.settings.to_options()
3797    }
3798
3799    /// Apply a SPEC [`crate::types::Options`] to the engine's settings.
3800    /// Only the fields backed by today's [`Settings`] take effect;
3801    /// remaining options become live once trait extraction wires them
3802    /// through.
3803    pub fn apply_options(&mut self, opts: &crate::types::Options) {
3804        self.settings.apply_options(opts);
3805    }
3806
3807    /// SPEC-typed highlights for `line`.
3808    ///
3809    /// Two emission modes:
3810    ///
3811    /// - **IncSearch**: the user is typing a `/` or `?` prompt and
3812    ///   `Editor::search_prompt` is `Some`. Live-preview matches of
3813    ///   the in-flight pattern surface as
3814    ///   [`crate::types::HighlightKind::IncSearch`].
3815    /// - **SearchMatch**: the prompt has been committed (or absent)
3816    ///   and the buffer's armed pattern is non-empty. Matches surface
3817    ///   as [`crate::types::HighlightKind::SearchMatch`].
3818    ///
3819    /// Selection / MatchParen / Syntax(id) variants land once the
3820    /// trait extraction routes the FSM's selection set + the host's
3821    /// syntax pipeline through the [`crate::types::Host`] trait.
3822    ///
3823    /// Returns an empty vec when there is nothing to highlight or
3824    /// `line` is out of bounds.
3825    pub fn highlights_for_line(&mut self, line: u32) -> Vec<crate::types::Highlight> {
3826        use crate::types::{Highlight, HighlightKind, Pos};
3827        let row = line as usize;
3828        if row >= buf_row_count(&self.buffer) {
3829            return Vec::new();
3830        }
3831
3832        // Live preview while the prompt is open beats the committed
3833        // pattern.
3834        if let Some(prompt) = self.search_prompt() {
3835            if prompt.text.is_empty() {
3836                return Vec::new();
3837            }
3838            use crate::search::{CaseMode, resolve_case_mode};
3839            let base =
3840                CaseMode::from_options(self.settings().ignore_case, self.settings().smartcase);
3841            let last_sub = self.last_substitute_replacement();
3842            let (stripped, mode) = resolve_case_mode(&prompt.text, base, &last_sub);
3843            let src = if mode == CaseMode::Insensitive {
3844                format!("(?i){stripped}")
3845            } else {
3846                stripped
3847            };
3848            let Ok(re) = regex::Regex::new(&src) else {
3849                return Vec::new();
3850            };
3851            let Some(haystack) = buf_line(&self.buffer, row) else {
3852                return Vec::new();
3853            };
3854            return re
3855                .find_iter(&haystack)
3856                .map(|m| Highlight {
3857                    range: Pos {
3858                        line,
3859                        col: m.start() as u32,
3860                    }..Pos {
3861                        line,
3862                        col: m.end() as u32,
3863                    },
3864                    kind: HighlightKind::IncSearch,
3865                })
3866                .collect();
3867        }
3868
3869        if self.search_state.pattern.is_none() {
3870            return Vec::new();
3871        }
3872        let dgen = crate::types::Query::dirty_gen(&self.buffer);
3873        crate::search::search_matches(&self.buffer, &mut self.search_state, dgen, row)
3874            .iter()
3875            .map(|&(start, end)| Highlight {
3876                range: Pos {
3877                    line,
3878                    col: start as u32,
3879                }..Pos {
3880                    line,
3881                    col: end as u32,
3882                },
3883                kind: HighlightKind::SearchMatch,
3884            })
3885            .collect()
3886    }
3887
3888    /// Populate the per-row hlsearch match cache for rows `top..bottom`
3889    /// (no-op when no pattern). Lets the renderer read cached byte ranges
3890    /// instead of re-scanning each visible line every frame.
3891    pub fn populate_search_cache(&mut self, top: usize, bottom: usize) {
3892        if self.search_state.pattern.is_none() {
3893            return;
3894        }
3895        let dgen = crate::types::Query::dirty_gen(&self.buffer);
3896        let end = bottom.min(crate::types::Query::line_count(&self.buffer) as usize);
3897        for row in top..end {
3898            crate::search::warm_matches(&self.buffer, &mut self.search_state, dgen, row);
3899        }
3900    }
3901
3902    /// Build the engine's [`crate::types::RenderFrame`] for the
3903    /// current state. Hosts call this once per redraw and diff
3904    /// across frames.
3905    ///
3906    /// Coarse today — covers mode + cursor + cursor shape + viewport
3907    /// top + line count. SPEC-target fields (selections, highlights,
3908    /// command line, search prompt, status line) land once trait
3909    /// extraction routes them through `SelectionSet` and the
3910    /// `Highlight` pipeline.
3911    pub fn render_frame(&self) -> crate::types::RenderFrame {
3912        use crate::types::{CursorShape, RenderFrame, SnapshotMode};
3913        let (cursor_row, cursor_col) = self.cursor();
3914        // Coarse, not vim: render output must not depend on which discipline
3915        // is installed (#265). CoarseMode is a bijection with SnapshotMode.
3916        let (mode, shape) = match self.coarse_mode() {
3917            crate::CoarseMode::Normal => (SnapshotMode::Normal, CursorShape::Block),
3918            crate::CoarseMode::Insert => (SnapshotMode::Insert, CursorShape::Bar),
3919            crate::CoarseMode::Select => (SnapshotMode::Visual, CursorShape::Block),
3920            crate::CoarseMode::SelectLine => (SnapshotMode::VisualLine, CursorShape::Block),
3921            crate::CoarseMode::SelectBlock => (SnapshotMode::VisualBlock, CursorShape::Block),
3922        };
3923        RenderFrame {
3924            mode,
3925            cursor_row: cursor_row as u32,
3926            cursor_col: cursor_col as u32,
3927            cursor_shape: shape,
3928            viewport_top: self.host.viewport().top_row as u32,
3929            line_count: crate::types::Query::line_count(&self.buffer),
3930        }
3931    }
3932
3933    /// Capture the editor's coarse state into a serde-friendly
3934    /// [`crate::types::EditorSnapshot`].
3935    ///
3936    /// Today's snapshot covers mode, cursor, lines, viewport top.
3937    /// Registers, marks, jump list, undo tree, and full options arrive
3938    /// once phase 5 trait extraction lands the generic
3939    /// `Editor<B: View, H: Host>` constructor — this method's surface
3940    /// stays stable; only the snapshot's internal fields grow.
3941    ///
3942    /// Distinct from the internal `snapshot` used by undo (which
3943    /// returns `(Vec<String>, (usize, usize))`); host-facing
3944    /// persistence goes through this one.
3945    pub fn take_snapshot(&self) -> crate::types::EditorSnapshot {
3946        use crate::types::{EditorSnapshot, SnapshotMode};
3947        let mode = match self.coarse_mode() {
3948            crate::CoarseMode::Normal => SnapshotMode::Normal,
3949            crate::CoarseMode::Insert => SnapshotMode::Insert,
3950            crate::CoarseMode::Select => SnapshotMode::Visual,
3951            crate::CoarseMode::SelectLine => SnapshotMode::VisualLine,
3952            crate::CoarseMode::SelectBlock => SnapshotMode::VisualBlock,
3953        };
3954        let cursor = self.cursor();
3955        let cursor = (cursor.0 as u32, cursor.1 as u32);
3956        let rope = crate::types::Query::rope(&self.buffer);
3957        let lines: Vec<String> = (0..rope.len_lines())
3958            .map(|r| {
3959                let s = rope.line(r).to_string();
3960                if s.ends_with('\n') {
3961                    s[..s.len() - 1].to_string()
3962                } else {
3963                    s
3964                }
3965            })
3966            .collect();
3967        let viewport_top = self.host.viewport().top_row as u32;
3968        let marks = self
3969            .buffer
3970            .marks_cloned()
3971            .into_iter()
3972            .map(|(c, (r, col))| (c, (r as u32, col as u32)))
3973            .collect();
3974        let global_marks = self
3975            .global_marks
3976            .lock()
3977            .unwrap()
3978            .iter()
3979            .map(|(c, &(bid, r, col))| (*c, (bid, r as u32, col as u32)))
3980            .collect();
3981        EditorSnapshot {
3982            version: EditorSnapshot::VERSION,
3983            mode,
3984            cursor,
3985            lines,
3986            viewport_top,
3987            registers: self.registers.lock().unwrap().clone(),
3988            marks,
3989            global_marks,
3990        }
3991    }
3992
3993    /// Restore editor state from an [`EditorSnapshot`]. Returns
3994    /// [`crate::EngineError::SnapshotVersion`] if the snapshot's
3995    /// `version` doesn't match [`EditorSnapshot::VERSION`].
3996    ///
3997    /// Mode is best-effort: `SnapshotMode` only round-trips the
3998    /// status-line summary, not the full FSM state. Visual / Insert
3999    /// mode entry happens through synthetic key dispatch when needed.
4000    pub fn restore_snapshot(
4001        &mut self,
4002        snap: crate::types::EditorSnapshot,
4003    ) -> Result<(), crate::EngineError> {
4004        use crate::types::EditorSnapshot;
4005        if snap.version != EditorSnapshot::VERSION {
4006            return Err(crate::EngineError::SnapshotVersion(
4007                snap.version,
4008                EditorSnapshot::VERSION,
4009            ));
4010        }
4011        let text = snap.lines.join("\n");
4012        self.set_content(&text);
4013        self.jump_cursor(snap.cursor.0 as usize, snap.cursor.1 as usize);
4014        self.host.viewport_mut().top_row = snap.viewport_top as usize;
4015        *self.registers.lock().unwrap() = snap.registers;
4016        self.buffer.set_marks(
4017            snap.marks
4018                .into_iter()
4019                .map(|(c, (r, col))| (c, (r as usize, col as usize)))
4020                .collect(),
4021        );
4022        *self.global_marks.lock().unwrap() = snap
4023            .global_marks
4024            .into_iter()
4025            .map(|(c, (bid, r, col))| (c, (bid, r as usize, col as usize)))
4026            .collect();
4027        Ok(())
4028    }
4029
4030    /// Install `text` as the pending yank buffer so the next `p`/`P` pastes
4031    /// it. Linewise is inferred from a trailing newline, matching how `yy`/`dd`
4032    /// shape their payload.
4033    pub fn seed_yank(&mut self, text: String) {
4034        let linewise = text.ends_with('\n');
4035        self.yank_linewise = linewise;
4036        self.registers.lock().unwrap().unnamed = crate::registers::Slot {
4037            text,
4038            linewise,
4039            ..Default::default()
4040        };
4041    }
4042
4043    /// Scroll the viewport down by `rows`. The cursor stays on its
4044    /// absolute line (vim convention) unless the scroll would take it
4045    /// off-screen — in that case it's clamped to the first row still
4046    /// visible.
4047    pub fn scroll_down(&mut self, rows: i16) {
4048        self.scroll_viewport(rows);
4049    }
4050
4051    /// Scroll the viewport up by `rows`. Cursor stays unless it would
4052    /// fall off the bottom of the new viewport, then clamp to the
4053    /// bottom-most visible row.
4054    pub fn scroll_up(&mut self, rows: i16) {
4055        self.scroll_viewport(-rows);
4056    }
4057
4058    /// Scroll the viewport right by `cols` columns. Only the horizontal
4059    /// offset (`top_col`) moves — the cursor is NOT adjusted (matches
4060    /// vim's `zl` behaviour for horizontal scroll without wrap).
4061    pub fn scroll_right(&mut self, cols: i16) {
4062        let vp = self.host.viewport_mut();
4063        let cols_i = cols as isize;
4064        let new_top = (vp.top_col as isize + cols_i).max(0) as usize;
4065        vp.top_col = new_top;
4066    }
4067
4068    /// Scroll the viewport left by `cols` columns. Delegates to
4069    /// `scroll_right` with a negated argument so the floor-at-zero
4070    /// clamp is shared.
4071    pub fn scroll_left(&mut self, cols: i16) {
4072        self.scroll_right(-cols);
4073    }
4074
4075    /// Scroll the viewport so the cursor stays at least `scrolloff`
4076    /// rows from each edge. Replaces the bare
4077    /// `View::ensure_cursor_visible` call at end-of-step so motions
4078    /// don't park the cursor on the very last visible row.
4079    pub fn ensure_cursor_in_scrolloff(&mut self) {
4080        let height = self.viewport_height.load(Ordering::Relaxed) as usize;
4081        if height == 0 {
4082            // 0.0.42 (Patch C-δ.7): viewport math lifted onto engine
4083            // free fns over `B: Query [+ Cursor]` + `&dyn FoldProvider`.
4084            // Disjoint-field borrow split: `self.buffer` (immutable via
4085            // `folds` snapshot + cursor) and `self.host` (mutable
4086            // viewport ref) live on distinct struct fields, so one
4087            // statement satisfies the borrow checker.
4088            let folds = crate::buffer_impl::BufferFoldProvider::new(&self.buffer);
4089            crate::viewport_math::ensure_cursor_visible(
4090                &self.buffer,
4091                &folds,
4092                self.host.viewport_mut(),
4093            );
4094            return;
4095        }
4096        // Cap margin at (height - 1) / 2 so the upper + lower bands
4097        // can't overlap on tiny windows (margin=5 + height=10 would
4098        // otherwise produce contradictory clamp ranges).
4099        let margin = self.settings.scrolloff.min(height.saturating_sub(1) / 2);
4100        // Screen rows ≠ doc rows only under soft-wrap (a doc row spans many
4101        // screen lines) or folds (a closed fold collapses many doc rows to
4102        // one); doc-row margin math drifts in those cases. Dispatch:
4103        //   • wrap            → the incremental screen-row walk.
4104        //   • folds, no wrap  → the O(height) fold-aware clamp below.
4105        //   • neither         → the fast O(1) doc-row math (every plain j/k/G).
4106        let wrapped = !matches!(self.host.viewport().wrap, hjkl_buffer::Wrap::None);
4107        if wrapped {
4108            self.ensure_scrolloff_vertical(height, margin);
4109            return;
4110        }
4111        if self.buffer.has_folds() {
4112            self.ensure_scrolloff_folds_nowrap(height, margin);
4113            // Column-side (horizontal) scroll only — keep the fold-aware
4114            // top_row by snapshotting it across `ensure_visible`.
4115            let cursor = buf_cursor_pos(&self.buffer);
4116            let saved_top = self.host.viewport().top_row;
4117            self.host.viewport_mut().ensure_visible(cursor);
4118            self.host.viewport_mut().top_row = saved_top;
4119            return;
4120        }
4121        let cursor_row = buf_cursor_row(&self.buffer);
4122        let last_row = buf_row_count(&self.buffer).saturating_sub(1);
4123        let v = self.host.viewport_mut();
4124        // Top edge: cursor_row should sit at >= top_row + margin.
4125        if cursor_row < v.top_row + margin {
4126            v.top_row = cursor_row.saturating_sub(margin);
4127        }
4128        // Bottom edge: cursor_row should sit at <= top_row + height - 1 - margin.
4129        let max_bottom = height.saturating_sub(1).saturating_sub(margin);
4130        if cursor_row > v.top_row + max_bottom {
4131            v.top_row = cursor_row.saturating_sub(max_bottom);
4132        }
4133        // Clamp top_row so we never scroll past the buffer's bottom.
4134        let max_top = last_row.saturating_sub(height.saturating_sub(1));
4135        if v.top_row > max_top {
4136            v.top_row = max_top;
4137        }
4138        // Column-side scroll (vim default `sidescrolloff = 0`).
4139        let cursor = buf_cursor_pos(&self.buffer);
4140        self.host.viewport_mut().ensure_visible(cursor);
4141    }
4142
4143    /// Fold-aware vertical scrolloff for `Wrap::None`, in **O(height)**.
4144    ///
4145    /// A closed fold collapses its body to one screen row, so the cursor's
4146    /// screen row is the count of *visible* rows above it — not the doc-row
4147    /// delta. Instead of re-walking that count on every candidate `top_row`
4148    /// (the pre-0.0.43 [`Self::ensure_scrolloff_vertical`], O(distance²) on
4149    /// a big jump like `G` over a fold-heavy file), compute the valid
4150    /// `top_row` window directly: at most `height-1-margin` visible rows may
4151    /// sit above the cursor (bottom edge) and at least `margin` (top edge).
4152    /// Walk those two bounds up from the cursor via `prev_visible_row`,
4153    /// clamp the current `top_row` into the window, then clamp to
4154    /// `max_top_for_height` so the buffer's bottom never leaves blank rows.
4155    /// Each walk is bounded by `height`, so the whole thing is O(height)
4156    /// regardless of jump distance.
4157    fn ensure_scrolloff_folds_nowrap(&mut self, height: usize, margin: usize) {
4158        let cursor_row = buf_cursor_row(&self.buffer);
4159        let max_csr = height.saturating_sub(1).saturating_sub(margin);
4160        // `top_lo`: the row `max_csr` visible rows above the cursor — `top_row`
4161        // must be >= this to keep the cursor within the bottom margin.
4162        let mut top_lo = cursor_row;
4163        for _ in 0..max_csr {
4164            match self.buffer.prev_visible_row(top_lo) {
4165                Some(p) => top_lo = p,
4166                None => break,
4167            }
4168        }
4169        // `top_hi`: the row `margin` visible rows above the cursor — `top_row`
4170        // must be <= this to keep the cursor below the top margin.
4171        let mut top_hi = cursor_row;
4172        for _ in 0..margin {
4173            match self.buffer.prev_visible_row(top_hi) {
4174                Some(p) => top_hi = p,
4175                None => break,
4176            }
4177        }
4178        // `max_csr >= margin` (margin is capped at (height-1)/2), so
4179        // `top_lo <= top_hi` and the clamp range is well-formed.
4180        let cur = self.host.viewport().top_row;
4181        let mut new_top = cur.clamp(top_lo, top_hi);
4182        let max_top = {
4183            let folds = crate::buffer_impl::BufferFoldProvider::new(&self.buffer);
4184            crate::viewport_math::max_top_for_height(
4185                &self.buffer,
4186                &folds,
4187                self.host.viewport(),
4188                height,
4189            )
4190        };
4191        if new_top > max_top {
4192            new_top = max_top;
4193        }
4194        self.host.viewport_mut().top_row = new_top;
4195    }
4196
4197    /// Screen-row-aware vertical scrolloff. Walks `top_row` one visible
4198    /// doc row at a time so the cursor's *screen* row stays inside
4199    /// `[margin, height - 1 - margin]`, then clamps `top_row` so the
4200    /// buffer's bottom never leaves blank rows below it.
4201    ///
4202    /// Correct under BOTH soft-wrap (a doc row spans many screen lines)
4203    /// and folds (a closed fold collapses many doc rows to one screen
4204    /// row): [`crate::viewport_math::cursor_screen_row_from`] counts
4205    /// visible/wrapped screen rows, so doc-row arithmetic can't drift the
4206    /// margin around a fold. Horizontal (column) scroll is the caller's
4207    /// job — this only moves `top_row`.
4208    fn ensure_scrolloff_vertical(&mut self, height: usize, margin: usize) {
4209        use crate::types::FoldProvider;
4210        let cursor_row = buf_cursor_row(&self.buffer);
4211        // Step 1 — cursor above viewport: snap top to cursor row,
4212        // then we'll fix up the margin below.
4213        if cursor_row < self.host.viewport().top_row {
4214            let v = self.host.viewport_mut();
4215            v.top_row = cursor_row;
4216            v.top_col = 0;
4217        }
4218        // Step 2 — push top forward until cursor's screen row is
4219        // within the bottom margin (`csr <= height - 1 - margin`).
4220        // 0.0.33 (Patch C-γ): fold-iteration goes through the
4221        // [`crate::types::FoldProvider`] surface via
4222        // [`crate::buffer_impl::BufferFoldProvider`]. 0.0.34 (Patch
4223        // C-δ.1): `cursor_screen_row` / `max_top_for_height` now take
4224        // a `&Viewport` parameter; the host owns the viewport, so the
4225        // disjoint `(self.host, self.buffer)` borrows split cleanly.
4226        let max_csr = height.saturating_sub(1).saturating_sub(margin);
4227        // The cursor's screen row from the current top, computed ONCE (one
4228        // linear pass) and then adjusted per dropped/added visible row —
4229        // the incremental walk [`crate::viewport_math::ensure_cursor_visible`]
4230        // uses. Re-running `cursor_screen_row_from` (itself O(distance))
4231        // per candidate `top_row` made a big soft-wrapped jump O(distance²);
4232        // subtracting/adding one row's wrap height per step keeps it
4233        // O(distance). `None` mirrors the old `unwrap_or(0)`: a cursor above
4234        // `top_row` (a stale per-window cursor past EOF, or a hidden cursor
4235        // row) reads as screen row 0, so step 2 no-ops and step 3 pulls
4236        // `top_row` back until the cursor enters the window.
4237        let row_count = buf_row_count(&self.buffer);
4238        let folds = crate::buffer_impl::BufferFoldProvider::new(&self.buffer);
4239        let rope = crate::types::Query::rope(&self.buffer);
4240        let v = *self.host.viewport();
4241        let mut screen = crate::viewport_math::cursor_screen_row_from(
4242            &self.buffer,
4243            &folds,
4244            self.host.viewport(),
4245            self.host.viewport().top_row,
4246        );
4247        // Step 2 — push top forward until cursor's screen row is
4248        // within the bottom margin (`csr <= height - 1 - margin`).
4249        if let Some(mut s) = screen {
4250            while s > max_csr {
4251                let top = self.host.viewport().top_row;
4252                let next =
4253                    <crate::buffer_impl::BufferFoldProvider<'_> as crate::types::FoldProvider>::next_visible_row(&folds, top, row_count);
4254                let Some(next) = next else {
4255                    break;
4256                };
4257                // Don't walk past the cursor's row. Only reachable when
4258                // `top` already equals the cursor's row (a visible cursor
4259                // row at-or-after `top` bounds `next_visible_row`), so the
4260                // screen value stays valid for step 3.
4261                if next > cursor_row {
4262                    self.host.viewport_mut().top_row = cursor_row;
4263                    break;
4264                }
4265                // Removing rows [top, next) from the top of the range drops
4266                // their visible heights (hidden rows contribute 0); after
4267                // this `s` equals `cursor_screen_row_from(..., next)`.
4268                for r in top..next {
4269                    if !folds.is_row_hidden(r) {
4270                        let line = crate::viewport_math::rope_line_slice(&rope, r);
4271                        s -= hjkl_buffer::wrap::wrap_segments(&line, v.text_width, v.wrap).len();
4272                    }
4273                }
4274                self.host.viewport_mut().top_row = next;
4275            }
4276            screen = Some(s);
4277        }
4278        // Step 3 — pull top backward until cursor's screen row is
4279        // past the top margin (`csr >= margin`). The same incremental walk,
4280        // run in reverse: `prev_visible_row` lands on the nearest visible
4281        // row above `top` (the rows between are hidden and contribute 0), so
4282        // pulling `top_row` back to `prev` adds exactly `prev`'s wrap height
4283        // back to the cursor's screen row.
4284        let clamped_cursor_row = cursor_row.min(row_count.saturating_sub(1));
4285        loop {
4286            match screen {
4287                Some(s) if s >= margin => break,
4288                // `None` reads as screen row 0: a zero margin satisfies
4289                // `csr >= margin` immediately, as in the old loop.
4290                None if margin == 0 => break,
4291                _ => {}
4292            }
4293            let top = self.host.viewport().top_row;
4294            // A `None` screen means the (clamped) cursor still sits above
4295            // the window; once `top` walks down to it, recompute the screen
4296            // row once and continue incrementally from there. A visible
4297            // clamped cursor row guarantees the recompute succeeds.
4298            if screen.is_none()
4299                && top <= clamped_cursor_row
4300                && !folds.is_row_hidden(clamped_cursor_row)
4301            {
4302                screen = crate::viewport_math::cursor_screen_row_from(
4303                    &self.buffer,
4304                    &folds,
4305                    self.host.viewport(),
4306                    top,
4307                );
4308                continue;
4309            }
4310            let prev =
4311                <crate::buffer_impl::BufferFoldProvider<'_> as crate::types::FoldProvider>::prev_visible_row(&folds, top);
4312            let Some(prev) = prev else {
4313                break;
4314            };
4315            if let Some(s) = screen {
4316                let line = crate::viewport_math::rope_line_slice(&rope, prev);
4317                screen =
4318                    Some(s + hjkl_buffer::wrap::wrap_segments(&line, v.text_width, v.wrap).len());
4319            }
4320            self.host.viewport_mut().top_row = prev;
4321        }
4322        // Step 4 — clamp top so the buffer's bottom doesn't leave
4323        // blank rows below it. `max_top_for_height` walks segments
4324        // backward from the last row until it accumulates `height`
4325        // screen rows.
4326        let max_top = {
4327            let folds = crate::buffer_impl::BufferFoldProvider::new(&self.buffer);
4328            crate::viewport_math::max_top_for_height(
4329                &self.buffer,
4330                &folds,
4331                self.host.viewport(),
4332                height,
4333            )
4334        };
4335        if self.host.viewport().top_row > max_top {
4336            self.host.viewport_mut().top_row = max_top;
4337        }
4338        self.host.viewport_mut().top_col = 0;
4339    }
4340
4341    fn scroll_viewport(&mut self, delta: i16) {
4342        if delta == 0 {
4343            return;
4344        }
4345        // Bump the host viewport's top within bounds.
4346        let total_rows = buf_row_count(&self.buffer) as isize;
4347        let height = self.viewport_height.load(Ordering::Relaxed) as usize;
4348        let cur_top = self.host.viewport().top_row as isize;
4349        let new_top = (cur_top + delta as isize)
4350            .max(0)
4351            .min((total_rows - 1).max(0)) as usize;
4352        self.host.viewport_mut().top_row = new_top;
4353        if height == 0 {
4354            return;
4355        }
4356        // Apply scrolloff: keep the cursor at least scrolloff rows
4357        // from the visible viewport edges.
4358        let (cursor_row, cursor_col) = buf_cursor_rc(&self.buffer);
4359        let margin = self.settings.scrolloff.min(height / 2);
4360        let min_row = new_top + margin;
4361        let max_row = new_top + height.saturating_sub(1).saturating_sub(margin);
4362        let target_row = cursor_row.clamp(min_row, max_row.max(min_row));
4363        if target_row != cursor_row {
4364            let line_len = buf_line(&self.buffer, target_row).map_or(0, |l| l.chars().count());
4365            let target_col = cursor_col.min(line_len.saturating_sub(1));
4366            buf_set_cursor_rc(&mut self.buffer, target_row, target_col);
4367        }
4368    }
4369
4370    pub fn goto_line(&mut self, line: usize) {
4371        let row = line.saturating_sub(1);
4372        let max = buf_row_count(&self.buffer).saturating_sub(1);
4373        let target = row.min(max);
4374        // If the target row is hidden inside one or more closed folds, open
4375        // every fold that collapses it so the landing line is actually
4376        // visible — a jump to an unseen row is useless. `reveal_row` opens
4377        // all hiding folds (outer + nested) in one pass; `open_fold_at` /
4378        // `FoldOp::OpenAt` can't, because they only act on the first fold
4379        // containing the row and so can never reach a nested inner fold.
4380        self.buffer.reveal_row(target);
4381        buf_set_cursor_rc(&mut self.buffer, target, 0);
4382        // Vim: `:N` / `+N` jump scrolls the viewport too — without this
4383        // the cursor lands off-screen and the user has to scroll
4384        // manually to see it.
4385        self.ensure_cursor_in_scrolloff();
4386    }
4387
4388    /// Scroll so the cursor row lands at the given viewport position:
4389    /// `Center` → middle row, `Top` → first row, `Bottom` → last row.
4390    /// Cursor stays on its absolute line; only the viewport moves.
4391    pub fn scroll_cursor_to(&mut self, pos: CursorScrollTarget) {
4392        let height = self.viewport_height.load(Ordering::Relaxed) as usize;
4393        if height == 0 {
4394            return;
4395        }
4396        let cur_row = buf_cursor_row(&self.buffer);
4397        let cur_top = self.host.viewport().top_row;
4398        // Scrolloff awareness: `zt` lands the cursor at the top edge
4399        // of the viable area (top + margin), `zb` at the bottom edge
4400        // (top + height - 1 - margin). Match the cap used by
4401        // `ensure_cursor_in_scrolloff` so contradictory bounds are
4402        // impossible on tiny viewports.
4403        let margin = self.settings.scrolloff.min(height.saturating_sub(1) / 2);
4404        let new_top = match pos {
4405            CursorScrollTarget::Center => cur_row.saturating_sub(height / 2),
4406            CursorScrollTarget::Top => cur_row.saturating_sub(margin),
4407            CursorScrollTarget::Bottom => {
4408                cur_row.saturating_sub(height.saturating_sub(1).saturating_sub(margin))
4409            }
4410        };
4411        if new_top == cur_top {
4412            return;
4413        }
4414        self.host.viewport_mut().top_row = new_top;
4415    }
4416
4417    /// Jump the cursor to the given 1-based line/column, clamped to the document.
4418    pub fn jump_to(&mut self, line: usize, col: usize) {
4419        let r = line.saturating_sub(1);
4420        let max_row = buf_row_count(&self.buffer).saturating_sub(1);
4421        let r = r.min(max_row);
4422        let line_len = buf_line(&self.buffer, r).map_or(0, |l| l.chars().count());
4423        let c = col.saturating_sub(1).min(line_len);
4424        buf_set_cursor_rc(&mut self.buffer, r, c);
4425    }
4426
4427    // ── Host-agnostic doc-coord mouse primitives (Phase 1 of issue #114) ─────
4428    //
4429    // These primitives operate on document (row, col) coordinates that the HOST
4430    // computes from its own layout knowledge (cell geometry for the TUI host,
4431    // pixel geometry for the future GUI host). The engine has no u16 terminal
4432    // assumption here — it just moves the cursor in doc-space.
4433
4434    /// Set the cursor to the given doc-space `(row, col)`, clamped to the
4435    /// document bounds. Hosts use this for programmatic cursor placement and
4436    /// as the building block for the mouse-click path.
4437    ///
4438    /// `col` may equal `line.chars().count()` (Insert-mode "one past end"
4439    /// position); values beyond that are clamped to `char_count`.
4440    pub fn set_cursor_doc(&mut self, row: usize, col: usize) {
4441        let max_row = buf_row_count(&self.buffer).saturating_sub(1);
4442        let r = row.min(max_row);
4443        let line_len = buf_line(&self.buffer, r).map_or(0, |l| l.chars().count());
4444        let c = col.min(line_len);
4445        buf_set_cursor_rc(&mut self.buffer, r, c);
4446    }
4447
4448    /// Extend an in-progress mouse drag to doc-space `(row, col)`.
4449    ///
4450    /// Moves the live cursor; the Visual anchor stays where
4451    /// [`Editor::mouse_begin_drag`] set it. Call after the host has
4452    /// translated the drag position to doc coordinates.
4453    pub fn mouse_extend_drag_doc(&mut self, row: usize, col: usize) {
4454        self.set_cursor_doc(row, col);
4455    }
4456
4457    pub fn insert_str(&mut self, text: &str) {
4458        let pos = crate::types::Cursor::cursor(&self.buffer);
4459        crate::types::BufferEdit::insert_at(&mut self.buffer, pos, text);
4460        self.mark_content_dirty();
4461    }
4462
4463    pub fn accept_completion(&mut self, completion: &str) {
4464        use crate::types::{BufferEdit, Cursor as CursorTrait, Pos};
4465        let cursor_pos = CursorTrait::cursor(&self.buffer);
4466        let cursor_row = cursor_pos.line as usize;
4467        let cursor_col = cursor_pos.col as usize;
4468        let line = buf_line(&self.buffer, cursor_row).unwrap_or_default();
4469        let chars: Vec<char> = line.chars().collect();
4470        let prefix_len = chars[..cursor_col.min(chars.len())]
4471            .iter()
4472            .rev()
4473            .take_while(|c| c.is_alphanumeric() || **c == '_')
4474            .count();
4475        if prefix_len > 0 {
4476            let start = Pos {
4477                line: cursor_row as u32,
4478                col: (cursor_col - prefix_len) as u32,
4479            };
4480            BufferEdit::delete_range(&mut self.buffer, start..cursor_pos);
4481        }
4482        let cursor = CursorTrait::cursor(&self.buffer);
4483        BufferEdit::insert_at(&mut self.buffer, cursor, completion);
4484        self.mark_content_dirty();
4485    }
4486
4487    /// Capture the buffer state for undo / redo.  Uses
4488    /// [`Query::content_joined`], which the `View` impl caches as an
4489    /// `Arc<String>` against `dirty_gen` — so when LSP / git / syntax
4490    /// already joined this generation, the snapshot is an `Arc::clone`
4491    /// (one ptr bump). Previously this cloned every line into a
4492    /// `Vec<String>` (162 k allocations on a 162 k-row buffer) and the
4493    /// matching `restore` re-joined them — samply showed it at ~9 % of
4494    /// CPU on a big-paste session.
4495    pub(super) fn snapshot(&self) -> (ropey::Rope, (usize, usize)) {
4496        use crate::types::Query;
4497        let rc = buf_cursor_rc(&self.buffer);
4498        (Query::rope(&self.buffer), rc)
4499    }
4500
4501    /// Snapshot the buffer-scoped "edit coherence" state alongside a rope
4502    /// snapshot, so undo/redo can restore marks/jumplist/changelist, not
4503    /// just text (audit-r2 fix 2).
4504    ///
4505    /// Called at all three `UndoEntry` construction sites
4506    /// (`push_undo_at`, `undo_core`, `redo_core`) with the LIVE state at
4507    /// push time — never the popped entry's own snapshot, since the entry
4508    /// being pushed describes "the other side" of the history walk (e.g.
4509    /// `undo_core`'s redo-push needs the CURRENT, post-edit marks so a
4510    /// later redo restores them, not the pre-edit marks it's about to
4511    /// pop).
4512    pub(super) fn snapshot_marks(&self) -> hjkl_buffer::MarkSnapshot {
4513        let cur_bid = self.current_buffer_id;
4514        let global_marks = self
4515            .global_marks
4516            .lock()
4517            .unwrap()
4518            .iter()
4519            .filter(|(_, (bid, _, _))| *bid == cur_bid)
4520            .map(|(c, (_, row, col))| (*c, (*row, *col)))
4521            .collect();
4522        let bank = self.change_bank.lock().unwrap();
4523        hjkl_buffer::MarkSnapshot {
4524            local_marks: self.buffer.marks_cloned(),
4525            jump_back: self.jump_back.clone(),
4526            jump_fwd: self.jump_fwd.clone(),
4527            change_last_edit: bank.last_edit,
4528            change_list: bank.list.clone(),
4529            change_cursor: bank.cursor,
4530            global_marks,
4531        }
4532    }
4533
4534    /// Restore the buffer-scoped state captured by [`Editor::snapshot_marks`]
4535    /// — the undo/redo counterpart to `restore_rope`/`restore_text`.
4536    ///
4537    /// Only entries belonging to THIS buffer (`current_buffer_id`) are
4538    /// touched in the session-global `global_marks` map: other buffers'
4539    /// global marks are left completely alone. Local marks and the
4540    /// changelist bank are already per-buffer (shared via `Arc` across
4541    /// windows on the same buffer, same as the text), so restoring them
4542    /// here is visible to every window on this buffer, matching vim.
4543    pub(super) fn restore_marks(&mut self, snap: &hjkl_buffer::MarkSnapshot) {
4544        self.buffer.set_marks(snap.local_marks.clone());
4545        self.jump_back.clone_from(&snap.jump_back);
4546        self.jump_fwd.clone_from(&snap.jump_fwd);
4547        {
4548            let mut bank = self.change_bank.lock().unwrap();
4549            bank.last_edit = snap.change_last_edit;
4550            bank.list.clone_from(&snap.change_list);
4551            bank.cursor = snap.change_cursor;
4552        }
4553        let cur_bid = self.current_buffer_id;
4554        let mut global_marks = self.global_marks.lock().unwrap();
4555        global_marks.retain(|_, (bid, _, _)| *bid != cur_bid);
4556        for (c, (row, col)) in snap.global_marks.iter() {
4557            global_marks.insert(*c, (cur_bid, *row, *col));
4558        }
4559    }
4560
4561    // ── Undo / redo (discipline-agnostic, #265) ──────────────────────────────
4562    //
4563    // The rope-level work is generic — every discipline undoes. The only
4564    // discipline-specific part is what state the editor is left in afterwards,
4565    // which goes through `DisciplineState::reset_to_idle` plus a coarse cursor
4566    // clamp, so the engine never names vim.
4567
4568    /// Rope-level undo, then return the discipline to idle.
4569    ///
4570    /// Drives the undo arena tree: [`View::undo_step`](hjkl_buffer::View) writes
4571    /// the live state into the node we leave (that node becomes the redo target)
4572    /// and returns the parent snapshot to restore. Behaviourally identical to
4573    /// the old pop-undo / push-redo dance — the moved-across node inherits the
4574    /// destination's timestamp, exactly as the old redo entry did.
4575    fn undo_core(&mut self) {
4576        if !self.buffer.undo_stack_is_empty() {
4577            let (cur_rope, cur_cursor) = self.snapshot();
4578            let cur_marks = self.snapshot_marks();
4579            if let Some(entry) = self.buffer.undo_step(cur_rope, cur_cursor, cur_marks) {
4580                self.restore_rope(&entry.rope, entry.cursor);
4581                self.restore_marks(&entry.marks);
4582            }
4583        }
4584        self.settle_after_history_jump();
4585    }
4586
4587    /// Rope-level redo, then return the discipline to idle.
4588    fn redo_core(&mut self) {
4589        if !self.buffer.redo_stack_is_empty() {
4590            let (cur_rope, cur_cursor) = self.snapshot();
4591            let cur_marks = self.snapshot_marks();
4592            let before = cur_rope.clone();
4593            if let Some(entry) = self.buffer.redo_step(cur_rope, cur_cursor, cur_marks) {
4594                self.cap_undo();
4595                self.restore_rope(&entry.rope, entry.cursor);
4596                self.restore_marks(&entry.marks);
4597                // Park the cursor at the START of the reapplied change rather
4598                // than the end-of-insert position stored in the redo snapshot
4599                // (vim parity). Recompute from the first differing character.
4600                let after = crate::types::Query::rope(&self.buffer);
4601                if let Some((row, col)) = first_diff_pos(&before, &after) {
4602                    buf_set_cursor_rc(&mut self.buffer, row, col);
4603                }
4604            }
4605        }
4606        self.settle_after_history_jump();
4607    }
4608
4609    /// Leave the editor in a known resting state after jumping through history
4610    /// (undo / redo) or after a `:!` filter rewrote the buffer.
4611    ///
4612    /// Asks the installed discipline to put its *mode* back to idle — without
4613    /// discarding an open insert session, which vscode-mode undo depends on —
4614    /// then clamps the cursor to a valid column.
4615    pub(crate) fn settle_after_history_jump(&mut self) {
4616        self.discipline.reset_mode_after_history();
4617        // Undo / redo restore a whole snapshot: the secondary selections were
4618        // computed against a document that no longer exists, and nothing tracked
4619        // them across the rewind. Drop them rather than leave carets pointing at
4620        // text that moved — the same "drop, never guess" rule `selection_shift`
4621        // applies to a single untrackable edit.
4622        self.extra_selections.clear();
4623        // Unconditional clamp: the restored cursor came from a snapshot that may
4624        // have been taken mid-insert and can sit one past the last valid column.
4625        let (row, col) = self.cursor();
4626        let max_col = buf_line_chars(&self.buffer, row).saturating_sub(1);
4627        if col > max_col {
4628            buf_set_cursor_rc(&mut self.buffer, row, max_col);
4629        }
4630        // audit-r2 fix 3(a): vim's 'foldopen' option includes "undo" — an
4631        // undo/redo that lands the cursor inside a closed fold's body must
4632        // reveal it, not strand the cursor on a hidden row with no way to
4633        // see what it's sitting on. `reveal_row` already opens every fold
4634        // (at any nesting depth) that hides a row in one pass; loop it
4635        // defensively — bounded by the fold count — so a row that's
4636        // somehow still hidden after one reveal (e.g. a future change to
4637        // `reveal_row`'s semantics) keeps getting opened rather than
4638        // silently left stranded.
4639        let row = buf_cursor_row(&self.buffer);
4640        let max_iters = self.buffer.with_folds(<[hjkl_buffer::Fold]>::len) + 1;
4641        for _ in 0..max_iters {
4642            if !self.buffer.is_row_hidden(row) {
4643                break;
4644            }
4645            if !self.buffer.reveal_row(row) {
4646                break;
4647            }
4648        }
4649    }
4650
4651    /// Walk one step back through the undo history. Equivalent to the
4652    /// user pressing `u` in normal mode. Drains the most recent undo
4653    /// entry and pushes it onto the redo stack.
4654    pub fn undo(&mut self) {
4655        self.undo_core();
4656    }
4657
4658    /// Walk one step forward through the redo history. Equivalent to
4659    /// `<C-r>` in normal mode.
4660    pub fn redo(&mut self) {
4661        self.redo_core();
4662    }
4663
4664    /// `[count]u` — undo `n` times, BRANCH-LOCAL (each step walks to the parent
4665    /// on the current branch, not the seq order). This is what `u` binds to;
4666    /// `g-`/`:earlier` use the tree-wide [`earlier_by_steps`](Self::earlier_by_steps)
4667    /// seq walk instead. Stops at the branch root.
4668    pub fn undo_by_steps(&mut self, n: usize) -> usize {
4669        let mut count = 0;
4670        for _ in 0..n {
4671            if self.buffer.undo_stack_is_empty() {
4672                break;
4673            }
4674            self.undo_core();
4675            count += 1;
4676        }
4677        count
4678    }
4679
4680    /// `[count]<C-r>` — redo `n` times, BRANCH-LOCAL (each step follows
4681    /// `last_child`). Counterpart to [`undo_by_steps`](Self::undo_by_steps).
4682    pub fn redo_by_steps(&mut self, n: usize) -> usize {
4683        let mut count = 0;
4684        for _ in 0..n {
4685            if self.buffer.redo_stack_is_empty() {
4686                break;
4687            }
4688            self.redo_core();
4689            count += 1;
4690        }
4691        count
4692    }
4693
4694    /// `U` (`:h U`): restore the line where the latest change was made to
4695    /// its state before that run of changes began — NOT necessarily the
4696    /// line the cursor is currently on (moving the cursor away without
4697    /// editing doesn't retarget `U`). A no-op when nothing has changed
4698    /// on the tracked line relative to the stored snapshot (either
4699    /// nothing has been edited yet, or a prior `U` already restored it).
4700    ///
4701    /// `U` is itself a change: it pushes one undo entry (so a plain `u`
4702    /// right after `U` undoes the restore), and it swaps the stored
4703    /// snapshot to the text it just replaced, so a second `U` toggles
4704    /// back and re-applies the changes the first one undid.
4705    pub fn undo_line(&mut self) {
4706        let target = self.change_bank.lock().unwrap().u_line.clone();
4707        let Some((row, snapshot)) = target else {
4708            return;
4709        };
4710        if row >= buf_row_count(&self.buffer) {
4711            return;
4712        }
4713        let current = buf_line(&self.buffer, row).unwrap_or_default();
4714        if current == snapshot {
4715            return;
4716        }
4717        self.push_undo();
4718        let line_chars = buf_line_chars(&self.buffer, row);
4719        self.suppress_u_line_track = true;
4720        self.mutate_edit(hjkl_buffer::Edit::DeleteRange {
4721            start: hjkl_buffer::Position::new(row, 0),
4722            end: hjkl_buffer::Position::new(row, line_chars),
4723            kind: hjkl_buffer::MotionKind::Char,
4724        });
4725        self.mutate_edit(hjkl_buffer::Edit::InsertStr {
4726            at: hjkl_buffer::Position::new(row, 0),
4727            text: snapshot,
4728        });
4729        self.suppress_u_line_track = false;
4730        self.change_bank.lock().unwrap().u_line = Some((row, current));
4731        buf_set_cursor_rc(&mut self.buffer, row, 0);
4732    }
4733
4734    /// One `g-` step: restore the next-lower-`seq` state anywhere in the undo
4735    /// tree. Branch-crossing counterpart of
4736    /// [`undo_core`](Self::undo_core); restores the destination snapshot exactly
4737    /// like an undo. Returns `false` when already at the lowest state.
4738    fn seq_earlier_core(&mut self) -> bool {
4739        let (cur_rope, cur_cursor) = self.snapshot();
4740        let cur_marks = self.snapshot_marks();
4741        if let Some(entry) = self
4742            .buffer
4743            .seq_earlier_step(cur_rope, cur_cursor, cur_marks)
4744        {
4745            self.restore_rope(&entry.rope, entry.cursor);
4746            self.restore_marks(&entry.marks);
4747            self.settle_after_history_jump();
4748            true
4749        } else {
4750            false
4751        }
4752    }
4753
4754    /// One `g+` step: restore the next-higher-`seq` state anywhere in the undo
4755    /// tree. Branch-crossing counterpart of [`redo_core`](Self::redo_core),
4756    /// including its vim-parity cursor-park at the start of the reapplied
4757    /// change. Returns `false` when already at the highest state.
4758    fn seq_later_core(&mut self) -> bool {
4759        let (cur_rope, cur_cursor) = self.snapshot();
4760        let cur_marks = self.snapshot_marks();
4761        let before = cur_rope.clone();
4762        if let Some(entry) = self.buffer.seq_later_step(cur_rope, cur_cursor, cur_marks) {
4763            self.cap_undo();
4764            self.restore_rope(&entry.rope, entry.cursor);
4765            self.restore_marks(&entry.marks);
4766            let after = crate::types::Query::rope(&self.buffer);
4767            if let Some((row, col)) = first_diff_pos(&before, &after) {
4768                buf_set_cursor_rc(&mut self.buffer, row, col);
4769            }
4770            self.settle_after_history_jump();
4771            true
4772        } else {
4773            false
4774        }
4775    }
4776
4777    /// `g-` / `:earlier N` — travel `n` states back through the undo TREE by
4778    /// `seq` (crossing branches), not the branch-local `u` path. Returns the
4779    /// number of steps actually applied (clamped at the oldest state).
4780    pub fn earlier_by_steps(&mut self, n: usize) -> usize {
4781        let mut count = 0;
4782        for _ in 0..n {
4783            if self.seq_earlier_core() {
4784                count += 1;
4785            } else {
4786                break;
4787            }
4788        }
4789        count
4790    }
4791
4792    /// `g+` / `:later N` — travel `n` states forward through the undo TREE by
4793    /// `seq`. Returns the number of steps actually applied (clamped at the
4794    /// newest state).
4795    pub fn later_by_steps(&mut self, n: usize) -> usize {
4796        let mut count = 0;
4797        for _ in 0..n {
4798            if self.seq_later_core() {
4799                count += 1;
4800            } else {
4801                break;
4802            }
4803        }
4804        count
4805    }
4806
4807    /// Travel back through the tree (by `seq`) while the next-older state's
4808    /// timestamp is strictly greater than `target`; stop once it is at/below.
4809    /// Returns the number of steps applied.
4810    ///
4811    /// Vim `:earlier Ns` semantics: `target = SystemTime::now() - N seconds`.
4812    /// The walk is tree-wide (same seq order as `g-`), so it crosses branches.
4813    pub fn earlier_by_time(&mut self, target: SystemTime) -> usize {
4814        let mut count = 0;
4815        loop {
4816            match self.buffer.seq_earlier_timestamp() {
4817                None => break,
4818                Some(ts) => {
4819                    if ts <= target {
4820                        break;
4821                    }
4822                }
4823            }
4824            if self.seq_earlier_core() {
4825                count += 1;
4826            } else {
4827                break;
4828            }
4829        }
4830        count
4831    }
4832
4833    /// Travel forward through the tree (by `seq`) while the next-newer state's
4834    /// timestamp is at/below `target`. Returns the number of steps applied.
4835    ///
4836    /// Vim `:later Ns` semantics: `target = current_state_time + N seconds`.
4837    pub fn later_by_time(&mut self, target: SystemTime) -> usize {
4838        let mut count = 0;
4839        loop {
4840            match self.buffer.seq_later_timestamp() {
4841                None => break,
4842                Some(ts) => {
4843                    if ts > target {
4844                        break;
4845                    }
4846                }
4847            }
4848            if self.seq_later_core() {
4849                count += 1;
4850            } else {
4851                break;
4852            }
4853        }
4854        count
4855    }
4856
4857    /// Undo-tree leaves for `:undolist`: `(seq, changes/depth, timestamp,
4858    /// is_current)` sorted by `seq`. Like nvim, `:undolist` shows only branch
4859    /// leaves, not every intermediate node.
4860    pub fn undo_leaves(&self) -> Vec<(u64, usize, SystemTime, bool)> {
4861        self.buffer.undo_leaves()
4862    }
4863
4864    /// Snapshot current buffer state onto the undo stack and clear
4865    /// the redo stack. Bounded by `settings.undo_levels` — older
4866    /// entries pruned. Call before any group of buffer mutations the
4867    /// user might want to undo as a single step.
4868    pub fn push_undo(&mut self) {
4869        self.push_undo_at(SystemTime::now());
4870    }
4871
4872    /// Open an undo group. Every [`push_undo`](Self::push_undo) until the
4873    /// returned guard drops collapses into a single undo step. Re-entrant
4874    /// (depth-counted): nested `undo_group()` calls just nest, and only the
4875    /// OUTERMOST close commits — so a `:g` whose sub-command is itself grouped
4876    /// still yields one undo step. A group that mutates nothing leaves zero
4877    /// undo entries. Closing on `Drop` makes it early-return / panic safe.
4878    ///
4879    /// The returned guard is `#[must_use]`;
4880    /// bind it (`let _g = …`) so it lives for the whole grouped operation.
4881    pub fn undo_group(&mut self) -> UndoGroup {
4882        let content = self.buffer.content_arc();
4883        content.lock().unwrap().undo_group_enter();
4884        UndoGroup { content }
4885    }
4886
4887    /// Like [`push_undo`] but uses a caller-supplied timestamp. Used by
4888    /// tests that need deterministic time values without `sleep`.
4889    #[doc(hidden)]
4890    pub fn push_undo_at(&mut self, timestamp: SystemTime) {
4891        // Inside an open undo group, coalesce: only the FIRST mutating
4892        // push_undo in the outermost group takes a snapshot; every later one
4893        // is suppressed (no create-then-pop). At depth 0 (`undo_group_active`
4894        // is false) the `&&` short-circuits before `undo_group_arm`, so no
4895        // group state is touched and the path below is byte-identical to the
4896        // pre-group behavior.
4897        if self.buffer.undo_group_active() && !self.buffer.undo_group_arm() {
4898            return;
4899        }
4900        let (rope, cursor) = self.snapshot();
4901        let marks = self.snapshot_marks();
4902        self.buffer.push_undo_entry(hjkl_buffer::UndoEntry {
4903            rope,
4904            cursor,
4905            timestamp,
4906            marks,
4907        });
4908        self.cap_undo();
4909        self.buffer.clear_redo();
4910    }
4911
4912    /// Trim the undo stack down to `settings.undo_levels`, dropping
4913    /// the oldest entries. `undo_levels == 0` is treated as
4914    /// "unlimited" (vim's 0-means-no-undo semantics intentionally
4915    /// skipped — guarding with `> 0` is one line shorter than gating
4916    /// the cap path with an explicit zero-check above the call site).
4917    pub(crate) fn cap_undo(&mut self) {
4918        let cap = self.settings.undo_levels as usize;
4919        self.buffer.cap_undo(cap);
4920    }
4921
4922    /// Test-only accessor for the undo stack length.
4923    #[doc(hidden)]
4924    pub fn undo_stack_len(&self) -> usize {
4925        self.buffer.undo_stack_len()
4926    }
4927
4928    /// Replace the buffer with `lines` joined by `\n` and set the
4929    /// cursor to `cursor`. Used by undo / `:e!` / snapshot restore
4930    /// paths. Marks the editor dirty.
4931    ///
4932    /// Emits a single whole-buffer `ContentEdit` describing the
4933    /// transition so the syntax layer can apply it as an `InputEdit`
4934    /// on the retained tree and run an INCREMENTAL parse — tree-sitter
4935    /// reuses unchanged subtrees and `Tree::changed_ranges` reports
4936    /// just the bytes that differ, which lets the install path walk
4937    /// only the changed rows instead of the full viewport. Big undos
4938    /// that revert a large paste now refresh in ~1ms per affected
4939    /// row instead of a ~30ms full-viewport sync walk.
4940    pub fn restore(&mut self, lines: &[String], cursor: (usize, usize)) {
4941        let text = lines.join("\n");
4942        self.restore_text(&text, cursor);
4943    }
4944
4945    /// Restore the buffer from a `ropey::Rope` snapshot. Used by undo /
4946    /// redo: snapshots are stored as `Rope` (O(1) Arc-clone via
4947    /// `View::rope()`), so this avoids the full-document `to_string`
4948    /// materialization that the old `Arc<String>` snapshot path forced
4949    /// on every undo group boundary.
4950    ///
4951    /// Internally materializes the rope to a `String` for `restore_text`
4952    /// — paying the cost on the restore side instead of the snapshot
4953    /// side trades one ~3 MB build per undo for none-per-snapshot. Undo
4954    /// is user-initiated and rare; snapshots fire on every `i` / `o`.
4955    pub fn restore_rope(&mut self, rope: &ropey::Rope, cursor: (usize, usize)) {
4956        let text = rope.to_string();
4957        self.restore_text(&text, cursor);
4958    }
4959
4960    fn restore_text(&mut self, text: &str, cursor: (usize, usize)) {
4961        // Diff the old rope (O(1) Arc-clone) against the incoming text
4962        // to emit a minimal ContentEdit — without it the syntax layer's
4963        // tree.edit() marks the whole document changed and tree-sitter
4964        // cold-parses on every undo.
4965        let old_rope = self.buffer.rope();
4966        let edit = minimal_content_edit_rope(&old_rope, text);
4967
4968        crate::types::BufferEdit::replace_all(&mut self.buffer, text);
4969        buf_set_cursor_rc(&mut self.buffer, cursor.0, cursor.1);
4970
4971        // Bulk replace supersedes any prior queued edits.
4972        self.buffer.clear_pending_content_edits();
4973        self.buffer.push_pending_content_edit(edit);
4974        self.mark_content_dirty();
4975    }
4976
4977    // ─── Range-query helpers for partial-format dispatch (#119) ─────────────
4978
4979    /// Drain the row range set by the most recent auto-indent operation.
4980    ///
4981    /// Returns `Some((top_row, bot_row))` (inclusive) on the first call after
4982    /// an `=` / `==` / `=G` / Visual-`=` operator, then clears the stored
4983    /// value so a subsequent call returns `None`. The host (e.g. `apps/hjkl`)
4984    /// uses this to arm a brief visual flash over the reindented rows.
4985    pub fn take_last_indent_range(&mut self) -> Option<(usize, usize)> {
4986        self.last_indent_range.take()
4987    }
4988
4989    /// Queue a user-visible error message. Engine and discipline code calls
4990    /// this where a host would call its message bar; the host drains it with
4991    /// [`Editor::take_errors`].
4992    ///
4993    /// Messages carry vim's own `E`-codes so they read the same as the ones
4994    /// `hjkl-ex` and `apps/hjkl` raise directly.
4995    pub fn push_error(&mut self, message: impl Into<String>) {
4996        self.pending_errors.push(message.into());
4997    }
4998
4999    /// Drain every message queued by [`Editor::push_error`] since the last
5000    /// call. A host that never drains this leaks the messages, which is why
5001    /// `apps/hjkl` drains once per key rather than per command.
5002    pub fn take_errors(&mut self) -> Vec<String> {
5003        std::mem::take(&mut self.pending_errors)
5004    }
5005
5006    /// Replace rows `top..=bot` (0-based, inclusive) with `new_lines` via a
5007    /// single bounded [`hjkl_buffer::Edit::Replace`] splice.
5008    ///
5009    /// Shared by [`Editor::toggle_comment_range`] and
5010    /// [`Editor::filter_range`] (audit D1 / D4): both used to rebuild the
5011    /// entire document as a `Vec<String>` + rejoin on every call —
5012    /// O(document size) for a range-scoped edit — which made `gcc` /
5013    /// `gc{motion}` and `:!`/`:%!` filters cost a full-document
5014    /// reallocation even when touching a single line. Routing through
5015    /// [`Editor::mutate_edit`] instead touches only the affected char span
5016    /// in the rope, so cost is O(edit size).
5017    ///
5018    /// `new_lines` may have a different row count than `bot - top + 1`
5019    /// (a filter can add/remove/keep lines) — including empty (deletes
5020    /// the range entirely). This is why the caller passes rows rather
5021    /// than a pre-joined string: `&[]` (delete) and `&[String::new()]`
5022    /// (replace with one blank line) join to the same `""` but must
5023    /// splice differently — the former must also swallow one of the
5024    /// range's boundary newlines, the latter must not.
5025    ///
5026    /// The boundary-newline math mirrors `do_delete_range`'s
5027    /// `MotionKind::Line` case (which already handles vim's "last row
5028    /// keeps no trailing newline" rule): when `bot` is not the buffer's
5029    /// last row, the replace span runs through the newline *after* `bot`
5030    /// and the inserted text re-adds it; when `bot` *is* the last row,
5031    /// the span instead runs from the end of row `top - 1` (swallowing
5032    /// the newline *before* `top`) so the buffer never grows a trailing
5033    /// empty row that didn't exist before.
5034    ///
5035    /// Cursor lands at `(top, 0)` — vim-commentary / filter parity —
5036    /// overriding wherever [`hjkl_buffer::Edit::Replace`] would otherwise
5037    /// leave it (end of the inserted text).
5038    ///
5039    /// Callers must call [`Editor::push_undo`] first so the whole
5040    /// operation lands as a single undo step (same contract `restore`
5041    /// callers already followed).
5042    fn splice_row_range(&mut self, top: usize, bot: usize, new_lines: &[String]) {
5043        let row_count = buf_row_count(&self.buffer);
5044        let bot_is_last_row = bot + 1 >= row_count;
5045        let joined = new_lines.join("\n");
5046
5047        let (start, end, with) = if !bot_is_last_row {
5048            // Rows exist after `bot` — span through the newline that
5049            // separates `bot` from `bot + 1` and re-add it (unless the
5050            // range is being deleted outright, i.e. `new_lines` is empty).
5051            let with = if new_lines.is_empty() {
5052                String::new()
5053            } else {
5054                format!("{joined}\n")
5055            };
5056            (
5057                hjkl_buffer::Position::new(top, 0),
5058                hjkl_buffer::Position::new(bot + 1, 0),
5059                with,
5060            )
5061        } else if top > 0 {
5062            // `bot` is the last row but rows exist before `top` — span
5063            // from the end of row `top - 1` (swallowing the newline
5064            // before `top`) through end-of-buffer, mirroring the
5065            // linewise-delete "no trailing-newline orphan" rule.
5066            let prev_end_col = buf_line_chars(&self.buffer, top - 1);
5067            let bot_end_col = buf_line_chars(&self.buffer, bot);
5068            let with = if new_lines.is_empty() {
5069                String::new()
5070            } else {
5071                format!("\n{joined}")
5072            };
5073            (
5074                hjkl_buffer::Position::new(top - 1, prev_end_col),
5075                hjkl_buffer::Position::new(bot, bot_end_col),
5076                with,
5077            )
5078        } else {
5079            // Whole buffer is the range (`top == 0`, `bot` == last row).
5080            let bot_end_col = buf_line_chars(&self.buffer, bot);
5081            (
5082                hjkl_buffer::Position::new(0, 0),
5083                hjkl_buffer::Position::new(bot, bot_end_col),
5084                joined,
5085            )
5086        };
5087
5088        self.mutate_edit(hjkl_buffer::Edit::Replace { start, end, with });
5089        buf_set_cursor_rc(&mut self.buffer, top, 0);
5090    }
5091
5092    /// Filter rows `top_row..=bot_row` through an external shell command.
5093    ///
5094    /// Spawns `sh -c "<command>"` (or `cmd /C "<command>"` on Windows), pipes
5095    /// the selected lines (joined by `\n`) to stdin, and waits up to
5096    /// `timeout_secs` seconds (default 10) for the process to finish.
5097    ///
5098    /// On success: the rows are replaced with stdout. No trailing-newline trim.
5099    /// On non-zero exit, spawn failure, or timeout: returns `Err(stderr_or_msg)`
5100    /// without mutating the buffer.
5101    ///
5102    /// `top_row` and `bot_row` are clamped to the buffer's valid row range.
5103    pub fn filter_range(
5104        &mut self,
5105        top_row: usize,
5106        bot_row: usize,
5107        command: &str,
5108        timeout_secs: Option<u64>,
5109    ) -> Result<(), String> {
5110        use std::io::Write;
5111        use std::process::{Command, Stdio};
5112        use std::thread;
5113        use std::time::Instant;
5114
5115        if crate::policy::shell_disabled() {
5116            return Err(
5117                "shell commands are disabled in this mode (pass --allow-shell to enable)".into(),
5118            );
5119        }
5120
5121        let timeout = std::time::Duration::from_secs(timeout_secs.unwrap_or(10));
5122        let rope = crate::types::Query::rope(self.buffer());
5123        let line_count = rope.len_lines();
5124        let top = top_row.min(line_count.saturating_sub(1));
5125        let bot = bot_row.min(line_count.saturating_sub(1));
5126        let (top, bot) = (top.min(bot), top.max(bot));
5127        let input_text = crate::rope_util::rope_row_range_str(&rope, top, bot);
5128
5129        tracing::debug!(
5130            top_row = top,
5131            bot_row = bot,
5132            command = command,
5133            "filter_range: spawning shell command"
5134        );
5135
5136        #[cfg(not(windows))]
5137        let mut child = Command::new("sh")
5138            .args(["-c", command])
5139            .stdin(Stdio::piped())
5140            .stdout(Stdio::piped())
5141            .stderr(Stdio::piped())
5142            .spawn()
5143            .map_err(|e| format!("spawn failed: {e}"))?;
5144
5145        #[cfg(windows)]
5146        let mut child = Command::new("cmd")
5147            .args(["/C", command])
5148            .stdin(Stdio::piped())
5149            .stdout(Stdio::piped())
5150            .stderr(Stdio::piped())
5151            .spawn()
5152            .map_err(|e| format!("spawn failed: {e}"))?;
5153
5154        // Write stdin on a thread to avoid deadlock when output > pipe buffer.
5155        let mut stdin = child.stdin.take().ok_or("no stdin handle")?;
5156        let input_bytes = input_text.into_bytes();
5157        thread::spawn(move || {
5158            let _ = stdin.write_all(&input_bytes);
5159            // stdin drops here, signalling EOF to the child.
5160        });
5161
5162        // Drain stdout/stderr on separate threads so the child's pipes don't
5163        // fill and deadlock the child. Keep `child` here so we can kill it on
5164        // timeout.
5165        let mut stdout_pipe = child.stdout.take().ok_or("no stdout handle")?;
5166        let mut stderr_pipe = child.stderr.take().ok_or("no stderr handle")?;
5167        let stdout_thread = thread::spawn(move || {
5168            let mut buf = Vec::new();
5169            let _ = std::io::Read::read_to_end(&mut stdout_pipe, &mut buf);
5170            buf
5171        });
5172        let stderr_thread = thread::spawn(move || {
5173            let mut buf = Vec::new();
5174            let _ = std::io::Read::read_to_end(&mut stderr_pipe, &mut buf);
5175            buf
5176        });
5177
5178        // Poll try_wait until exit or timeout. On timeout: SIGKILL the child
5179        // (std Child::kill sends SIGKILL on Unix / TerminateProcess on Windows).
5180        // A proper TERM→KILL escalation would need nix/libc; skip for v1.
5181        let start = Instant::now();
5182        let status = loop {
5183            match child.try_wait() {
5184                Ok(Some(status)) => break status,
5185                Ok(None) => {
5186                    if start.elapsed() >= timeout {
5187                        tracing::debug!(command, "filter_range: timeout — killing child");
5188                        let _ = child.kill();
5189                        let _ = child.wait(); // reap so the OS can free resources
5190                        return Err(format!("command timed out after {}s", timeout.as_secs()));
5191                    }
5192                    thread::sleep(std::time::Duration::from_millis(20));
5193                }
5194                Err(e) => return Err(format!("wait failed: {e}")),
5195            }
5196        };
5197
5198        let stdout_bytes = stdout_thread.join().unwrap_or_default();
5199        let stderr_bytes = stderr_thread.join().unwrap_or_default();
5200
5201        if !status.success() {
5202            let stderr = String::from_utf8_lossy(&stderr_bytes).into_owned();
5203            tracing::debug!(
5204                command,
5205                exit_code = ?status.code(),
5206                "filter_range: command exited with non-zero status"
5207            );
5208            return Err(if stderr.is_empty() {
5209                format!("command exited with status {}", status.code().unwrap_or(-1))
5210            } else {
5211                stderr
5212            });
5213        }
5214
5215        let stdout = String::from_utf8_lossy(&stdout_bytes).into_owned();
5216        tracing::debug!(
5217            command,
5218            stdout_bytes = stdout_bytes.len(),
5219            "filter_range: command succeeded, replacing rows"
5220        );
5221
5222        // Replace rows `top..=bot` with the stdout lines — a single
5223        // bounded splice (audit D4), not a whole-document rebuild.
5224        // `stdout.lines()` already drops the trailing-newline sentinel —
5225        // this preserves vim's "no trailing-newline trim" spec because a
5226        // trailing '\n' from the command means the last replacement line
5227        // is the line BEFORE the newline, not an empty line after it.
5228        let new_lines: Vec<String> = stdout.lines().map(|l| l.to_owned()).collect();
5229
5230        self.push_undo();
5231        self.splice_row_range(top, bot, &new_lines);
5232        // Leave the editor idle after a successful filter (vim parity: Normal).
5233        // Goes through the discipline hook, so the engine does not name vim.
5234        self.discipline.reset_to_idle();
5235
5236        Ok(())
5237    }
5238
5239    // ─── Comment toggle (#187) ───────────────────────────────────────────────
5240
5241    /// Toggle line comments on rows `top_row..=bot_row` (0-based, inclusive).
5242    ///
5243    /// **Algorithm** (vim-commentary parity):
5244    ///
5245    /// 1. Determine the comment marker(s) for the active filetype.
5246    ///    Priority: `settings.commentstring` (`:set commentstring=…`) → per-filetype
5247    ///    default from `hjkl_lang::comment::commentstring_for_lang` → no-op.
5248    /// 2. Scan non-blank lines.  If every non-blank line is already commented →
5249    ///    strip the comment marker from each.  Otherwise → add it to all non-blank
5250    ///    lines.
5251    /// 3. Blank / whitespace-only lines are skipped (no marker added or removed).
5252    /// 4. The marker is inserted AFTER the leading whitespace (indent-preserving).
5253    /// 5. The entire operation is a single undo step.
5254    ///
5255    /// For block-comment languages (HTML, CSS) each line is individually wrapped
5256    /// as `start text end` (per-line block style, not one multi-line block).
5257    ///
5258    /// `top_row` and `bot_row` are clamped to the buffer's valid row range.
5259    pub fn toggle_comment_range(&mut self, top_row: usize, bot_row: usize) {
5260        use hjkl_lang::comment::commentstring_for_lang;
5261
5262        let lang = self.settings.filetype.clone();
5263
5264        // Resolve the comment markers.
5265        // If `settings.commentstring` is set (non-empty) parse `start %s end`
5266        // from it; otherwise fall back to the filetype table.
5267        let (start, end) = if !self.settings.commentstring.is_empty() {
5268            let cs = &self.settings.commentstring;
5269            if let Some(idx) = cs.find("%s") {
5270                let s = cs[..idx].trim_end().to_string();
5271                let e_raw = cs[idx + 2..].trim_start();
5272                let e: Option<String> = if e_raw.is_empty() {
5273                    None
5274                } else {
5275                    Some(e_raw.to_string())
5276                };
5277                (s, e)
5278            } else {
5279                // No %s placeholder — treat the whole string as start marker.
5280                (cs.clone(), None)
5281            }
5282        } else {
5283            match commentstring_for_lang(&lang) {
5284                Some((s, e)) => (s.to_string(), e.map(|v| v.to_string())),
5285                None => return, // no known comment syntax → no-op
5286            }
5287        };
5288
5289        let row_count = buf_row_count(&self.buffer);
5290        let top = top_row.min(row_count.saturating_sub(1));
5291        let bot = bot_row.min(row_count.saturating_sub(1));
5292
5293        // Collect all lines in the range.
5294        let lines: Vec<String> = (top..=bot)
5295            .map(|r| buf_line(&self.buffer, r).unwrap_or_default())
5296            .collect();
5297
5298        // Check whether every non-blank line is already commented.
5299        let all_commented = lines.iter().all(|line| {
5300            let trimmed = line.trim_start();
5301            if trimmed.is_empty() {
5302                return true; // blank lines don't count against "all commented"
5303            }
5304            if let Some(ref end_marker) = end {
5305                // Block style: line starts with start and ends with end.
5306                trimmed.starts_with(start.as_str())
5307                    && line.trim_end().ends_with(end_marker.as_str())
5308            } else {
5309                trimmed.starts_with(start.as_str())
5310            }
5311        });
5312
5313        let mut new_lines: Vec<String> = Vec::with_capacity(lines.len());
5314        for line in &lines {
5315            let trimmed = line.trim_start();
5316            if trimmed.is_empty() {
5317                // Blank line — leave as-is.
5318                new_lines.push(line.clone());
5319                continue;
5320            }
5321            let indent_len = line.len() - trimmed.len();
5322            let indent = &line[..indent_len];
5323
5324            if all_commented {
5325                // Uncomment: strip exactly one occurrence of start (+ optional space).
5326                if let Some(after_start) = trimmed.strip_prefix(start.as_str()) {
5327                    // Strip one leading space after the marker if present.
5328                    let after_space = after_start.strip_prefix(' ').unwrap_or(after_start);
5329                    // For block style also strip the trailing end marker.
5330                    let text = if let Some(ref end_marker) = end {
5331                        after_space
5332                            .trim_end()
5333                            .strip_suffix(end_marker.as_str())
5334                            .map_or(after_space, |s| s.trim_end())
5335                    } else {
5336                        after_space
5337                    };
5338                    new_lines.push(format!("{indent}{text}"));
5339                } else {
5340                    new_lines.push(line.clone());
5341                }
5342            } else {
5343                // Comment: insert marker after indent.
5344                let commented = if let Some(ref end_marker) = end {
5345                    format!("{indent}{start} {trimmed} {end_marker}")
5346                } else {
5347                    format!("{indent}{start} {trimmed}")
5348                };
5349                new_lines.push(commented);
5350            }
5351        }
5352
5353        // Replace the row range in the buffer — single undo step, O(edit
5354        // size) rather than O(document size) (audit D1): `gcc` on one line
5355        // of a huge file no longer rebuilds the whole document.
5356        self.push_undo();
5357        self.splice_row_range(top, bot, &new_lines);
5358    }
5359
5360    // ─── Phase 6.1: public insert-mode primitives (kryptic-sh/hjkl#87) ────────
5361    //
5362    // Each method is the publicly callable form of one insert-mode action.
5363    // All logic lives in the corresponding `vim::*_bridge` free function;
5364    // these methods are thin delegators so the public surface stays on `Editor`.
5365    //
5366    // Invariants (enforced by the bridge fns):
5367    //   - View mutations go through `mutate_edit` (dirty/undo/change-list).
5368    //   - Navigation keys call `break_undo_group_in_insert` when the FSM did.
5369}
5370
5371// ── Phase 6.6b: FSM state accessors (for hjkl-vim ownership) ─────────────────
5372//
5373// The FSM (now in hjkl-vim) reads/writes `VimState` fields through public
5374// `Editor` accessors and mutators defined in this block. Each method gets a
5375// one-line `///` rustdoc. Fields mutated as a unit get a combined action method
5376// rather than individual getters + setters (e.g. `accumulate_count_digit`).
5377
5378impl<H: crate::types::Host> Editor<hjkl_buffer::View, H> {
5379    // ── Pending chord ─────────────────────────────────────────────────────────
5380
5381    // ── Abbreviations ─────────────────────────────────────────────────────────
5382
5383    /// Register an abbreviation. If an entry for `lhs` already exists (same
5384    /// mode flags), it is replaced. Inserts at the front so newer definitions
5385    /// take priority (first-match wins in `try_abbrev_expand`).
5386    pub fn add_abbrev(&mut self, lhs: &str, rhs: &str, insert: bool, cmdline: bool, noremap: bool) {
5387        let mut abbrevs = self.abbrevs.lock().unwrap();
5388        // Remove existing entry with same lhs + overlapping mode flags.
5389        abbrevs.retain(|a| a.lhs != lhs || (a.insert && !insert) || (a.cmdline && !cmdline));
5390        abbrevs.insert(
5391            0,
5392            crate::abbrev::Abbrev {
5393                lhs: lhs.to_string(),
5394                rhs: rhs.to_string(),
5395                insert,
5396                cmdline,
5397                noremap,
5398            },
5399        );
5400    }
5401
5402    /// Remove the abbreviation with the given `lhs`. Only removes entries
5403    /// whose mode flags overlap with the requested `insert`/`cmdline` flags.
5404    pub fn remove_abbrev(&mut self, lhs: &str, insert: bool, cmdline: bool) {
5405        self.abbrevs
5406            .lock()
5407            .unwrap()
5408            .retain(|a| a.lhs != lhs || (!insert || !a.insert) && (!cmdline || !a.cmdline));
5409    }
5410
5411    /// Clear all abbreviations matching the given mode flags.
5412    ///
5413    /// `insert=true` removes insert-mode abbrevs; `cmdline=true` removes
5414    /// cmdline-mode abbrevs. Both `true` clears everything.
5415    pub fn clear_abbrevs(&mut self, insert: bool, cmdline: bool) {
5416        self.abbrevs.lock().unwrap().retain(|a| {
5417            // Keep entries that do NOT match any of the cleared modes.
5418            let cleared = (insert && a.insert) || (cmdline && a.cmdline);
5419            !cleared
5420        });
5421    }
5422
5423    // ── Phase 6.6c: search + jump helpers (public Editor API) ───────────────
5424    //
5425    // `push_search_pattern`, `push_jump`, `record_search_history`, and
5426    // `walk_search_history` are public `Editor` methods so that `hjkl-vim`'s
5427    // search-prompt and normal-mode FSM can call them via the public API.
5428
5429    /// Compile `pattern` into a regex and install it as the active search
5430    /// pattern. Respects `:set ignorecase` / `:set smartcase` and inline
5431    /// `\c`/`\C` overrides. An empty or invalid pattern clears the highlight
5432    /// without raising an error.
5433    pub fn push_search_pattern(&mut self, pattern: &str) {
5434        let compiled = if pattern.is_empty() {
5435            None
5436        } else {
5437            use crate::search::{CaseMode, resolve_case_mode};
5438            let base =
5439                CaseMode::from_options(self.settings().ignore_case, self.settings().smartcase);
5440            let last_sub = self.last_substitute_replacement();
5441            let (stripped, mode) = resolve_case_mode(pattern, base, &last_sub);
5442            let src = if mode == CaseMode::Insensitive {
5443                format!("(?i){stripped}")
5444            } else {
5445                stripped
5446            };
5447            regex::Regex::new(&src).ok()
5448        };
5449        let wrap = self.settings().wrapscan;
5450        self.set_search_pattern(compiled);
5451        self.search_state_mut().wrap_around = wrap;
5452    }
5453
5454    /// Record a pre-jump cursor position onto the back jumplist. Called
5455    /// before any "big jump" motion (`gg`/`G`, `%`, `*`/`#`, `n`/`N`,
5456    /// committed `/` or `?`, …). Branching off the history clears the
5457    /// forward half, matching vim's "redo-is-lost" semantics.
5458    pub fn push_jump(&mut self, from: (usize, usize)) {
5459        self.jump_back.push(from);
5460        if self.jump_back.len() > crate::types::JUMPLIST_MAX {
5461            self.jump_back.remove(0);
5462        }
5463        self.jump_fwd.clear();
5464    }
5465
5466    /// Push `pattern` onto the committed search history. Skips if the
5467    /// most recent entry already matches (consecutive dedupe) and trims
5468    /// the oldest entries beyond the history cap.
5469    pub fn record_search_history(&mut self, pattern: &str) {
5470        if pattern.is_empty() {
5471            return;
5472        }
5473        let mut bank = self.search.lock().unwrap();
5474        if bank.history.last().map(String::as_str) == Some(pattern) {
5475            return;
5476        }
5477        bank.history.push(pattern.to_string());
5478        let len = bank.history.len();
5479        if len > crate::types::SEARCH_HISTORY_MAX {
5480            bank.history
5481                .drain(0..len - crate::types::SEARCH_HISTORY_MAX);
5482        }
5483    }
5484
5485    /// Walk the search-prompt history by `dir` steps. `dir = -1` moves
5486    /// toward older entries (Ctrl-P / Up); `dir = 1` toward newer ones
5487    /// (Ctrl-N / Down). Stops at the ends; does nothing if there is no
5488    /// active search prompt.
5489    pub fn walk_search_history(&mut self, dir: isize) {
5490        if self.search_prompt.is_none() {
5491            return;
5492        }
5493        let Some(text) = ({
5494            let mut bank = self.search.lock().unwrap();
5495            if bank.history.is_empty() {
5496                None
5497            } else {
5498                let len = bank.history.len();
5499                let next_idx = match (bank.history_cursor, dir) {
5500                    (None, -1) => Some(len - 1),
5501                    (None, 1) => None,
5502                    (Some(i), -1) => i.checked_sub(1),
5503                    (Some(i), 1) if i + 1 < len => Some(i + 1),
5504                    _ => None,
5505                };
5506                next_idx.map(|idx| {
5507                    bank.history_cursor = Some(idx);
5508                    bank.history[idx].clone()
5509                })
5510            }
5511        }) else {
5512            return;
5513        };
5514        if let Some(prompt) = self.search_prompt.as_mut() {
5515            prompt.cursor = text.chars().count();
5516            prompt.text.clone_from(&text);
5517        }
5518        self.push_search_pattern(&text);
5519    }
5520
5521    // The per-step prelude/epilogue (`begin_step`/`end_step` + `StepBookkeeping`)
5522    // moved to `hjkl_vim::step` (#267); the engine no longer owns FSM bookkeeping.
5523
5524    /// Return the character count (code-point count) of line `row`, or `0`
5525    /// when `row` is out of range.
5526    ///
5527    /// A raw buffer read with no vim semantics, so it stays on the engine core
5528    /// while the vim-specific visual/block primitives move to
5529    /// `hjkl_vim::VimEditorExt` (#267).
5530    pub fn line_char_count(&self, row: usize) -> usize {
5531        buf_line_chars(&self.buffer, row)
5532    }
5533}
5534
5535/// First `(row, col)` where two ropes differ, or `None` if identical. Used to
5536/// place the cursor at the start of a redone change (vim parity).
5537fn first_diff_pos(a: &ropey::Rope, b: &ropey::Rope) -> Option<(usize, usize)> {
5538    let rows = a.len_lines().max(b.len_lines());
5539    for r in 0..rows {
5540        let la = if r < a.len_lines() {
5541            hjkl_buffer::rope_line_str(a, r)
5542        } else {
5543            String::new()
5544        };
5545        let lb = if r < b.len_lines() {
5546            hjkl_buffer::rope_line_str(b, r)
5547        } else {
5548            String::new()
5549        };
5550        if la != lb {
5551            let col = la
5552                .chars()
5553                .zip(lb.chars())
5554                .take_while(|(x, y)| x == y)
5555                .count();
5556            return Some((r, col));
5557        }
5558    }
5559    None
5560}
5561
5562/// Visual column of the character at `char_col` in `line`.
5563///
5564/// Thin alias for [`hjkl_buffer::char_col_to_visual_col`], which owns the
5565/// tab-stop and `unicode-width` rules the renderer's `paint_row` uses. This
5566/// used to be a second, naive copy that counted every non-tab char as one
5567/// cell; it drifted from the painted glyph on any line containing CJK, emoji
5568/// or a combining mark, so `cursor_screen_pos` drew the cursor block left of
5569/// the character it was on.
5570fn visual_col_for_char(line: &str, char_col: usize, tab_width: usize) -> usize {
5571    char_col_to_visual_col(line, char_col, tab_width)
5572}
5573
5574#[cfg(test)]
5575mod cursor_screen_pos_width_tests {
5576    use super::*;
5577    use crate::types::{DefaultHost, Host, Options};
5578    use hjkl_buffer::View;
5579
5580    /// The terminal cursor block must be placed at the cell the glyph is
5581    /// painted in. `paint_row` gives `世` and `界` two cells each, so on
5582    /// `ab世界cd` the `c` (char index 4) is at screen x 6, not 4.
5583    #[test]
5584    fn cursor_x_accounts_for_double_width_chars() {
5585        for (char_col, expected_x) in [(0usize, 0u16), (1, 1), (2, 2), (3, 4), (4, 6), (5, 7)] {
5586            let mut e = Editor::new(
5587                View::from_str("ab世界cd"),
5588                DefaultHost::new(),
5589                Options::default(),
5590            );
5591            {
5592                let vp = e.host_mut().viewport_mut();
5593                vp.top_row = 0;
5594                vp.top_col = 0;
5595                vp.width = 80;
5596                vp.height = 10;
5597                vp.tab_width = 4;
5598            }
5599            e.jump_cursor(0, char_col);
5600            let (x, _y) = e
5601                .cursor_screen_pos(0, 0, 80, 10, 0)
5602                .expect("cursor is inside the viewport");
5603            // `lnum_width()` reserves a gutter; measure relative to char 0.
5604            let base = {
5605                let mut e0 = Editor::new(
5606                    View::from_str("ab世界cd"),
5607                    DefaultHost::new(),
5608                    Options::default(),
5609                );
5610                {
5611                    let vp = e0.host_mut().viewport_mut();
5612                    vp.top_row = 0;
5613                    vp.top_col = 0;
5614                    vp.width = 80;
5615                    vp.height = 10;
5616                    vp.tab_width = 4;
5617                }
5618                e0.jump_cursor(0, 0);
5619                e0.cursor_screen_pos(0, 0, 80, 10, 0).unwrap().0
5620            };
5621            assert_eq!(x - base, expected_x, "char col {char_col}");
5622        }
5623    }
5624}
5625
5626#[cfg(test)]
5627mod shift_syntax_spans_tests {
5628    use super::*;
5629    use crate::types::{ContentEdit, DefaultHost, Options, Style};
5630    use hjkl_buffer::View;
5631
5632    fn ed_with_spans(line_count: usize) -> Editor<View, DefaultHost> {
5633        let text = (0..line_count)
5634            .map(|i| format!("row{i}"))
5635            .collect::<Vec<_>>()
5636            .join("\n");
5637        let buf = View::from_str(&text);
5638        let mut e = Editor::new(buf, DefaultHost::new(), Options::default());
5639        // Synthesize span rows so we can detect which survive a shift.
5640        // Use a distinct fg colour per row so spans are identifiable.
5641        let style = Style::default();
5642        let spans: Vec<Vec<(usize, usize, Style)>> =
5643            (0..line_count).map(|_| vec![(0, 1, style)]).collect();
5644        e.install_syntax_spans(spans);
5645        e
5646    }
5647
5648    fn edit_insert_newline_at(row: u32, col: u32) -> ContentEdit {
5649        // Pressing Enter: zero-width insertion that produces one new row.
5650        ContentEdit {
5651            start_byte: 0,
5652            old_end_byte: 0,
5653            new_end_byte: 1,
5654            start_position: (row, col),
5655            old_end_position: (row, col),
5656            new_end_position: (row + 1, 0),
5657        }
5658    }
5659
5660    fn edit_join_rows(row: u32, col: u32) -> ContentEdit {
5661        // Backspace at start of `row+1`: removes the newline, joining the
5662        // two rows. old_end is on `row+1`, new_end on `row`.
5663        ContentEdit {
5664            start_byte: 0,
5665            old_end_byte: 1,
5666            new_end_byte: 0,
5667            start_position: (row, col),
5668            old_end_position: (row + 1, 0),
5669            new_end_position: (row, col),
5670        }
5671    }
5672
5673    #[test]
5674    fn insert_grows_buffer_spans_in_place() {
5675        let mut e = ed_with_spans(4);
5676        // Newline at row 1 → buffer grew by one row.
5677        e.shift_syntax_spans_for_edits(&[edit_insert_newline_at(1, 1)]);
5678        assert_eq!(
5679            e.buffer_spans().len(),
5680            5,
5681            "row-count grew → spans rows must match"
5682        );
5683        // The empty row should be at index 2 (right after the split point).
5684        assert!(e.buffer_spans()[2].is_empty(), "inserted row sits at oer+1");
5685        // Surrounding rows kept their content.
5686        assert!(!e.buffer_spans()[0].is_empty());
5687        assert!(!e.buffer_spans()[1].is_empty());
5688        assert!(!e.buffer_spans()[3].is_empty());
5689        assert!(!e.buffer_spans()[4].is_empty());
5690    }
5691
5692    #[test]
5693    fn delete_shrinks_buffer_spans_in_place() {
5694        let mut e = ed_with_spans(4);
5695        e.shift_syntax_spans_for_edits(&[edit_join_rows(1, 1)]);
5696        assert_eq!(
5697            e.buffer_spans().len(),
5698            3,
5699            "row-count shrank → spans rows must match"
5700        );
5701    }
5702
5703    #[test]
5704    fn same_row_edit_leaves_rows_untouched() {
5705        let mut e = ed_with_spans(3);
5706        let edit = ContentEdit {
5707            start_byte: 0,
5708            old_end_byte: 0,
5709            new_end_byte: 1,
5710            start_position: (1, 0),
5711            old_end_position: (1, 0),
5712            new_end_position: (1, 1),
5713        };
5714        e.shift_syntax_spans_for_edits(&[edit]);
5715        assert_eq!(e.buffer_spans().len(), 3);
5716        for row in 0..3 {
5717            assert!(
5718                !e.buffer_spans()[row].is_empty(),
5719                "row {row} should still hold its span"
5720            );
5721        }
5722    }
5723
5724    #[test]
5725    fn ordered_edits_apply_against_prior_state() {
5726        let mut e = ed_with_spans(3);
5727        // Two consecutive inserts: each adds a row.
5728        e.shift_syntax_spans_for_edits(&[
5729            edit_insert_newline_at(0, 1),
5730            edit_insert_newline_at(1, 1),
5731        ]);
5732        assert_eq!(e.buffer_spans().len(), 5);
5733    }
5734
5735    /// The syntax worker lags the buffer, so a span table can arrive with
5736    /// MORE rows than the buffer currently has (e.g. `dd` landed between the
5737    /// parse and its delivery). Those rows must clamp to length 0 and drop
5738    /// their spans — never panic. Guards the row-length lookup, which reads
5739    /// the rope directly (`ropey::Rope::line` panics past the last line).
5740    #[test]
5741    fn install_tolerates_more_span_rows_than_buffer_rows() {
5742        let text = "aaaa\nbbbb\ncccc";
5743        let mut e = Editor::new(View::from_str(text), DefaultHost::new(), Options::default());
5744        let style = Style::default();
5745        let spans: Vec<Vec<(usize, usize, Style)>> = (0..10).map(|_| vec![(0, 4, style)]).collect();
5746        e.install_syntax_spans(spans);
5747        assert_eq!(e.buffer_spans().len(), 10, "one row per supplied entry");
5748        for row in 0..3 {
5749            assert_eq!(e.buffer_spans()[row].len(), 1, "row {row} keeps its span");
5750        }
5751        for row in 3..10 {
5752            assert!(
5753                e.buffer_spans()[row].is_empty(),
5754                "row {row} is past the buffer — clamps to 0 and drops"
5755            );
5756        }
5757    }
5758
5759    /// Spans are clamped in BYTES, not chars — a row of multi-byte text must
5760    /// keep a span that ends past the char count but inside the byte length.
5761    #[test]
5762    fn clamp_unit_is_bytes_not_chars() {
5763        // 5 chars, 10 bytes.
5764        let text = "ααααα\nx";
5765        let mut e = Editor::new(View::from_str(text), DefaultHost::new(), Options::default());
5766        let style = Style::default();
5767        e.install_syntax_spans(vec![vec![(0usize, 10usize, style)], vec![]]);
5768        assert_eq!(
5769            e.buffer_spans()[0][0].end_byte,
5770            10,
5771            "byte-length clamp must not truncate to the char count"
5772        );
5773        // Exactly one byte past the row survives — that is the marker for a
5774        // multi-row span covering this row's end (a markdown code block),
5775        // which the renderer paints across the whole row.
5776        e.install_syntax_spans(vec![vec![(0usize, 11usize, style)], vec![]]);
5777        assert_eq!(e.buffer_spans()[0][0].end_byte, 11);
5778        // Anything beyond that is still clamped to the byte length, so a
5779        // `usize::MAX`-style "to end of line" end never reads as the marker.
5780        e.install_syntax_spans(vec![vec![(0usize, 12usize, style)], vec![]]);
5781        assert_eq!(e.buffer_spans()[0][0].end_byte, 10);
5782    }
5783
5784    /// Build a buffer with `line_count` rows where row `i` has a span at
5785    /// column `i + 1` so the rows are independently identifiable after a
5786    /// shift (otherwise all spans look identical and can't tell which
5787    /// original row's spans landed at which post-shift index).
5788    fn ed_with_distinguishable_spans(line_count: usize) -> Editor<View, DefaultHost> {
5789        let text = (0..line_count)
5790            .map(|i| format!("rowwwwwwwwww{i}"))
5791            .collect::<Vec<_>>()
5792            .join("\n");
5793        let buf = View::from_str(&text);
5794        let mut e = Editor::new(buf, DefaultHost::new(), Options::default());
5795        let style = Style::default();
5796        let spans: Vec<Vec<(usize, usize, Style)>> = (0..line_count)
5797            .map(|i| vec![(i + 1, i + 2, style)])
5798            .collect();
5799        e.install_syntax_spans(spans);
5800        e
5801    }
5802
5803    /// Regression for off-by-one in `shift_syntax_spans_for_edits`.
5804    ///
5805    /// `P` (paste-before) at column 0 of row 0 inserts new lines BEFORE
5806    /// row 0. The pre-paste rows should shift down by N. The fix inserts
5807    /// empty rows at idx `start.row` (not `oer + 1`) when `start.col == 0`.
5808    ///
5809    /// Symptom before the fix: row 0's spans stayed at idx 0 after a
5810    /// 4-row `ggP`, but the file's row 0 was now the pasted content (no
5811    /// spans available yet). Display: pasted row 0 painted with the
5812    /// pre-paste row 0's spans (LUCKILY identical content in many cases)
5813    /// while the *shifted* pre-paste row 0 (now at file row 4) painted
5814    /// with the pre-paste row 1's spans — visible as the WRONG row
5815    /// showing the wrong-row colours.
5816    #[test]
5817    fn shift_for_paste_at_start_of_row_zero() {
5818        let mut e = ed_with_distinguishable_spans(7);
5819        // Snapshot: row i has a span at col (i+1, i+2).
5820        let pre = e.buffer_spans().to_vec();
5821        // P at (0, 0) inserting 4 lines.
5822        let edit = ContentEdit {
5823            start_byte: 0,
5824            old_end_byte: 0,
5825            new_end_byte: 4,
5826            start_position: (0, 0),
5827            old_end_position: (0, 0),
5828            new_end_position: (4, 0),
5829        };
5830        e.shift_syntax_spans_for_edits(&[edit]);
5831        assert_eq!(e.buffer_spans().len(), 11, "row count grew by 4");
5832        // Rows 0..4 are the new pasted lines — should be EMPTY placeholders.
5833        for row in 0..4 {
5834            assert!(
5835                e.buffer_spans()[row].is_empty(),
5836                "row {row} (new paste) must be empty placeholder, got {:?}",
5837                e.buffer_spans()[row]
5838            );
5839        }
5840        // Rows 4..11 are the original rows 0..7 shifted down by 4.
5841        for (orig_row, orig_spans) in pre.iter().enumerate() {
5842            let new_row = orig_row + 4;
5843            assert_eq!(
5844                &e.buffer_spans()[new_row],
5845                orig_spans,
5846                "original row {orig_row} should be at file row {new_row} after \
5847                 paste-before-row-0"
5848            );
5849        }
5850    }
5851
5852    /// Same idea for paste at start of a non-zero row: `2GP` inserts 3
5853    /// lines before row 2.
5854    #[test]
5855    fn shift_for_paste_at_start_of_middle_row() {
5856        let mut e = ed_with_distinguishable_spans(5);
5857        let pre = e.buffer_spans().to_vec();
5858        // Insert 3 lines at (2, 0).
5859        let edit = ContentEdit {
5860            start_byte: 0,
5861            old_end_byte: 0,
5862            new_end_byte: 3,
5863            start_position: (2, 0),
5864            old_end_position: (2, 0),
5865            new_end_position: (5, 0),
5866        };
5867        e.shift_syntax_spans_for_edits(&[edit]);
5868        assert_eq!(e.buffer_spans().len(), 8);
5869        // Rows 0..2 unchanged (before the insertion point).
5870        assert_eq!(e.buffer_spans()[0], pre[0]);
5871        assert_eq!(e.buffer_spans()[1], pre[1]);
5872        // Rows 2..5 are new pasted lines.
5873        for row in 2..5 {
5874            assert!(
5875                e.buffer_spans()[row].is_empty(),
5876                "row {row} must be empty placeholder"
5877            );
5878        }
5879        // Rows 5..8 are originals 2..5 shifted down by 3.
5880        for (orig_row, orig_spans) in pre.iter().enumerate().take(5).skip(2) {
5881            let new_row = orig_row + 3;
5882            assert_eq!(
5883                &e.buffer_spans()[new_row],
5884                orig_spans,
5885                "original row {orig_row} should land at file row {new_row}"
5886            );
5887        }
5888    }
5889
5890    /// Regression: pasting N rows at the beginning of the buffer used to
5891    /// run `Vec::insert(0, ...)` once per row → O(N²) memmove. samply
5892    /// showed this path eating 87 % of paste CPU on a 60 k-row paste.
5893    /// The splice rewrite is O(N).
5894    ///
5895    /// Asserting a hard wall-clock bound is brittle on slow CI, so we
5896    /// pick a budget the old code blows past by >10×: 60 k rows in
5897    /// under 200 ms even on a debug build. Old impl: ~3-5 seconds.
5898    #[test]
5899    fn shift_for_60k_row_paste_at_row_zero_is_under_200ms() {
5900        let mut e = ed_with_distinguishable_spans(8);
5901        let edit = ContentEdit {
5902            start_byte: 0,
5903            old_end_byte: 0,
5904            new_end_byte: 60_000,
5905            start_position: (0, 0),
5906            old_end_position: (0, 0),
5907            new_end_position: (60_000, 0),
5908        };
5909        let t = std::time::Instant::now();
5910        e.shift_syntax_spans_for_edits(&[edit]);
5911        let elapsed = t.elapsed();
5912        assert!(
5913            elapsed.as_millis() < 200,
5914            "60k-row shift took {elapsed:?}; budget is 200 ms (catches \
5915             reintroduction of the O(N²) per-row insert loop)"
5916        );
5917        assert_eq!(e.buffer_spans().len(), 60_008);
5918    }
5919
5920    /// Regression: `push_undo` used to clone every line into a
5921    /// `Vec<String>` (162 k heap allocations on a 162 k-row buffer per
5922    /// snapshot). Now stores an `Arc<String>` shared with
5923    /// `View::content_joined`'s per-dirty_gen cache — a warm snapshot
5924    /// is an `Arc::clone` (one ptr bump).
5925    ///
5926    /// Test: snapshot a 60 k-row buffer 100 times. With the Arc impl
5927    /// this is essentially free (one join then 99 Arc::clones). The
5928    /// old `Vec<String>` impl required 60 k allocations per call =
5929    /// 6 M allocations, easily seconds even on release.
5930    #[test]
5931    fn push_undo_snapshot_arc_clone_is_under_100ms_for_100_snapshots() {
5932        use crate::types::{DefaultHost, Options};
5933        let text = "x\n".repeat(60_000);
5934        let buf = hjkl_buffer::View::from_str(&text);
5935        let mut e = Editor::new(buf, DefaultHost::default(), Options::default());
5936        // Warm the cache: one join, subsequent snapshots Arc::clone it.
5937        e.push_undo();
5938        let t = std::time::Instant::now();
5939        for _ in 0..100 {
5940            e.push_undo();
5941        }
5942        let elapsed = t.elapsed();
5943        assert!(
5944            elapsed.as_millis() < 100,
5945            "100 snapshots of a 60k-row buffer took {elapsed:?}; budget \
5946             100 ms. Likely regressed to per-line cloning."
5947        );
5948    }
5949}
5950
5951#[cfg(test)]
5952mod content_edit_shape_tests {
5953    //! Property tests for [`content_edits_from_buffer_edit`] (audit R2).
5954    //!
5955    //! The ground truth is the BUFFER: for any `hjkl_buffer::Edit`, the
5956    //! emitted `ContentEdit` sequence — applied to the pre-edit text by a
5957    //! naive sequential byte splicer — must reproduce the post-edit buffer
5958    //! text EXACTLY. The same sequence feeds tree-sitter `tree.edit`, LSP
5959    //! incremental didChange, sibling-cursor rebase and fold invalidation,
5960    //! all of which consume each edit against the document as already
5961    //! modified by the preceding edits in the batch.
5962
5963    use super::*;
5964    use hjkl_buffer::{Edit, MotionKind, Position, View};
5965
5966    /// Apply `edit` to a buffer built from `initial`, then replay the
5967    /// emitted `ContentEdit`s through a naive sequential splicer and
5968    /// assert the result equals the post-edit buffer text.
5969    ///
5970    /// Replacement text for edit `i` is sliced from the post-edit document
5971    /// at `[start_byte, new_end_byte)` shifted by the net byte delta of any
5972    /// edit that (a) hasn't been applied to the running splice yet (index
5973    /// `> i`) and (b) sits textually BEFORE edit `i` in the pre-edit
5974    /// document — such an edit is already baked into `post`'s layout at
5975    /// edit `i`'s position but hasn't been reflected in the splice yet.
5976    /// For an ascending-disjoint batch (`build_text_changes`'s own
5977    /// contract) no edit satisfies both conditions — every not-yet-applied
5978    /// edit sits AFTER, not before — so the shift is always 0 and this is
5979    /// exactly the plain `[start_byte, new_end_byte)` slice. For a
5980    /// descending fan-out (block ops, SplitLines — audit-r2 fix 5) EVERY
5981    /// not-yet-applied edit sits before, so this exactly cancels the
5982    /// layout shift their (already-baked-into-`post`) insertions cause.
5983    /// All six coordinates are cross-checked against the evolving
5984    /// document. Returns the edits so callers can additionally pin exact
5985    /// shapes.
5986    fn check_shapes(initial: &str, edit: Edit) -> Vec<crate::types::ContentEdit> {
5987        let mut view = View::from_str(initial);
5988        let edits = content_edits_from_buffer_edit(&view, &edit);
5989        view.apply_edit(edit);
5990        let post = view.as_string();
5991
5992        let mut cur = initial.to_string();
5993        for (i, e) in edits.iter().enumerate() {
5994            assert!(
5995                e.start_byte <= e.old_end_byte,
5996                "edit {i}: start_byte > old_end_byte\n{e:?}"
5997            );
5998            assert!(
5999                e.old_end_byte <= cur.len(),
6000                "edit {i}: old_end_byte {} past evolving doc len {}\n{e:?}",
6001                e.old_end_byte,
6002                cur.len()
6003            );
6004            assert_eq!(
6005                byte_to_row_col(cur.as_bytes(), e.start_byte),
6006                e.start_position,
6007                "edit {i}: start_position disagrees with start_byte\n{e:?}"
6008            );
6009            assert_eq!(
6010                byte_to_row_col(cur.as_bytes(), e.old_end_byte),
6011                e.old_end_position,
6012                "edit {i}: old_end_position disagrees with old_end_byte\n{e:?}"
6013            );
6014            let shift: i64 = edits[i + 1..]
6015                .iter()
6016                .filter(|other| other.start_byte < e.start_byte)
6017                .map(|other| other.new_end_byte as i64 - other.old_end_byte as i64)
6018                .sum();
6019            let post_start = (e.start_byte as i64 + shift) as usize;
6020            let post_new_end = (e.new_end_byte as i64 + shift) as usize;
6021            // A pure delete inserts nothing; its (empty) new range may sit
6022            // past the end of the final document, so short-circuit it the
6023            // way `build_text_changes`' clamping does.
6024            let replacement = if e.new_end_byte == e.start_byte {
6025                ""
6026            } else {
6027                post.get(post_start..post_new_end).unwrap_or_else(|| {
6028                    panic!(
6029                        "edit {i}: shifted [{post_start}, {post_new_end}) (raw [{}, {})) \
6030                         is not a valid slice of the post-edit doc ({} bytes)\n{e:?}",
6031                        e.start_byte,
6032                        e.new_end_byte,
6033                        post.len()
6034                    )
6035                })
6036            };
6037            assert!(
6038                cur.is_char_boundary(e.start_byte) && cur.is_char_boundary(e.old_end_byte),
6039                "edit {i}: old range splits a multi-byte char\n{e:?}"
6040            );
6041            cur.replace_range(e.start_byte..e.old_end_byte, replacement);
6042            assert_eq!(
6043                byte_to_row_col(cur.as_bytes(), e.new_end_byte),
6044                e.new_end_position,
6045                "edit {i}: new_end_position disagrees with new_end_byte\n{e:?}"
6046            );
6047        }
6048        assert_eq!(
6049            cur, post,
6050            "sequential splice of the emitted ContentEdits diverged from \
6051             the buffer's actual post-edit text"
6052        );
6053        edits
6054    }
6055
6056    fn join(row: usize, count: usize, with_space: bool) -> Edit {
6057        Edit::JoinLines {
6058            row,
6059            count,
6060            with_space,
6061        }
6062    }
6063
6064    fn del(start: (usize, usize), end: (usize, usize), kind: MotionKind) -> Edit {
6065        Edit::DeleteRange {
6066            start: Position::new(start.0, start.1),
6067            end: Position::new(end.0, end.1),
6068            kind,
6069        }
6070    }
6071
6072    /// `inserted_space` is a UNIFORM convenience for simple single- or
6073    /// mixed-intent test cases — broadcasts to every col. Tests that need
6074    /// genuinely mixed per-col outcomes (some joins inserted a space, some
6075    /// didn't — audit-r2 fix 6) construct `Edit::SplitLines` directly.
6076    fn split(row: usize, cols: Vec<usize>, inserted_space: bool) -> Edit {
6077        let inserted_spaces = vec![inserted_space; cols.len()];
6078        Edit::SplitLines {
6079            row,
6080            cols,
6081            inserted_spaces,
6082        }
6083    }
6084
6085    fn insert_block(at: (usize, usize), chunks: &[&str]) -> Edit {
6086        Edit::InsertBlock {
6087            at: Position::new(at.0, at.1),
6088            chunks: chunks.iter().map(|s| s.to_string()).collect(),
6089        }
6090    }
6091
6092    fn delete_block_chunks(at: (usize, usize), widths: Vec<usize>) -> Edit {
6093        let pads = vec![0; widths.len()];
6094        Edit::DeleteBlockChunks {
6095            at: Position::new(at.0, at.1),
6096            widths,
6097            pads,
6098        }
6099    }
6100
6101    // ── Shape 1: JoinLines ────────────────────────────────────────
6102
6103    /// Insert-mode Backspace at col 0 of "bar": the ONLY byte change is
6104    /// the '\n' at byte 3 being removed — "bar" stays in the buffer.
6105    #[test]
6106    fn join_backspace_at_col0_removes_only_the_newline() {
6107        let edits = check_shapes("foo\nbar\nbaz", join(0, 1, false));
6108        assert_eq!(edits.len(), 1);
6109        let e = &edits[0];
6110        assert_eq!(
6111            (e.start_byte, e.old_end_byte, e.new_end_byte),
6112            (3, 4, 3),
6113            "real change is [3, 4) → \"\"; got {e:?}"
6114        );
6115        assert_eq!(e.start_position, (0, 3));
6116        assert_eq!(e.old_end_position, (1, 0));
6117        assert_eq!(e.new_end_position, (0, 3));
6118    }
6119
6120    #[test]
6121    fn join_gj_style_no_space() {
6122        check_shapes("alpha\nbeta\ngamma", join(0, 1, false));
6123        check_shapes("alpha\nbeta\ngamma", join(1, 1, false));
6124    }
6125
6126    /// count=2 joins twice; each join's edit must be expressed against
6127    /// the document as modified by the previous join.
6128    #[test]
6129    fn join_count_two_emits_one_edit_per_join() {
6130        let edits = check_shapes("a\nb\nc\nd", join(0, 2, false));
6131        assert_eq!(edits.len(), 2, "one ContentEdit per join");
6132    }
6133
6134    #[test]
6135    fn join_with_space_inserts_single_space() {
6136        let edits = check_shapes("foo\nbar", join(0, 1, true));
6137        assert_eq!(edits.len(), 1);
6138        let e = &edits[0];
6139        assert_eq!((e.start_byte, e.old_end_byte, e.new_end_byte), (3, 4, 4));
6140        assert_eq!(e.new_end_position, (0, 4));
6141    }
6142
6143    /// `do_join_lines` skips the space when the incoming line is empty.
6144    #[test]
6145    fn join_with_space_next_line_empty_skips_space() {
6146        let edits = check_shapes("foo\n\nbar", join(0, 1, true));
6147        assert_eq!(edits.len(), 1);
6148        assert_eq!(edits[0].new_end_byte, edits[0].start_byte, "no space");
6149    }
6150
6151    /// count=2 with an empty middle line: join 1 inserts no space
6152    /// (suffix empty), join 2 does (both sides non-empty by then).
6153    #[test]
6154    fn join_with_space_count_two_over_empty_line() {
6155        let edits = check_shapes("foo\n\nbar", join(0, 2, true));
6156        assert_eq!(edits.len(), 2);
6157        assert_eq!(edits[0].new_end_byte, edits[0].start_byte);
6158        assert_eq!(edits[1].new_end_byte, edits[1].start_byte + 1);
6159    }
6160
6161    /// `do_join_lines` skips the space when the accumulated line is empty.
6162    #[test]
6163    fn join_with_space_prefix_empty_skips_space() {
6164        let edits = check_shapes("\nfoo", join(0, 1, true));
6165        assert_eq!(edits.len(), 1);
6166        assert_eq!(
6167            (
6168                edits[0].start_byte,
6169                edits[0].old_end_byte,
6170                edits[0].new_end_byte
6171            ),
6172            (0, 1, 0)
6173        );
6174    }
6175
6176    #[test]
6177    fn join_multibyte_lines() {
6178        // "héllo" = 6 bytes; the '\n' sits at byte 6.
6179        let edits = check_shapes("héllo\nwörld", join(0, 1, true));
6180        assert_eq!(edits.len(), 1);
6181        let e = &edits[0];
6182        assert_eq!((e.start_byte, e.old_end_byte, e.new_end_byte), (6, 7, 7));
6183        assert_eq!(e.start_position, (0, 6));
6184        assert_eq!(e.new_end_position, (0, 7));
6185        check_shapes("日本\n語だ\nよ", join(0, 2, false));
6186    }
6187
6188    /// The buffer stops joining when it runs out of rows; the emitted
6189    /// fan-out must stop with it.
6190    #[test]
6191    fn join_count_exceeding_rows_stops_at_last_join() {
6192        let edits = check_shapes("a\nb", join(0, 5, false));
6193        assert_eq!(edits.len(), 1, "only one join is possible");
6194    }
6195
6196    #[test]
6197    fn join_at_last_row_is_noop() {
6198        let edits = check_shapes("a\nb", join(1, 1, false));
6199        assert!(edits.is_empty(), "nothing to join → no ContentEdits");
6200    }
6201
6202    #[test]
6203    fn join_doc_with_trailing_newline() {
6204        // Lines: "foo", "" — joining consumes the trailing '\n'.
6205        let edits = check_shapes("foo\n", join(0, 1, false));
6206        assert_eq!(edits.len(), 1);
6207        assert_eq!(
6208            (
6209                edits[0].start_byte,
6210                edits[0].old_end_byte,
6211                edits[0].new_end_byte
6212            ),
6213            (3, 4, 3)
6214        );
6215    }
6216
6217    // ── Shape 2: linewise DeleteRange ending at the last row ─────
6218
6219    /// `dd` on the last row also removes the '\n' that ends the row
6220    /// above (matching `do_delete_range`), so the edit must start at
6221    /// EOL of row lo-1 and end at the true end of the document.
6222    #[test]
6223    fn linewise_delete_last_row_starts_at_prev_eol() {
6224        let edits = check_shapes("a\nb\nc", del((2, 0), (2, 0), MotionKind::Line));
6225        assert_eq!(edits.len(), 1);
6226        let e = &edits[0];
6227        assert_eq!(
6228            (e.start_byte, e.old_end_byte, e.new_end_byte),
6229            (3, 5, 3),
6230            "real change is [3, 5) → \"\"; got {e:?}"
6231        );
6232        assert_eq!(e.start_position, (1, 1));
6233        assert_eq!(e.old_end_position, (2, 1));
6234        assert_eq!(e.new_end_position, (1, 1));
6235    }
6236
6237    #[test]
6238    fn linewise_delete_multi_row_to_last() {
6239        let edits = check_shapes("a\nb\nc\nd", del((2, 0), (3, 0), MotionKind::Line));
6240        assert_eq!(edits.len(), 1);
6241        assert_eq!(
6242            (edits[0].start_byte, edits[0].old_end_byte),
6243            (3, 7),
6244            "[3, 7) covers \"\\nc\\nd\""
6245        );
6246    }
6247
6248    #[test]
6249    fn linewise_delete_whole_buffer() {
6250        let edits = check_shapes("a\nb\nc", del((0, 0), (2, 0), MotionKind::Line));
6251        assert_eq!(edits.len(), 1);
6252        let e = &edits[0];
6253        assert_eq!((e.start_byte, e.old_end_byte, e.new_end_byte), (0, 5, 0));
6254        assert_eq!(e.start_position, (0, 0));
6255        assert_eq!(e.old_end_position, (2, 1));
6256    }
6257
6258    #[test]
6259    fn linewise_delete_single_line_buffer() {
6260        check_shapes("abc", del((0, 0), (0, 0), MotionKind::Line));
6261    }
6262
6263    /// Regression guard: the not-at-end case was already correct.
6264    #[test]
6265    fn linewise_delete_interior_rows_unchanged() {
6266        let edits = check_shapes("a\nb\nc", del((0, 0), (1, 0), MotionKind::Line));
6267        assert_eq!(edits.len(), 1);
6268        let e = &edits[0];
6269        assert_eq!((e.start_byte, e.old_end_byte, e.new_end_byte), (0, 4, 0));
6270        assert_eq!(e.old_end_position, (2, 0));
6271    }
6272
6273    #[test]
6274    fn linewise_delete_last_row_multibyte() {
6275        // "aé" = 3 bytes, '\n' at 3, "bü" = 3 bytes → doc is 7 bytes.
6276        let edits = check_shapes("aé\nbü", del((1, 0), (1, 0), MotionKind::Line));
6277        assert_eq!(edits.len(), 1);
6278        let e = &edits[0];
6279        assert_eq!((e.start_byte, e.old_end_byte), (3, 7));
6280        assert_eq!(e.start_position, (0, 3));
6281        assert_eq!(e.old_end_position, (1, 3));
6282    }
6283
6284    /// End row past the last row must clamp like the buffer does.
6285    #[test]
6286    fn linewise_delete_end_row_overshoot_clamps() {
6287        check_shapes("a\nb\nc", del((1, 0), (9, 0), MotionKind::Line));
6288    }
6289
6290    /// Deleting the final empty line of a trailing-newline doc.
6291    #[test]
6292    fn linewise_delete_trailing_empty_last_row() {
6293        let edits = check_shapes("a\nb\n", del((2, 0), (2, 0), MotionKind::Line));
6294        assert_eq!(edits.len(), 1);
6295        assert_eq!((edits[0].start_byte, edits[0].old_end_byte), (3, 4));
6296    }
6297
6298    // ── Shape 3: visual-block delete fan-out ─────────────────────
6299
6300    /// Per-row edits carry pre-edit byte offsets, so they are only
6301    /// valid for a sequential consumer when emitted bottom-up.
6302    #[test]
6303    fn block_delete_emits_rows_descending() {
6304        let edits = check_shapes("abc\ndef\nghi", del((0, 0), (2, 1), MotionKind::Block));
6305        assert_eq!(edits.len(), 3);
6306        let rows: Vec<u32> = edits.iter().map(|e| e.start_position.0).collect();
6307        assert_eq!(
6308            rows,
6309            vec![2, 1, 0],
6310            "bottom-up so pre-edit offsets stay valid"
6311        );
6312        assert_eq!(
6313            (edits[0].start_byte, edits[0].old_end_byte),
6314            (8, 10),
6315            "row 2 cols 0..=1"
6316        );
6317    }
6318
6319    #[test]
6320    fn block_delete_multibyte() {
6321        // "éé" = 4 bytes + '\n' → row 1 starts at byte 5.
6322        let edits = check_shapes("éé\nüü", del((0, 0), (1, 0), MotionKind::Block));
6323        assert_eq!(edits.len(), 2);
6324        assert_eq!((edits[0].start_byte, edits[0].old_end_byte), (5, 7));
6325        assert_eq!((edits[1].start_byte, edits[1].old_end_byte), (0, 2));
6326    }
6327
6328    /// Rows shorter than the rectangle contribute nothing (matches
6329    /// `rope_cut_chars` clamping).
6330    #[test]
6331    fn block_delete_ragged_rows() {
6332        let edits = check_shapes("abcd\nx\nabcd", del((0, 1), (2, 2), MotionKind::Block));
6333        assert_eq!(edits.len(), 2, "middle row too short → skipped");
6334    }
6335
6336    /// End row past the last row: the buffer skips those rows; the
6337    /// fan-out must not emit clamped duplicates for them.
6338    #[test]
6339    fn block_delete_end_row_overshoot_clamps() {
6340        let edits = check_shapes("ab\ncd", del((0, 0), (5, 0), MotionKind::Block));
6341        assert_eq!(edits.len(), 2);
6342    }
6343
6344    // ── Shape 4: SplitLines (JoinLines inverse) ──────────────────
6345
6346    /// A single no-space split: the ONLY byte change is a '\n' inserted
6347    /// at the split col — mirrors `join_backspace_at_col0`'s inverse.
6348    #[test]
6349    fn split_single_col_no_space_inserts_newline() {
6350        let edits = check_shapes("foobar", split(0, vec![3], false));
6351        assert_eq!(edits.len(), 1);
6352        let e = &edits[0];
6353        assert_eq!((e.start_byte, e.old_end_byte, e.new_end_byte), (3, 3, 4));
6354        assert_eq!(e.start_position, (0, 3));
6355        assert_eq!(e.new_end_position, (1, 0));
6356    }
6357
6358    /// `inserted_space` REPLACES the space at the split col with '\n' —
6359    /// NOT a pure "\n " insert. `do_split_lines` removes the space then
6360    /// inserts '\n' at the same index: net 1 byte in, 1 byte out.
6361    #[test]
6362    fn split_with_space_replaces_the_space_not_inserts() {
6363        let edits = check_shapes("foo bar", split(0, vec![3], true));
6364        assert_eq!(edits.len(), 1);
6365        let e = &edits[0];
6366        assert_eq!(
6367            (e.start_byte, e.old_end_byte, e.new_end_byte),
6368            (3, 4, 4),
6369            "space at byte 3 replaced by '\\n' — 1 byte in, 1 byte out"
6370        );
6371        assert_eq!(e.new_end_position, (1, 0));
6372    }
6373
6374    /// Multiple splits (inverse of a count>1 join) apply RIGHT-TO-LEFT
6375    /// in the real buffer (`do_split_lines` iterates `cols.iter().rev()`)
6376    /// — same-row ascending pre-edit offsets would be wrong for a
6377    /// sequential consumer.
6378    #[test]
6379    fn split_multi_col_emits_descending() {
6380        // Inverse of joining "a", "b", "c" into "abc": cols = [1, 2].
6381        let edits = check_shapes("abc", split(0, vec![1, 2], false));
6382        assert_eq!(edits.len(), 2);
6383        let cols: Vec<u32> = edits.iter().map(|e| e.start_position.1).collect();
6384        assert_eq!(
6385            cols,
6386            vec![2, 1],
6387            "rightmost split first, matching do_split_lines"
6388        );
6389    }
6390
6391    /// Real round-trip: join then split the SAME buffer via the actual
6392    /// `do_join_lines`-produced inverse, count > 1 with an empty middle
6393    /// line — one join inserts no space (suffix empty), the other does.
6394    /// `check_shapes` cross-validates the SplitLines shape byte-exactly
6395    /// against this exact inverse, not a hand-picked one.
6396    #[test]
6397    fn split_round_trips_real_join_inverse_with_mixed_spaces() {
6398        let mut probe = View::from_str("foo\n\nbar");
6399        let inverse = probe.apply_edit(join(0, 2, true));
6400        let Edit::SplitLines {
6401            row: _,
6402            ref cols,
6403            ref inserted_spaces,
6404        } = inverse
6405        else {
6406            panic!("join's inverse must be SplitLines, got {inverse:?}");
6407        };
6408        assert_eq!(cols.len(), 2, "one recorded col per join");
6409        // First join (empty middle line as suffix) skips the space;
6410        // second join (now both sides non-empty) inserts one — per-col,
6411        // NOT the uniform with_space=true intent (audit-r2 fix 6).
6412        assert_eq!(
6413            inserted_spaces,
6414            &vec![false, true],
6415            "per-join outcome must reflect prefix/suffix emptiness, not just intent"
6416        );
6417        // The join's own inverse, replayed through content_edits_from_buffer_edit
6418        // against the joined ("foo bar") buffer, must byte-exactly reproduce
6419        // splitting it back apart.
6420        check_shapes("foo bar", inverse);
6421    }
6422
6423    /// A col at (or past) the split row's live end after a prior split
6424    /// truncated it: `do_split_lines` skips the space check (guard is
6425    /// `col < lc`) and falls through to a bare '\n' insert.
6426    #[test]
6427    fn split_duplicate_col_past_truncated_row_is_plain_insert() {
6428        let edits = check_shapes("foo bar", split(0, vec![3, 3], true));
6429        assert_eq!(edits.len(), 2);
6430        // First-processed (reverse order) col=3: space replaced by '\n'.
6431        assert_eq!(
6432            (
6433                edits[0].start_byte,
6434                edits[0].old_end_byte,
6435                edits[0].new_end_byte
6436            ),
6437            (3, 4, 4)
6438        );
6439        // Second-processed (also col=3, but now `3 < current_lc(=3)` is
6440        // false): plain '\n' insert, no deletion.
6441        assert_eq!(
6442            (
6443                edits[1].start_byte,
6444                edits[1].old_end_byte,
6445                edits[1].new_end_byte
6446            ),
6447            (3, 3, 4)
6448        );
6449    }
6450
6451    // ── Shape 5: InsertBlock fan-out ──────────────────────────────
6452
6453    /// Per-row edits carry pre-edit byte offsets, so — like block-delete
6454    /// — they are only valid for a sequential consumer when emitted
6455    /// bottom-up.
6456    #[test]
6457    fn insert_block_emits_rows_descending() {
6458        let edits = check_shapes("abc\ndef\nghi", insert_block((0, 1), &["X", "Y", "Z"]));
6459        assert_eq!(edits.len(), 3);
6460        let rows: Vec<u32> = edits.iter().map(|e| e.start_position.0).collect();
6461        assert_eq!(
6462            rows,
6463            vec![2, 1, 0],
6464            "bottom-up so pre-edit offsets stay valid"
6465        );
6466    }
6467
6468    #[test]
6469    fn insert_block_multibyte() {
6470        // "éé" = 4 bytes + '\n' → row 1 starts at byte 5.
6471        let edits = check_shapes("éé\nüü", insert_block((0, 1), &["x", "y"]));
6472        assert_eq!(edits.len(), 2);
6473    }
6474
6475    // ── Shape 6: DeleteBlockChunks fan-out ────────────────────────
6476
6477    #[test]
6478    fn delete_block_chunks_emits_rows_descending() {
6479        let edits = check_shapes("abc\ndef\nghi", delete_block_chunks((0, 0), vec![1, 1, 1]));
6480        assert_eq!(edits.len(), 3);
6481        let rows: Vec<u32> = edits.iter().map(|e| e.start_position.0).collect();
6482        assert_eq!(rows, vec![2, 1, 0]);
6483    }
6484
6485    /// A row too short for the block's column contributes nothing —
6486    /// matches `do_delete_block_chunks`'s per-row clamp.
6487    #[test]
6488    fn delete_block_chunks_ragged_rows_skip_empty() {
6489        let edits = check_shapes("abcd\nx\nabcd", delete_block_chunks((0, 2), vec![1, 1, 1]));
6490        assert_eq!(edits.len(), 2, "middle row too short → skipped");
6491    }
6492
6493    // ── Sanity: shapes that were already correct stay correct ────
6494
6495    #[test]
6496    fn charwise_and_insert_shapes_still_hold() {
6497        check_shapes("héllo wörld", del((0, 2), (0, 7), MotionKind::Char));
6498        check_shapes("a\nb\nc", del((0, 1), (2, 0), MotionKind::Char));
6499        check_shapes(
6500            "abc",
6501            Edit::InsertStr {
6502                at: Position::new(0, 1),
6503                text: "x\ny".to_string(),
6504            },
6505        );
6506        check_shapes(
6507            "abc\ndef",
6508            Edit::Replace {
6509                start: Position::new(0, 1),
6510                end: Position::new(1, 1),
6511                with: "Z\nQ".to_string(),
6512            },
6513        );
6514    }
6515}
6516
6517#[cfg(test)]
6518mod earlier_later_tests {
6519    use super::*;
6520    use crate::types::{DefaultHost, Options};
6521    use hjkl_buffer::View;
6522    use std::time::{Duration, SystemTime};
6523
6524    fn make_ed(content: &str) -> Editor<View, DefaultHost> {
6525        let buf = View::from_str(content);
6526        Editor::new(buf, DefaultHost::default(), Options::default())
6527    }
6528
6529    // ── step-based ───────────────────────────────────────────────────────────
6530
6531    #[test]
6532    fn earlier_by_steps_n_undoes_n_changes() {
6533        let mut ed = make_ed("hello");
6534        ed.push_undo(); // snap 1
6535        ed.push_undo(); // snap 2
6536        ed.push_undo(); // snap 3
6537        assert_eq!(ed.undo_stack_len(), 3);
6538        let applied = ed.earlier_by_steps(2);
6539        assert_eq!(applied, 2);
6540        assert_eq!(ed.undo_stack_len(), 1);
6541    }
6542
6543    #[test]
6544    fn earlier_by_steps_caps_at_stack_size() {
6545        let mut ed = make_ed("hello");
6546        ed.push_undo(); // snap 1
6547        // Ask for 10 but only 1 available.
6548        let applied = ed.earlier_by_steps(10);
6549        assert_eq!(applied, 1);
6550        assert_eq!(ed.undo_stack_len(), 0);
6551    }
6552
6553    #[test]
6554    fn later_by_steps_n_redoes_n_changes() {
6555        let mut ed = make_ed("hello");
6556        ed.push_undo(); // snap 1
6557        ed.push_undo(); // snap 2
6558        ed.push_undo(); // snap 3
6559        // Undo all 3 so they're on redo stack.
6560        ed.earlier_by_steps(3);
6561        assert_eq!(ed.undo_stack_len(), 0);
6562        let applied = ed.later_by_steps(2);
6563        assert_eq!(applied, 2);
6564        assert_eq!(ed.undo_stack_len(), 2);
6565    }
6566
6567    #[test]
6568    fn later_by_steps_caps_at_redo_stack_size() {
6569        let mut ed = make_ed("hello");
6570        ed.push_undo(); // snap 1
6571        ed.earlier_by_steps(1); // moves to redo
6572        let applied = ed.later_by_steps(99);
6573        assert_eq!(applied, 1);
6574    }
6575
6576    // ── time-based ───────────────────────────────────────────────────────────
6577
6578    fn epoch_plus(secs: u64) -> SystemTime {
6579        SystemTime::UNIX_EPOCH + Duration::from_secs(secs)
6580    }
6581
6582    #[test]
6583    fn earlier_by_time_stops_at_target_boundary() {
6584        let mut ed = make_ed("hello");
6585        // Push 3 entries at t-30s, t-20s, t-10s (relative to epoch).
6586        ed.push_undo_at(epoch_plus(30));
6587        ed.push_undo_at(epoch_plus(40));
6588        ed.push_undo_at(epoch_plus(50));
6589        // Redo stack is empty; undo has 3 entries.
6590        // target = epoch+35 → should undo entries at t=50 and t=40, stop at t=30
6591        let target = epoch_plus(35);
6592        let applied = ed.earlier_by_time(target);
6593        assert_eq!(applied, 2, "should undo t=50 and t=40; stop at t=30");
6594        assert_eq!(ed.undo_stack_len(), 1, "t=30 entry remains");
6595    }
6596
6597    #[test]
6598    fn earlier_by_time_empty_stack_returns_zero() {
6599        let mut ed = make_ed("hello");
6600        let applied = ed.earlier_by_time(epoch_plus(999));
6601        assert_eq!(applied, 0);
6602        assert_eq!(ed.undo_stack_len(), 0);
6603    }
6604
6605    #[test]
6606    fn later_by_time_target_in_future_redoes_all() {
6607        let mut ed = make_ed("hello");
6608        ed.push_undo_at(epoch_plus(10));
6609        ed.push_undo_at(epoch_plus(20));
6610        // Undo both → they move to redo stack with their timestamps preserved.
6611        ed.earlier_by_steps(2);
6612        // target far in future: should redo all.
6613        let applied = ed.later_by_time(epoch_plus(9999));
6614        assert_eq!(applied, 2);
6615        assert_eq!(ed.undo_stack_len(), 2);
6616    }
6617}
6618
6619// ─── modifiable / readonly semantics tests ────────────────────────────────────
6620
6621#[cfg(test)]
6622mod shared_registers_tests {
6623    use super::*;
6624    use crate::types::{DefaultHost, Options};
6625    use hjkl_buffer::View;
6626
6627    #[test]
6628    fn shared_register_bank_visible_across_editors() {
6629        let shared =
6630            std::sync::Arc::new(std::sync::Mutex::new(crate::registers::Registers::default()));
6631        let mut a = Editor::new(View::new(), DefaultHost::default(), Options::default());
6632        a.set_registers_arc(shared.clone());
6633        let mut b = Editor::new(View::new(), DefaultHost::default(), Options::default());
6634        b.set_registers_arc(shared.clone());
6635        // Write to editor A's unnamed register
6636        a.with_registers_mut(|r| {
6637            r.unnamed = crate::registers::Slot {
6638                text: "hello".to_string(),
6639                linewise: false,
6640                ..Default::default()
6641            };
6642        });
6643        // Read from editor B — same bank, no copy needed
6644        assert_eq!(b.with_registers(|r| r.unnamed.text.clone()), "hello");
6645    }
6646
6647    /// #279 slice 4: the `linewise` flag on a `Slot` must travel with the
6648    /// shared register bank, not just the text — `do_paste`
6649    /// (hjkl-vim/src/vim/command.rs) sources its linewise decision from the
6650    /// selected register slot precisely so a whole-line yank in one window
6651    /// pastes linewise in a sibling window. This proves the shared `Arc`
6652    /// carries that bit, independent of the per-editor `yank_linewise` bool
6653    /// (which is deliberately NOT shared — see its doc comment).
6654    #[test]
6655    fn shared_register_bank_linewise_visible_across_editors() {
6656        let shared =
6657            std::sync::Arc::new(std::sync::Mutex::new(crate::registers::Registers::default()));
6658        let mut a = Editor::new(View::new(), DefaultHost::default(), Options::default());
6659        a.set_registers_arc(shared.clone());
6660        let mut b = Editor::new(View::new(), DefaultHost::default(), Options::default());
6661        b.set_registers_arc(shared.clone());
6662        // Write a LINEWISE yank to editor A's unnamed register.
6663        a.with_registers_mut(|r| {
6664            r.unnamed = crate::registers::Slot {
6665                text: "hello\n".to_string(),
6666                linewise: true,
6667                ..Default::default()
6668            };
6669        });
6670        // Read from editor B — same bank, so the linewise bit must be
6671        // visible too, not just the text.
6672        assert!(
6673            b.with_registers(|r| r.unnamed.linewise),
6674            "editor B should see editor A's linewise flag through the \
6675             shared register Arc"
6676        );
6677    }
6678
6679    /// `with_registers` / `with_registers_mut` are the only sanctioned way
6680    /// to touch the register bank from outside `editor.rs` (audit item
6681    /// B4) — the lock must stay scoped to the closure, and the closure's
6682    /// return value must plumb through untouched so callers can extract
6683    /// owned data without holding a guard.
6684    #[test]
6685    fn with_registers_round_trip_and_return_value_plumbs_through() {
6686        let ed = Editor::new(View::new(), DefaultHost::default(), Options::default());
6687
6688        // Write path: with_registers_mut mutates in place and returns a
6689        // value derived from the mutation.
6690        let wrote = ed.with_registers_mut(|r| {
6691            r.unnamed = crate::registers::Slot {
6692                text: "round-trip".to_string(),
6693                linewise: false,
6694                ..Default::default()
6695            };
6696            r.unnamed.text.len()
6697        });
6698        assert_eq!(wrote, "round-trip".len());
6699
6700        // Read path: with_registers sees the write and its return value
6701        // is the owned data extracted inside the closure.
6702        let read = ed.with_registers(|r| r.unnamed.text.clone());
6703        assert_eq!(read, "round-trip");
6704    }
6705}
6706
6707// ─── shared global-marks bank tests (#279 slice 1) ────────────────────────────
6708
6709#[cfg(test)]
6710mod shared_global_marks_tests {
6711    use super::*;
6712    use crate::types::{DefaultHost, Options};
6713    use hjkl_buffer::View;
6714
6715    #[test]
6716    fn shared_global_marks_bank_visible_across_editors() {
6717        let shared = std::sync::Arc::new(std::sync::Mutex::new(std::collections::BTreeMap::new()));
6718        let mut a = Editor::new(View::new(), DefaultHost::default(), Options::default());
6719        a.set_global_marks_arc(shared.clone());
6720        let mut b = Editor::new(View::new(), DefaultHost::default(), Options::default());
6721        b.set_global_marks_arc(shared.clone());
6722        // Set a global mark on editor A.
6723        a.set_global_mark('A', 7, (3, 5));
6724        // Read from editor B — same bank, no copy needed.
6725        assert_eq!(b.global_mark('A'), Some((7, 3, 5)));
6726    }
6727
6728    #[test]
6729    fn unshared_global_marks_stay_isolated() {
6730        let mut a = Editor::new(View::new(), DefaultHost::default(), Options::default());
6731        let b = Editor::new(View::new(), DefaultHost::default(), Options::default());
6732        a.set_global_mark('A', 1, (0, 0));
6733        // No shared Arc wired — B must not see A's mark.
6734        assert_eq!(b.global_mark('A'), None);
6735    }
6736}
6737
6738// ─── shared last-substitute bank tests (#279 slice 2) ─────────────────────
6739
6740#[cfg(test)]
6741mod shared_last_substitute_tests {
6742    use super::*;
6743    use crate::types::{DefaultHost, Options};
6744    use hjkl_buffer::View;
6745
6746    fn dummy_cmd(replacement: &str) -> crate::substitute::SubstituteCmd {
6747        crate::substitute::SubstituteCmd {
6748            pattern: Some("foo".to_string()),
6749            replacement: replacement.to_string(),
6750            flags: crate::substitute::SubstFlags::default(),
6751            count: None,
6752        }
6753    }
6754
6755    #[test]
6756    fn shared_last_substitute_bank_visible_across_editors() {
6757        let shared = std::sync::Arc::new(std::sync::Mutex::new(None));
6758        let mut a = Editor::new(View::new(), DefaultHost::default(), Options::default());
6759        a.set_last_substitute_arc(shared.clone());
6760        let mut b = Editor::new(View::new(), DefaultHost::default(), Options::default());
6761        b.set_last_substitute_arc(shared.clone());
6762        // Run `:s` (set the last substitute) on editor A.
6763        a.set_last_substitute(dummy_cmd("bar"));
6764        // Read from editor B — same bank, no copy needed.
6765        assert_eq!(b.last_substitute(), Some(dummy_cmd("bar")));
6766    }
6767
6768    #[test]
6769    fn unshared_last_substitute_stays_isolated() {
6770        let mut a = Editor::new(View::new(), DefaultHost::default(), Options::default());
6771        let b = Editor::new(View::new(), DefaultHost::default(), Options::default());
6772        a.set_last_substitute(dummy_cmd("bar"));
6773        // No shared Arc wired — B must not see A's last substitute.
6774        assert_eq!(b.last_substitute(), None);
6775    }
6776}
6777
6778// ─── shared abbreviations bank tests (#279 slice 3) ───────────────────────
6779
6780#[cfg(test)]
6781mod shared_abbrevs_tests {
6782    use super::*;
6783    use crate::types::{DefaultHost, Options};
6784    use hjkl_buffer::View;
6785
6786    #[test]
6787    fn shared_abbrevs_bank_visible_across_editors() {
6788        let shared = std::sync::Arc::new(std::sync::Mutex::new(Vec::new()));
6789        let mut a = Editor::new(View::new(), DefaultHost::default(), Options::default());
6790        a.set_abbrevs_arc(shared.clone());
6791        let mut b = Editor::new(View::new(), DefaultHost::default(), Options::default());
6792        b.set_abbrevs_arc(shared.clone());
6793        // Define an abbreviation on editor A.
6794        a.add_abbrev("foo", "bar", true, true, false);
6795        // Read from editor B — same bank, no copy needed.
6796        let b_abbrevs = b.abbrevs();
6797        assert_eq!(b_abbrevs.len(), 1);
6798        assert_eq!(b_abbrevs[0].lhs, "foo");
6799        assert_eq!(b_abbrevs[0].rhs, "bar");
6800    }
6801
6802    #[test]
6803    fn unshared_abbrevs_stay_isolated() {
6804        let mut a = Editor::new(View::new(), DefaultHost::default(), Options::default());
6805        let b = Editor::new(View::new(), DefaultHost::default(), Options::default());
6806        a.add_abbrev("foo", "bar", true, true, false);
6807        // No shared Arc wired — B must not see A's abbrev.
6808        assert!(b.abbrevs().is_empty());
6809    }
6810}
6811
6812// ─── shared search bank tests (audit B2) ──────────────────────────────────
6813
6814#[cfg(test)]
6815mod shared_search_tests {
6816    use super::*;
6817    use crate::types::{DefaultHost, Options};
6818    use hjkl_buffer::View;
6819
6820    #[test]
6821    fn shared_search_bank_visible_across_editors() {
6822        let shared = std::sync::Arc::new(std::sync::Mutex::new(SearchBank::default()));
6823        let mut a = Editor::new(View::new(), DefaultHost::default(), Options::default());
6824        a.set_search_arc(shared.clone());
6825        let mut b = Editor::new(View::new(), DefaultHost::default(), Options::default());
6826        b.set_search_arc(shared.clone());
6827        // Commit a search on editor A.
6828        a.set_last_search(Some("foo".to_string()), true);
6829        // Read from editor B — same bank, no copy needed.
6830        assert_eq!(b.last_search(), Some("foo".to_string()));
6831        assert!(b.last_search_forward());
6832    }
6833
6834    #[test]
6835    fn unshared_search_stays_isolated() {
6836        let mut a = Editor::new(View::new(), DefaultHost::default(), Options::default());
6837        let b = Editor::new(View::new(), DefaultHost::default(), Options::default());
6838        a.set_last_search(Some("foo".to_string()), true);
6839        // No shared Arc wired — B must not see A's search.
6840        assert_eq!(b.last_search(), None);
6841    }
6842}
6843
6844// ─── shared change-bank tests (audit B3) ──────────────────────────────────
6845//
6846// Unlike the banks above (one Arc shared by every editor in the app), the
6847// change bank is PER-BUFFER: the app keys one Arc per `buffer_id` and hands
6848// each editor the Arc for its CURRENT buffer. These tests model that at the
6849// `Editor` level — the "keyed by buffer_id" bookkeeping itself lives on the
6850// app (`App::change_bank_for`), which has no unit-test seam here.
6851
6852#[cfg(test)]
6853mod shared_change_bank_tests {
6854    use super::*;
6855    use crate::types::{DefaultHost, Options};
6856    use hjkl_buffer::{Edit, Position, View};
6857
6858    fn editor_with(content: &str) -> Editor<View, DefaultHost> {
6859        let mut e = Editor::new(View::new(), DefaultHost::default(), Options::default());
6860        e.set_content(content);
6861        e
6862    }
6863
6864    /// Move the cursor to `(row, col)` then insert `text` there via the
6865    /// core edit funnel. `mutate_edit` records the dot mark / changelist
6866    /// entry from the LIVE cursor position (matching real FSM edits, which
6867    /// always type at the cursor) — not from the `Edit`'s `at` field — so
6868    /// the cursor must be positioned first.
6869    fn record_insert(e: &mut Editor<View, DefaultHost>, row: usize, col: usize, text: &str) {
6870        e.jump_cursor(row, col);
6871        e.mutate_edit(Edit::InsertStr {
6872            at: Position::new(row, col),
6873            text: text.to_string(),
6874        });
6875    }
6876
6877    /// (1) Two editors wired to the same buffer's bank share a changelist —
6878    /// an edit recorded via A is visible to B's `last_edit_pos` / `change_list`.
6879    #[test]
6880    fn shared_change_bank_visible_across_editors_on_same_buffer() {
6881        let shared = std::sync::Arc::new(std::sync::Mutex::new(ChangeBank::default()));
6882        let mut a = editor_with("alpha\nbeta\ngamma\n");
6883        a.set_change_bank_arc(shared.clone());
6884        let mut b = editor_with("alpha\nbeta\ngamma\n");
6885        b.set_change_bank_arc(shared.clone());
6886
6887        // Edit via editor A (e.g. window A on a `:split`).
6888        record_insert(&mut a, 1, 0, "X");
6889
6890        // Editor B (a sibling window on the SAME buffer) must see A's edit
6891        // in both the dot mark and the changelist ring. Both record the
6892        // PRE-edit cursor position — (1, 0), where `record_insert` placed
6893        // the cursor before inserting "X" — matching vim's `g;` landing on
6894        // the start of a change, not one past it (verified against real
6895        // nvim; see the `mutate_edit` comment at the changelist push site).
6896        assert_eq!(b.last_edit_pos(), Some((1, 0)));
6897        let (list, _) = b.change_list();
6898        assert_eq!(list, vec![(1, 0)]);
6899    }
6900
6901    /// (2) NEGATIVE — two editors on DIFFERENT buffers (independent banks,
6902    /// as if on different buffer_ids) must stay isolated.
6903    #[test]
6904    fn unshared_change_banks_on_different_buffers_stay_isolated() {
6905        let mut a = editor_with("alpha\nbeta\ngamma\n");
6906        let b = editor_with("alpha\nbeta\ngamma\n");
6907        // No Arc shared — each editor keeps its own default bank, exactly
6908        // as if `a` and `b` were windows on two different buffer_ids.
6909        record_insert(&mut a, 1, 0, "X");
6910
6911        assert_eq!(a.last_edit_pos(), Some((1, 0)));
6912        assert_eq!(
6913            b.last_edit_pos(),
6914            None,
6915            "different buffer must not see A's edit"
6916        );
6917        let (b_list, _) = b.change_list();
6918        assert!(b_list.is_empty());
6919    }
6920
6921    /// (3) An editor switched from buffer X's bank to buffer Y's bank picks
6922    /// up Y's changelist — and X's bank is left untouched by the switch.
6923    #[test]
6924    fn switching_buffers_swaps_to_the_new_buffers_bank() {
6925        let bank_x = std::sync::Arc::new(std::sync::Mutex::new(ChangeBank::default()));
6926        let bank_y = std::sync::Arc::new(std::sync::Mutex::new(ChangeBank::default()));
6927
6928        let mut ed = editor_with("alpha\nbeta\ngamma\n");
6929        ed.set_change_bank_arc(bank_x.clone());
6930        record_insert(&mut ed, 0, 0, "X");
6931        assert_eq!(ed.last_edit_pos(), Some((0, 0)));
6932
6933        // Simulate the app retargeting this window's editor onto a
6934        // different buffer (e.g. `:e other.txt` in that window).
6935        ed.set_change_bank_arc(bank_y.clone());
6936
6937        // The editor now sees Y's (empty) bank, not X's edit.
6938        assert_eq!(
6939            ed.last_edit_pos(),
6940            None,
6941            "after switching buffers the editor must see the NEW buffer's bank"
6942        );
6943        let (list, _) = ed.change_list();
6944        assert!(list.is_empty());
6945
6946        // X's bank is untouched by the switch — a sibling window still on
6947        // buffer X (if any) would still see the edit.
6948        assert_eq!(bank_x.lock().unwrap().last_edit, Some((0, 0)));
6949    }
6950}
6951
6952#[cfg(test)]
6953mod scroll_anim_tests {
6954    use super::*;
6955    use crate::types::{DefaultHost, Host, Options};
6956    use hjkl_buffer::View;
6957
6958    fn make_editor_with_content(content: &str) -> Editor<View, DefaultHost> {
6959        let mut buf = View::new();
6960        crate::types::BufferEdit::replace_all(&mut buf, content);
6961        let host = DefaultHost::new();
6962        Editor::new(buf, host, Options::default())
6963    }
6964
6965    #[test]
6966    fn scroll_duration_default_is_zero() {
6967        let buf = View::new();
6968        let host = DefaultHost::new();
6969        let ed = Editor::new(buf, host, Options::default());
6970        assert_eq!(ed.settings().scroll_duration_ms, 0);
6971    }
6972
6973    #[test]
6974    fn take_scroll_anim_hint_false_initially() {
6975        let buf = View::new();
6976        let host = DefaultHost::new();
6977        let mut ed = Editor::new(buf, host, Options::default());
6978        assert!(!ed.take_scroll_anim_hint());
6979    }
6980
6981    #[test]
6982    fn take_scroll_anim_hint_one_shot() {
6983        // Half-page scroll sets the hint; second drain clears it.
6984        let content: String = (0..50).map(|i| format!("line {i}\n")).collect();
6985        let mut ed = make_editor_with_content(&content);
6986        // Set viewport height so scroll actually moves
6987        ed.host_mut().viewport_mut().height = 20;
6988        ed.host_mut().viewport_mut().width = 80;
6989        ed.host_mut().viewport_mut().text_width = 80;
6990        ed.scroll_half_page(crate::types::ScrollDir::Down, 1);
6991        assert!(
6992            ed.take_scroll_anim_hint(),
6993            "hint should be set after half-page"
6994        );
6995        assert!(
6996            !ed.take_scroll_anim_hint(),
6997            "hint should be cleared on second drain"
6998        );
6999    }
7000
7001    #[test]
7002    fn line_scroll_does_not_set_hint() {
7003        let content: String = (0..50).map(|i| format!("line {i}\n")).collect();
7004        let mut ed = make_editor_with_content(&content);
7005        ed.host_mut().viewport_mut().height = 20;
7006        ed.host_mut().viewport_mut().width = 80;
7007        ed.host_mut().viewport_mut().text_width = 80;
7008        ed.scroll_line(crate::types::ScrollDir::Down, 1);
7009        assert!(
7010            !ed.take_scroll_anim_hint(),
7011            "hint must NOT be set for C-e/C-y"
7012        );
7013    }
7014}
7015
7016// ── UndoGranularity unit tests ───────────────────────────────────────────────
7017//
7018// These tests prove the critical invariant: vim (InsertSession) is byte-
7019// identical before and after this feature; Word granularity splits undo at
7020// word boundaries.
7021
7022#[cfg(test)]
7023mod undo_group_tests {
7024    use super::*;
7025    use crate::types::{DefaultHost, Options};
7026    use hjkl_buffer::{Edit, Position, View};
7027
7028    fn make_ed(content: &str) -> Editor<View, DefaultHost> {
7029        let buf = View::from_str(content);
7030        Editor::new(buf, DefaultHost::default(), Options::default())
7031    }
7032
7033    fn insert_x(ed: &mut Editor<View, DefaultHost>, row: usize) {
7034        ed.mutate_edit(Edit::InsertStr {
7035            at: Position::new(row, 0),
7036            text: "X".to_string(),
7037        });
7038    }
7039
7040    fn line0(ed: &Editor<View, DefaultHost>) -> String {
7041        hjkl_buffer::rope_line_str(&ed.buffer().rope(), 0)
7042    }
7043
7044    /// depth == 0: `push_undo` behaves exactly as before — every call snapshots
7045    /// (no coalescing), even with no intervening mutation.
7046    #[test]
7047    fn depth_zero_push_undo_is_unchanged() {
7048        let mut ed = make_ed("hello");
7049        ed.push_undo();
7050        ed.push_undo();
7051        ed.push_undo();
7052        assert_eq!(ed.undo_stack_len(), 3, "no coalescing outside a group");
7053    }
7054
7055    /// A group with one real mutation records exactly ONE entry, and a single
7056    /// undo reverts it.
7057    #[test]
7058    fn group_single_edit_is_one_entry() {
7059        let mut ed = make_ed("hello");
7060        {
7061            let _g = ed.undo_group();
7062            ed.push_undo();
7063            insert_x(&mut ed, 0);
7064        }
7065        assert_eq!(ed.undo_stack_len(), 1);
7066        assert_eq!(line0(&ed), "Xhello");
7067        ed.undo();
7068        assert_eq!(line0(&ed), "hello");
7069        assert_eq!(ed.undo_stack_len(), 0);
7070    }
7071
7072    /// Many `push_undo` + many edits inside one group still collapse to ONE
7073    /// entry, and one undo reverts the whole batch.
7074    #[test]
7075    fn group_coalesces_many_edits_into_one() {
7076        let mut ed = make_ed("hello");
7077        {
7078            let _g = ed.undo_group();
7079            for _ in 0..5 {
7080                ed.push_undo();
7081                insert_x(&mut ed, 0);
7082            }
7083        }
7084        assert_eq!(ed.undo_stack_len(), 1);
7085        assert_eq!(line0(&ed), "XXXXXhello");
7086        ed.undo();
7087        assert_eq!(line0(&ed), "hello", "one undo reverts every grouped edit");
7088    }
7089
7090    /// A group that pushes an undo but mutates nothing leaves ZERO entries.
7091    #[test]
7092    fn no_op_group_leaves_zero_entries() {
7093        let mut ed = make_ed("hello");
7094        {
7095            let _g = ed.undo_group();
7096            ed.push_undo();
7097            // no mutation
7098        }
7099        assert_eq!(
7100            ed.undo_stack_len(),
7101            0,
7102            "an unmutated group must discard its armed snapshot"
7103        );
7104    }
7105
7106    /// A completely empty group (no push_undo at all) leaves ZERO entries.
7107    #[test]
7108    fn empty_group_leaves_zero_entries() {
7109        let mut ed = make_ed("hello");
7110        {
7111            let _g = ed.undo_group();
7112        }
7113        assert_eq!(ed.undo_stack_len(), 0);
7114    }
7115
7116    /// Nested groups: only the OUTERMOST close commits; the inner guard drop
7117    /// does not, so the whole thing is one entry.
7118    #[test]
7119    fn nested_groups_commit_only_at_outermost() {
7120        let mut ed = make_ed("hello");
7121        {
7122            let _outer = ed.undo_group();
7123            ed.push_undo();
7124            insert_x(&mut ed, 0);
7125            {
7126                let _inner = ed.undo_group();
7127                ed.push_undo();
7128                insert_x(&mut ed, 0);
7129                // inner drops here: depth 2 -> 1, NOT committed yet.
7130            }
7131            assert_eq!(
7132                ed.undo_stack_len(),
7133                1,
7134                "inner close must not commit while the outer group is open"
7135            );
7136            insert_x(&mut ed, 0);
7137        }
7138        assert_eq!(
7139            ed.undo_stack_len(),
7140            1,
7141            "outer close commits the single entry"
7142        );
7143        assert_eq!(line0(&ed), "XXXhello");
7144        ed.undo();
7145        assert_eq!(line0(&ed), "hello");
7146    }
7147
7148    /// A group commits ONE entry that does not clobber a pre-existing entry:
7149    /// after a prior depth-0 change, a grouped change adds exactly one more.
7150    #[test]
7151    fn group_adds_single_entry_over_prior_history() {
7152        let mut ed = make_ed("hello");
7153        // Prior standalone change (depth 0).
7154        ed.push_undo();
7155        insert_x(&mut ed, 0);
7156        assert_eq!(ed.undo_stack_len(), 1);
7157        // Grouped change.
7158        {
7159            let _g = ed.undo_group();
7160            ed.push_undo();
7161            insert_x(&mut ed, 0);
7162            ed.push_undo();
7163            insert_x(&mut ed, 0);
7164        }
7165        assert_eq!(ed.undo_stack_len(), 2, "group adds exactly one entry");
7166        assert_eq!(line0(&ed), "XXXhello");
7167        ed.undo();
7168        assert_eq!(
7169            line0(&ed),
7170            "Xhello",
7171            "one undo reverts only the grouped edits"
7172        );
7173        ed.undo();
7174        assert_eq!(line0(&ed), "hello");
7175    }
7176}
7177
7178// ---- Settings ↔ Options conversion tests ----------------------------------
7179//
7180// `Settings::to_options` used to map ~20 fields and backfill the rest with
7181// `..Options::default()`, while `Settings::apply_options` wrote (nearly) all of
7182// them. Read-modify-apply callers (`Editor::current_options()` → tweak one
7183// field → `Editor::apply_options()`, e.g. the nvim-API `set_lines` modeline
7184// overlay) therefore silently reset every unmapped option to its SPEC default.
7185// These tests pin the seam shut.
7186
7187#[cfg(test)]
7188mod options_conversion_tests {
7189    use super::*;
7190    use crate::types::{
7191        DefaultHost, DiagInlineMode, FoldMethod, ListChars, Options, SignColumnMode, WrapMode,
7192    };
7193    use hjkl_buffer::View;
7194
7195    /// An `Options` value in which EVERY field differs from
7196    /// `Options::default()`, so a lossy conversion cannot hide behind a
7197    /// coincidentally-matching default.
7198    fn all_non_default_options() -> Options {
7199        let o = Options {
7200            tabstop: 7,
7201            shiftwidth: 3,
7202            expandtab: false,
7203            softtabstop: 2,
7204            iskeyword: "@,_,45".to_string(),
7205            ignorecase: false,
7206            smartcase: false,
7207            hlsearch: false,
7208            incsearch: false,
7209            wrapscan: false,
7210            autoindent: false,
7211            smartindent: false,
7212            timeout_len: core::time::Duration::from_millis(250),
7213            undo_levels: 42,
7214            undo_break_on_motion: false,
7215            readonly: true,
7216            modifiable: false,
7217            wrap: WrapMode::Word,
7218            textwidth: 100,
7219            number: false,
7220            relativenumber: true,
7221            numberwidth: 9,
7222            cursorline: true,
7223            cursorcolumn: false,
7224            signcolumn: SignColumnMode::Yes,
7225            foldcolumn: 3,
7226            foldmethod: FoldMethod::Marker,
7227            foldenable: false,
7228            foldlevelstart: 0,
7229            foldmarker: "<<<,>>>".to_string(),
7230            colorcolumn: "80,120".to_string(),
7231            formatoptions: "r".to_string(),
7232            filetype: "rust".to_string(),
7233            scrolloff: 11,
7234            sidescrolloff: 13,
7235            modeline: false,
7236            modelines: 8,
7237            autoreload: false,
7238            motion_sneak: false,
7239            list: true,
7240            listchars: ListChars {
7241                tab_lead: '»',
7242                tab_fill: None,
7243                space: Some('␣'),
7244                trail: Some('·'),
7245                eol: Some('¬'),
7246                nbsp: Some('⍽'),
7247                extends: Some('>'),
7248                precedes: Some('<'),
7249            },
7250            indent_guides: false,
7251            indent_guide_char: '|',
7252            colorizer: false,
7253            colorizer_filetypes: vec!["zig".to_string()],
7254            format_on_save: false,
7255            trim_trailing_whitespace: true,
7256            rainbow_brackets: false,
7257            updatetime: 250,
7258            matchparen: false,
7259            fixendofline: false,
7260        };
7261        // Guard the guard: if a future field lands with a value that happens to
7262        // equal the default, this literal stops proving anything for it.
7263        let d = Options::default();
7264        assert_ne!(o, d, "fixture must differ from Options::default()");
7265        o
7266    }
7267
7268    /// `apply_options` then `current_options` must be the IDENTITY on every
7269    /// field the engine stores. Fails today for `number`, `cursorline`,
7270    /// `signcolumn`, the fold options, `listchars`, `colorizer*`, … — the
7271    /// whole set `to_options` used to backfill from the default.
7272    #[test]
7273    fn settings_options_round_trip_is_identity() {
7274        let mut ed = Editor::new(View::new(), DefaultHost::new(), Options::default());
7275        let want = all_non_default_options();
7276        ed.apply_options(&want);
7277
7278        let got = ed.current_options();
7279        assert_eq!(
7280            got, want,
7281            "current_options() must echo apply_options() field-for-field"
7282        );
7283    }
7284
7285    /// A second pass must not drift: `apply(current())` is a fixed point.
7286    #[test]
7287    fn round_trip_is_idempotent() {
7288        let mut ed = Editor::new(View::new(), DefaultHost::new(), Options::default());
7289        ed.apply_options(&all_non_default_options());
7290        let first = ed.current_options();
7291        ed.apply_options(&first);
7292        assert_eq!(ed.current_options(), first);
7293    }
7294
7295    /// `hlsearch`, `incsearch`, `modeline` and `modelines` used to have no
7296    /// `Settings` storage, so `to_options` echoed the SPEC default and a
7297    /// caller could not move them. They are real fields now — this pins the
7298    /// direction of that change, so a regression that drops the storage again
7299    /// shows up as "echoed the default" rather than silently ignoring `:set`.
7300    #[test]
7301    fn search_and_modeline_options_round_trip_through_settings() {
7302        let mut ed = Editor::new(View::new(), DefaultHost::new(), Options::default());
7303        let want = all_non_default_options();
7304        ed.apply_options(&want);
7305        let got = ed.current_options();
7306        assert_eq!(got.hlsearch, want.hlsearch);
7307        assert_eq!(got.incsearch, want.incsearch);
7308        assert_eq!(got.modeline, want.modeline);
7309        assert_eq!(got.modelines, want.modelines);
7310        // …and they must differ from the SPEC default, or the assertions
7311        // above would pass on a `to_options` that still echoed it.
7312        let d = Options::default();
7313        assert_ne!(want.hlsearch, d.hlsearch);
7314        assert_ne!(want.incsearch, d.incsearch);
7315        assert_ne!(want.modeline, d.modeline);
7316        assert_ne!(want.modelines, d.modelines);
7317    }
7318
7319    /// `Settings::default()` and `Options::default()` must agree on every
7320    /// shared field. They used to disagree on `cursorline` (`Settings` said
7321    /// `false`, `Options` said `true`), so which default a session saw
7322    /// depended on whether it was built via `Editor::new(.., Options)` or via
7323    /// `Settings::default()` + `apply_options`.
7324    #[test]
7325    fn settings_default_matches_options_default() {
7326        let from_settings = Settings::default().to_options();
7327        let spec = Options::default();
7328        assert_eq!(
7329            from_settings, spec,
7330            "Settings::default() and Options::default() must not diverge"
7331        );
7332    }
7333
7334    /// The cursor-highlight pair is a deliberate hjkl divergence from vim:
7335    /// `cursorline` on, `cursorcolumn` off. What this test really guards is
7336    /// that the two sides agree — they disagreed once and the `Options` side
7337    /// silently won in a fresh session, so a fresh buffer showed a setting
7338    /// `:set cursorline?` denied.
7339    #[test]
7340    fn cursor_highlight_defaults_agree_on_both_sides() {
7341        assert!(Settings::default().cursorline);
7342        assert!(Options::default().cursorline);
7343        assert!(!Settings::default().cursorcolumn);
7344        assert!(!Options::default().cursorcolumn);
7345    }
7346
7347    /// `settings_from_options` (the `Editor::new` path) must agree with
7348    /// `apply_options` (the overlay path) for every field they share — the
7349    /// third hand-written conversion of the same shape.
7350    #[test]
7351    fn settings_from_options_agrees_with_apply_options() {
7352        let opts = all_non_default_options();
7353        let ctor = settings_from_options(&opts);
7354        let mut overlay = Settings::default();
7355        overlay.apply_options(&opts);
7356        assert_eq!(ctor.to_options(), overlay.to_options());
7357    }
7358
7359    /// The `WrapMode` ↔ `hjkl_buffer::Wrap` helpers are mutual inverses.
7360    #[test]
7361    fn wrap_helpers_round_trip() {
7362        for m in [WrapMode::None, WrapMode::Char, WrapMode::Word] {
7363            assert_eq!(wrap_to_mode(wrap_from_mode(m)), m);
7364        }
7365        for w in [
7366            hjkl_buffer::Wrap::None,
7367            hjkl_buffer::Wrap::Char,
7368            hjkl_buffer::Wrap::Word,
7369        ] {
7370            assert_eq!(wrap_from_mode(wrap_to_mode(w)), w);
7371        }
7372    }
7373
7374    /// Regression for the nvim-API seam (`nvim_api.rs` `set_lines`): a
7375    /// read-modify-apply cycle that touches ONE option must leave every other
7376    /// live option alone. Reproduced against the engine directly — the
7377    /// nvim-API path has no in-process harness.
7378    #[test]
7379    fn read_modify_apply_preserves_unrelated_options() {
7380        let mut ed = Editor::new(View::new(), DefaultHost::new(), Options::default());
7381        // A session that has diverged from the defaults (`:set` writes
7382        // `Settings` directly, so mirror that).
7383        ed.settings_mut().cursorline = true;
7384        ed.settings_mut().number = false;
7385        ed.settings_mut().filetype = "rust".to_string();
7386        ed.settings_mut().foldenable = false;
7387        ed.settings_mut().signcolumn = SignColumnMode::No;
7388        ed.settings_mut().diagnostics_inline = DiagInlineMode::Off;
7389
7390        // The seam: read, change one field, write back.
7391        let mut opts = ed.current_options();
7392        opts.tabstop = 2;
7393        ed.apply_options(&opts);
7394
7395        assert_eq!(ed.settings().tabstop, 2, "the edited field must land");
7396        assert!(ed.settings().cursorline, "cursorline must survive");
7397        assert!(!ed.settings().number, "number must survive");
7398        assert_eq!(ed.settings().filetype, "rust", "filetype must survive");
7399        assert!(!ed.settings().foldenable, "foldenable must survive");
7400        assert_eq!(ed.settings().signcolumn, SignColumnMode::No);
7401        // `Settings`-only field: not in `Options` at all, so untouched.
7402        assert_eq!(ed.settings().diagnostics_inline, DiagInlineMode::Off);
7403    }
7404}
7405
7406// ---- Wrapped-scrolloff tests (incremental screen-row walk) --------------
7407//
7408// `ensure_scrolloff_vertical` computes the cursor's screen row ONCE and
7409// adjusts it per dropped/added visible row instead of re-running
7410// `cursor_screen_row_from` (itself O(distance)) per candidate `top_row`.
7411// These tests pin the behavior the incremental walk must preserve — they
7412// pass on the old O(n²) loop and must keep passing on the rewrite.
7413
7414#[cfg(test)]
7415mod scrolloff_wrap_tests {
7416    use super::*;
7417    use crate::types::{DefaultHost, Host, Options};
7418    use hjkl_buffer::{Position, View, Wrap};
7419    use std::sync::Arc;
7420
7421    /// Editor over a wrapped buffer with the viewport + scrolloff set up so
7422    /// `ensure_cursor_in_scrolloff` dispatches to the screen-row walk
7423    /// (`wrap != Wrap::None`, `viewport_height > 0`).
7424    fn wrapped_editor(
7425        content: &str,
7426        height: u16,
7427        width: u16,
7428        scrolloff: usize,
7429    ) -> Editor<View, DefaultHost> {
7430        let mut ed = Editor::new(
7431            View::from_str(content),
7432            DefaultHost::default(),
7433            Options::default(),
7434        );
7435        ed.set_viewport_height(height);
7436        let vp = ed.host_mut().viewport_mut();
7437        vp.width = width;
7438        vp.height = height;
7439        vp.text_width = width;
7440        vp.wrap = Wrap::Char;
7441        ed.settings_mut().scrolloff = scrolloff;
7442        ed
7443    }
7444
7445    /// Cursor's screen row from the current `top_row`, through the same
7446    /// fold provider the scrolloff walk uses.
7447    fn csr(ed: &Editor<View, DefaultHost>) -> usize {
7448        let folds = crate::buffer_impl::BufferFoldProvider::new(ed.buffer());
7449        crate::viewport_math::cursor_screen_row_from(
7450            ed.buffer(),
7451            &folds,
7452            ed.host().viewport(),
7453            ed.host().viewport().top_row,
7454        )
7455        .unwrap_or(0)
7456    }
7457
7458    /// `n` doc rows × 30 chars — at text_width 10 each row wraps to exactly
7459    /// 3 screen rows.
7460    fn wrapped_rows(n: usize) -> String {
7461        let mut content = String::new();
7462        for _ in 0..n {
7463            content.push_str(&"x".repeat(30));
7464            content.push('\n');
7465        }
7466        content.pop();
7467        content
7468    }
7469
7470    /// Step 2 regression: a big wrapped jump (`G`) must push `top_row`
7471    /// forward one visible doc row at a time until the cursor's screen row
7472    /// enters the bottom margin. The old loop recomputed the screen row per
7473    /// candidate top; the incremental walk must land on the same `top_row`.
7474    /// 30 rows × 3 screen rows = 90; height 9 with scrolloff 2 keeps the
7475    /// cursor's screen row in [2, 6], i.e. `top_row` 17 for row 19. The
7476    /// cursor is NOT on the last row, so `max_top_for_height` (27) cannot
7477    /// mask a walk that overshoots: a broken subtraction lands above 17 and
7478    /// stays there.
7479    #[test]
7480    fn big_wrapped_jump_lands_in_bottom_margin() {
7481        let content = wrapped_rows(30);
7482        let mut ed = wrapped_editor(&content, 9, 10, 2);
7483        ed.jump_cursor(19, 0);
7484        ed.ensure_cursor_in_scrolloff();
7485        assert_eq!(ed.host().viewport().top_row, 17);
7486        assert!(
7487            (2..=6).contains(&csr(&ed)),
7488            "cursor screen row {} outside [2, 6]",
7489            csr(&ed)
7490        );
7491    }
7492
7493    /// Step 3 regression: with the cursor at the very top of the window
7494    /// (screen row 0 < margin), the backward walk must pull `top_row` up
7495    /// one visible row at a time — each row added to the top of the window
7496    /// adds its own wrap height back to the cursor's screen row. Cursor on
7497    /// row 8 of a 30-row buffer with top 8: one pull-back lands on 7
7498    /// (screen row 3), far below `max_top_for_height` (27) so the bottom
7499    /// clamp cannot mask a broken walk.
7500    #[test]
7501    fn cursor_at_top_of_window_pulls_top_back_to_margin() {
7502        let content = wrapped_rows(30);
7503        let mut ed = wrapped_editor(&content, 9, 10, 2);
7504        ed.jump_cursor(8, 0);
7505        ed.host_mut().viewport_mut().top_row = 8; // cursor at screen row 0
7506        ed.ensure_cursor_in_scrolloff();
7507        assert_eq!(ed.host().viewport().top_row, 7);
7508        assert!(
7509            (2..=6).contains(&csr(&ed)),
7510            "cursor screen row {} outside [2, 6]",
7511            csr(&ed)
7512        );
7513    }
7514
7515    /// Fold handling: a closed fold hides its body rows from the walk —
7516    /// `next_visible_row` jumps over them, and dropped rows only contribute
7517    /// their wrap height when visible. 12 rows × 30 chars, fold hiding
7518    /// rows 5..=6; cursor on row 10 (not the last row, so the bottom clamp
7519    /// at `max_top_for_height` = 9 does not mask the walk). Step 2 drops
7520    /// rows 0..3, then jumps 4 → 7 over the fold body (only row 4's 3
7521    /// screen rows subtracted), then 7 → 8: top 8, screen row 6.
7522    #[test]
7523    fn wrapped_scrolloff_skips_closed_fold_body() {
7524        let content = wrapped_rows(12);
7525        let mut ed = wrapped_editor(&content, 9, 10, 2);
7526        ed.buffer_mut().add_fold(4, 6, true);
7527        ed.jump_cursor(10, 0);
7528        ed.ensure_cursor_in_scrolloff();
7529        assert_eq!(ed.host().viewport().top_row, 8);
7530    }
7531
7532    /// A stale per-window cursor past EOF (another view shrank the shared
7533    /// content) makes `cursor_screen_row_from` return None. The walk must
7534    /// treat that as screen row 0 — step 2 no-ops, step 3 pulls `top_row`
7535    /// back until the cursor's screen row reaches the top margin — and must
7536    /// not panic.
7537    #[test]
7538    fn stale_cursor_past_eof_does_not_advance_or_panic() {
7539        let seed = View::from_str("a\nb\nc\nd\ne\nf\ng");
7540        let arc = seed.content_arc();
7541        let mut view_b = View::new_view(Arc::clone(&arc));
7542        view_b.set_cursor(Position::new(6, 0));
7543        // A sibling view shrinks the shared document; view_b's cursor row 6
7544        // is now past EOF.
7545        let mut view_a = View::new_view(Arc::clone(&arc));
7546        view_a.replace_all("a\nb\nc");
7547        let mut ed = Editor::new(view_b, DefaultHost::default(), Options::default());
7548        ed.set_viewport_height(5);
7549        let vp = ed.host_mut().viewport_mut();
7550        vp.width = 10;
7551        vp.height = 5;
7552        vp.text_width = 10;
7553        vp.wrap = Wrap::Char;
7554        vp.top_row = 50;
7555        ed.settings_mut().scrolloff = 2;
7556        ed.ensure_cursor_in_scrolloff(); // must not panic
7557        assert_eq!(ed.host().viewport().top_row, 0);
7558        assert_eq!(csr(&ed), 2);
7559    }
7560}