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.push_buffer_content_to_textarea();
2777 self.mark_content_dirty();
2778 inverse
2779 }
2780
2781 /// Migrate user marks + jumplist entries when an edit at row
2782 /// `edit_start` changes the buffer's row count by `delta` (positive
2783 /// for inserts, negative for deletes). Marks tied to a deleted row
2784 /// are dropped; marks past the affected band shift by `delta`.
2785 ///
2786 /// `pub(crate)` so the substitute applicator (`substitute.rs`) can rebase
2787 /// positions after its whole-content `replace_all`, which — unlike this
2788 /// method's `mutate_edit` caller — never reaches here on its own.
2789 pub(crate) fn shift_marks_after_edit(&mut self, edit_start: usize, delta: isize) {
2790 if delta == 0 {
2791 return;
2792 }
2793 // Deleted-row band (only meaningful for delta < 0). Inclusive
2794 // start, exclusive end.
2795 let drop_end = if delta < 0 {
2796 edit_start.saturating_add((-delta) as usize)
2797 } else {
2798 edit_start
2799 };
2800 let shift_threshold = drop_end.max(edit_start.saturating_add(1));
2801
2802 self.buffer
2803 .rebase_marks(edit_start, drop_end, shift_threshold, delta);
2804
2805 // Manual folds (`zf`) are row-ranges living on the same shared
2806 // buffer as marks; without this shift a fold below/above an edit
2807 // keeps stale row numbers forever (#audit-r2 fix 1). `delta != 0`
2808 // here means `mutate_edit` skipped its cursor-band `Invalidate`
2809 // (that only fires for same-row-count edits), so every surviving
2810 // fold reaches this call and is shifted/clipped/grown/shrunk
2811 // (or dropped, if the edit's deleted band fully consumed it) by
2812 // `rebase_folds` precisely instead of just vanishing.
2813 self.buffer
2814 .rebase_folds(edit_start, drop_end, shift_threshold, delta);
2815
2816 // Shift global marks that belong to the current buffer.
2817 let cur_bid = self.current_buffer_id;
2818 let mut global_marks = self.global_marks.lock().unwrap();
2819 let mut global_to_drop: Vec<char> = Vec::new();
2820 for (c, (bid, row, _col)) in global_marks.iter_mut() {
2821 if *bid != cur_bid {
2822 continue;
2823 }
2824 if (edit_start..drop_end).contains(row) {
2825 global_to_drop.push(*c);
2826 } else if *row >= shift_threshold {
2827 *row = ((*row as isize) + delta).max(0) as usize;
2828 }
2829 }
2830 for c in global_to_drop {
2831 global_marks.remove(&c);
2832 }
2833 drop(global_marks);
2834
2835 let shift_jumps = |entries: &mut Vec<(usize, usize)>| {
2836 entries.retain(|(row, _)| !(edit_start..drop_end).contains(row));
2837 for (row, _) in entries.iter_mut() {
2838 if *row >= shift_threshold {
2839 *row = ((*row as isize) + delta).max(0) as usize;
2840 }
2841 }
2842 };
2843 shift_jumps(&mut self.jump_back);
2844 shift_jumps(&mut self.jump_fwd);
2845 }
2846
2847 /// Reverse-sync helper paired with [`Editor::mutate_edit`]: rebuild
2848 /// the textarea from the buffer's lines + cursor, preserving yank
2849 /// text. Heavy (allocates a fresh `TextArea`) but correct; the
2850 /// textarea field disappears at the end of Phase 7f anyway.
2851 /// No-op since View is the content authority. Retained as a
2852 /// shim so call sites in `mutate_edit` and friends don't have to
2853 /// be ripped in lockstep with the field removal.
2854 pub(crate) fn push_buffer_content_to_textarea(&mut self) {}
2855
2856 /// Single choke-point for "the buffer just changed". Sets the
2857 /// dirty flag and drops the cached `content_arc` snapshot so
2858 /// subsequent reads rebuild from the live textarea. Callers
2859 /// mutating `textarea` directly (e.g. the TUI's bracketed-paste
2860 /// path) must invoke this to keep the cache honest.
2861 pub fn mark_content_dirty(&mut self) {
2862 self.buffer.mark_content_dirty();
2863 }
2864
2865 /// Returns true if content changed since the last call, then clears the flag.
2866 pub fn take_dirty(&mut self) -> bool {
2867 self.buffer.take_dirty()
2868 }
2869
2870 /// Drain the one-shot smooth-scroll hint (#195). True if the last step ran
2871 /// a page/recenter motion the app may animate.
2872 pub fn take_scroll_anim_hint(&mut self) -> bool {
2873 let h = self.scroll_anim_hint;
2874 self.scroll_anim_hint = false;
2875 h
2876 }
2877
2878 // ── Jumplist / viewport-pin (discipline-agnostic seam, #265) ─────────────
2879 //
2880 // Navigation history and viewport pinning are not vim concepts — VSCode's
2881 // Go Back / Go Forward wants the same jumplist, and any discipline can pin
2882 // the viewport. These accessors live on the engine so a future
2883 // helix/vscode discipline reaches them without depending on hjkl-vim. The
2884 // vim *keybindings* on top (`Ctrl-o` / `Ctrl-i`) stay in hjkl-vim.
2885
2886 /// Read-only view of the jumplist as `(jump_back, jump_fwd)`. Newest entry
2887 /// is at the back of each. Backs `:jumps`.
2888 #[allow(clippy::type_complexity)]
2889 pub fn jump_list(&self) -> (&[(usize, usize)], &[(usize, usize)]) {
2890 (&self.jump_back, &self.jump_fwd)
2891 }
2892
2893 /// Position the cursor was at when the user last jumped back. `None`
2894 /// before any jump.
2895 pub fn last_jump_back(&self) -> Option<(usize, usize)> {
2896 self.jump_back.last().copied()
2897 }
2898
2899 /// Read-only view of the jump-back stack.
2900 pub fn jump_back_list(&self) -> &[(usize, usize)] {
2901 &self.jump_back
2902 }
2903
2904 /// Mutable access to the jump-back stack.
2905 pub fn jump_back_list_mut(&mut self) -> &mut Vec<(usize, usize)> {
2906 &mut self.jump_back
2907 }
2908
2909 /// Read-only view of the jump-forward stack.
2910 pub fn jump_fwd_list(&self) -> &[(usize, usize)] {
2911 &self.jump_fwd
2912 }
2913
2914 /// Mutable access to the jump-forward stack.
2915 pub fn jump_fwd_list_mut(&mut self) -> &mut Vec<(usize, usize)> {
2916 &mut self.jump_fwd
2917 }
2918
2919 /// Whether the viewport is pinned (suppresses scroll-follow).
2920 pub fn viewport_pinned(&self) -> bool {
2921 self.viewport_pinned
2922 }
2923
2924 /// Set the viewport-pinned flag.
2925 pub fn set_viewport_pinned(&mut self, v: bool) {
2926 self.viewport_pinned = v;
2927 }
2928
2929 /// Queue an LSP intent for the host to service on the next tick.
2930 pub fn set_pending_lsp(&mut self, intent: Option<crate::editor::LspIntent>) {
2931 self.pending_lsp = intent;
2932 }
2933
2934 /// Record the row range touched by the most recent auto-indent, for the
2935 /// host to pick up via `take_last_indent_range`.
2936 pub fn set_last_indent_range(&mut self, range: Option<(usize, usize)>) {
2937 self.last_indent_range = range;
2938 }
2939
2940 /// Walk cursor into the change list (`g;` / `g,`), or `None` when not
2941 /// walking. Per-buffer (audit B3) — reads the shared [`ChangeBank`].
2942 pub fn change_list_cursor(&self) -> Option<usize> {
2943 self.change_bank.lock().unwrap().cursor
2944 }
2945
2946 /// Set the change-list walk cursor. Per-buffer (audit B3) — writes the
2947 /// shared [`ChangeBank`], so the walk position is visible to (and can be
2948 /// continued from) any other window/split on the same buffer.
2949 pub fn set_change_list_cursor(&mut self, idx: Option<usize>) {
2950 self.change_bank.lock().unwrap().cursor = idx;
2951 }
2952
2953 /// Point this editor at a shared per-buffer changelist bank. UNLIKE the
2954 /// other `set_*_arc` setters (registers/global-marks/last-substitute/
2955 /// abbrevs/search — one Arc for the whole app session), this one is
2956 /// per-buffer: the caller must fetch-or-create the bank keyed by the
2957 /// target `buffer_id` and swap it in whenever the editor's buffer
2958 /// changes (audit B3). See [`ChangeBank`].
2959 pub fn set_change_bank_arc(&mut self, bank: std::sync::Arc<std::sync::Mutex<ChangeBank>>) {
2960 self.change_bank = bank;
2961 }
2962
2963 /// Arm the one-shot hint that the next scroll should be animated.
2964 pub fn set_scroll_anim_hint(&mut self, v: bool) {
2965 self.scroll_anim_hint = v;
2966 }
2967
2968 /// Set the read-only view overlay (Normal / Blame).
2969 pub fn set_view_mode(&mut self, v: crate::ViewMode) {
2970 self.view = v;
2971 }
2972
2973 /// The active abbreviation table. Returns an owned clone (the value
2974 /// lives behind a shared `Mutex`, so a borrow can't outlive the guard —
2975 /// mirrors [`Editor::global_marks_iter`]).
2976 pub fn abbrevs(&self) -> Vec<crate::abbrev::Abbrev> {
2977 self.abbrevs.lock().unwrap().clone()
2978 }
2979
2980 /// Whether any abbreviations are defined. Cheap emptiness check that
2981 /// locks but does NOT clone — the insert hot path calls this per
2982 /// keystroke, so it must not allocate. Use instead of `abbrevs().is_empty()`.
2983 pub fn abbrevs_is_empty(&self) -> bool {
2984 self.abbrevs.lock().unwrap().is_empty()
2985 }
2986
2987 /// Point this editor at a shared abbreviations bank. All editors in the
2988 /// app share one bank (mirrors [`Editor::set_last_substitute_arc`]) so
2989 /// `:iabbrev` / `:abbreviate` defined in one window/split expand in
2990 /// every other window — vim's abbreviations are session-global, not
2991 /// per-window.
2992 pub fn set_abbrevs_arc(
2993 &mut self,
2994 abbrevs: std::sync::Arc<std::sync::Mutex<Vec<crate::abbrev::Abbrev>>>,
2995 ) {
2996 self.abbrevs = abbrevs;
2997 }
2998
2999 /// Autopair's queued close-brackets, as `(row, col, ch)`. A discipline's
3000 /// insert path consumes a queued close when the user types the matching
3001 /// character instead of inserting a second one.
3002 pub fn pending_closes(&self) -> &[(usize, usize, char)] {
3003 &self.pending_closes
3004 }
3005
3006 /// Mutable access to autopair's queued close-brackets.
3007 pub fn pending_closes_mut(&mut self) -> &mut Vec<(usize, usize, char)> {
3008 &mut self.pending_closes
3009 }
3010
3011 /// Whether the unnamed register's content is linewise.
3012 pub fn yank_linewise(&self) -> bool {
3013 self.yank_linewise
3014 }
3015
3016 /// Set the linewise flag for the unnamed register.
3017 pub fn set_yank_linewise(&mut self, v: bool) {
3018 self.yank_linewise = v;
3019 }
3020
3021 // ── Search state (discipline-agnostic seam, #265) ────────────────────────
3022 //
3023 // Every editor has find. These live on the engine so a helix/vscode
3024 // discipline reaches the pattern, direction and history without depending
3025 // on hjkl-vim. The vim *keybindings* on top (`/`, `?`, `n`, `N`, `*`) stay
3026 // in hjkl-vim.
3027
3028 /// The live `/` or `?` search-prompt state, if a prompt is open.
3029 pub fn search_prompt_state(&self) -> Option<&crate::search::SearchPrompt> {
3030 self.search_prompt.as_ref()
3031 }
3032
3033 /// Mutable access to the live search-prompt state.
3034 pub fn search_prompt_state_mut(&mut self) -> Option<&mut crate::search::SearchPrompt> {
3035 self.search_prompt.as_mut()
3036 }
3037
3038 /// Take (and close) the search-prompt state.
3039 pub fn take_search_prompt_state(&mut self) -> Option<crate::search::SearchPrompt> {
3040 self.search_prompt.take()
3041 }
3042
3043 /// Install (or clear) the search-prompt state.
3044 pub fn set_search_prompt_state(&mut self, prompt: Option<crate::search::SearchPrompt>) {
3045 self.search_prompt = prompt;
3046 }
3047
3048 /// The last committed search pattern, for `n` / `N` (or Find Next).
3049 /// Returns an owned clone (the value lives behind a shared `Mutex`, so a
3050 /// borrow can't outlive the guard — mirrors [`Editor::global_marks_iter`]).
3051 pub fn last_search_pattern(&self) -> Option<String> {
3052 self.search.lock().unwrap().last.clone()
3053 }
3054
3055 /// Set the last search pattern without touching direction or highlight.
3056 pub fn set_last_search_pattern_only(&mut self, pattern: Option<String>) {
3057 self.search.lock().unwrap().last = pattern;
3058 }
3059
3060 /// Set the last search direction without touching the pattern.
3061 pub fn set_last_search_forward_only(&mut self, forward: bool) {
3062 self.search.lock().unwrap().forward = forward;
3063 }
3064
3065 /// The search history (oldest first). Returns an owned clone (the value
3066 /// lives behind a shared `Mutex`, so a borrow can't outlive the guard).
3067 pub fn search_history(&self) -> Vec<String> {
3068 self.search.lock().unwrap().history.clone()
3069 }
3070
3071 /// Cursor position while walking search history with Up/Down.
3072 pub fn search_history_cursor(&self) -> Option<usize> {
3073 self.search.lock().unwrap().history_cursor
3074 }
3075
3076 /// Set the search-history walk cursor.
3077 pub fn set_search_history_cursor(&mut self, idx: Option<usize>) {
3078 self.search.lock().unwrap().history_cursor = idx;
3079 }
3080
3081 // ── Input timing (discipline-agnostic seam) ──────────────────────────────
3082 //
3083 // Any chorded FSM needs a timeout clock, not just vim.
3084
3085 /// Instant of the last input, when the host supplies a monotonic clock.
3086 pub fn last_input_at(&self) -> Option<std::time::Instant> {
3087 self.last_input_at
3088 }
3089
3090 /// Set the instant of the last input.
3091 pub fn set_last_input_at(&mut self, t: Option<std::time::Instant>) {
3092 self.last_input_at = t;
3093 }
3094
3095 /// Host-supplied elapsed time at the last input (no_std hosts).
3096 pub fn last_input_host_at(&self) -> Option<core::time::Duration> {
3097 self.last_input_host_at
3098 }
3099
3100 /// Set the host-supplied elapsed time at the last input.
3101 pub fn set_last_input_host_at(&mut self, d: Option<core::time::Duration>) {
3102 self.last_input_host_at = d;
3103 }
3104
3105 // ── Scrolling (discipline-agnostic seam, #265) ───────────────────────────
3106 //
3107 // Scrolling a viewport is not a vim concept — every discipline does it.
3108 // These carry zero vim FSM state (the one field they used to touch,
3109 // `scroll_anim_hint`, now lives on the Editor), so they belong here. The
3110 // vim *keybindings* on top (`Ctrl-F`/`Ctrl-B`, `Ctrl-D`/`Ctrl-U`,
3111 // `Ctrl-E`/`Ctrl-Y`) stay in hjkl-vim.
3112
3113 /// Rows spanned by half a viewport, times `count` (min 1).
3114 pub fn viewport_half_rows(&self, count: usize) -> usize {
3115 let h = self.viewport_height_value() as usize;
3116 (h / 2).max(1).saturating_mul(count.max(1))
3117 }
3118
3119 /// Rows spanned by a full viewport (less a two-line overlap), times
3120 /// `count` (min 1).
3121 pub fn viewport_full_rows(&self, count: usize) -> usize {
3122 let h = self.viewport_height_value() as usize;
3123 h.saturating_sub(2).max(1).saturating_mul(count.max(1))
3124 }
3125
3126 /// Move the cursor `delta` rows (clamped to the buffer), landing on the
3127 /// first non-blank of the target row and resetting the sticky column.
3128 pub fn scroll_cursor_rows(&mut self, delta: isize) {
3129 if delta == 0 {
3130 return;
3131 }
3132 self.sync_buffer_content_from_textarea();
3133 let (row, _) = self.cursor();
3134 let last_row = buf_row_count(&self.buffer).saturating_sub(1);
3135 let target = (row as isize + delta).max(0).min(last_row as isize) as usize;
3136 buf_set_cursor_rc(&mut self.buffer, target, 0);
3137 crate::motions::move_first_non_blank(&mut self.buffer);
3138 let pos = buf_cursor_pos(&self.buffer);
3139 let line = buf_line(&self.buffer, pos.row).unwrap_or_default();
3140 self.sticky_col = Some(char_col_to_visual_col(
3141 &line,
3142 pos.col,
3143 self.settings().tabstop,
3144 ));
3145 }
3146
3147 /// Scroll the cursor by one full viewport height (height − 2 rows,
3148 /// preserving a two-line overlap). `count` multiplies the step.
3149 pub fn scroll_full_page(&mut self, dir: crate::types::ScrollDir, count: usize) {
3150 self.scroll_anim_hint = true;
3151 let rows = self.viewport_full_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 cursor by half the viewport height. `count` multiplies.
3159 pub fn scroll_half_page(&mut self, dir: crate::types::ScrollDir, count: usize) {
3160 self.scroll_anim_hint = true;
3161 let rows = self.viewport_half_rows(count) as isize;
3162 match dir {
3163 crate::types::ScrollDir::Down => self.scroll_cursor_rows(rows),
3164 crate::types::ScrollDir::Up => self.scroll_cursor_rows(-rows),
3165 }
3166 }
3167
3168 /// Scroll the viewport `count` lines without moving the cursor (the cursor
3169 /// is clamped into the new visible region if it would fall outside).
3170 pub fn scroll_line(&mut self, dir: crate::types::ScrollDir, count: usize) {
3171 let n = count.max(1);
3172 let total = buf_row_count(&self.buffer);
3173 let last = total.saturating_sub(1);
3174 let h = self.viewport_height_value() as usize;
3175 let cur_top = self.host().viewport().top_row;
3176 let new_top = match dir {
3177 crate::types::ScrollDir::Down => (cur_top + n).min(last),
3178 crate::types::ScrollDir::Up => cur_top.saturating_sub(n),
3179 };
3180 self.set_viewport_top(new_top);
3181 // Clamp cursor to stay within the new visible region.
3182 let (row, _) = self.cursor();
3183 let bot = (new_top + h).saturating_sub(1).min(last);
3184 let clamped = row.max(new_top).min(bot);
3185 if clamped != row {
3186 // `<C-e>` / `<C-y>` are screen-line vertical motions, so pushing
3187 // the cursor onto a new row follows the `j` / `k` rule: aim at
3188 // `curswant`, clamp to the row, keep the un-clamped want. This
3189 // used to re-use the old column verbatim, which both ignored
3190 // `curswant` and parked the cursor past end-of-line on a shorter
3191 // row. Found by the `esc_returns_to_normal` proptest via the
3192 // phase-0 curswant assertion.
3193 self.move_cursor(crate::cursor_move::Move::Vertical { row: clamped });
3194 }
3195 }
3196
3197 /// Drain the queue of [`crate::types::ContentEdit`]s emitted since
3198 /// the last call. Each entry corresponds to a single buffer
3199 /// mutation funnelled through [`Editor::mutate_edit`]; block edits
3200 /// fan out to one entry per row touched.
3201 ///
3202 /// Hosts call this each frame (after [`Editor::take_content_reset`])
3203 /// to fan edits into a tree-sitter parser via `Tree::edit`.
3204 pub fn take_content_edits(&mut self) -> Vec<crate::types::ContentEdit> {
3205 self.buffer.take_pending_content_edits()
3206 }
3207
3208 /// Returns `true` if a bulk buffer replacement happened since the
3209 /// last call (e.g. `set_content` / `restore` / undo restore), then
3210 /// clears the flag. When this returns `true`, hosts should drop
3211 /// any retained syntax tree before consuming
3212 /// [`Editor::take_content_edits`].
3213 pub fn take_content_reset(&mut self) -> bool {
3214 self.buffer.take_pending_content_reset()
3215 }
3216
3217 /// Pull-model coarse change observation. If content changed since
3218 /// the last call, returns `Some(Arc<String>)` with the new content
3219 /// and clears the dirty flag; otherwise returns `None`.
3220 ///
3221 /// Hosts that need fine-grained edit deltas (e.g., DOM patching at
3222 /// the character level) should diff against their own previous
3223 /// snapshot. The SPEC `take_changes() -> Vec<EditOp>` API lands
3224 /// once every edit path inside the engine is instrumented; this
3225 /// coarse form covers the pull-model use case in the meantime.
3226 pub fn take_content_change(&mut self) -> Option<std::sync::Arc<String>> {
3227 if !self.buffer.content_dirty() {
3228 return None;
3229 }
3230 let arc = self.content_arc();
3231 self.buffer.set_content_dirty(false);
3232 Some(arc)
3233 }
3234
3235 /// Width in cells of the line-number gutter for the current buffer
3236 /// and settings. Matches what [`Editor::cursor_screen_pos`] reserves
3237 /// in front of the text column. Returns `0` when both `number` and
3238 /// `relativenumber` are off.
3239 pub fn lnum_width(&self) -> u16 {
3240 if self.settings.number || self.settings.relativenumber {
3241 let needed = buf_row_count(&self.buffer).to_string().len() + 1;
3242 needed.max(self.settings.numberwidth) as u16
3243 } else {
3244 0
3245 }
3246 }
3247
3248 /// Returns the cursor's row within the visible textarea (0-based), updating
3249 /// the stored viewport top so subsequent calls remain accurate.
3250 pub fn cursor_screen_row(&mut self, height: u16) -> u16 {
3251 let cursor = buf_cursor_row(&self.buffer);
3252 let top = self.host.viewport().top_row;
3253 cursor
3254 .saturating_sub(top)
3255 .min((height as usize).saturating_sub(1)) as u16
3256 }
3257
3258 /// Returns the cursor's screen position `(x, y)` for the textarea
3259 /// described by `(area_x, area_y, area_width, area_height)`.
3260 /// Accounts for line-number gutter, viewport scroll, and any extra
3261 /// gutter width to the left of the number column (sign column, fold
3262 /// column). Returns `None` if the cursor is outside the visible
3263 /// viewport. Always available (engine-native; no ratatui dependency).
3264 ///
3265 /// `extra_gutter_width` is added to the number-column width before
3266 /// computing the cursor x position. Callers (e.g. `apps/hjkl/src/render.rs`)
3267 /// pass `sign_w + fold_w` here so the cursor lands on the correct cell
3268 /// when a dedicated sign or fold column is present.
3269 ///
3270 /// Renamed from `cursor_screen_pos_xywh` in 0.0.32.
3271 pub fn cursor_screen_pos(
3272 &self,
3273 area_x: u16,
3274 area_y: u16,
3275 area_width: u16,
3276 area_height: u16,
3277 extra_gutter_width: u16,
3278 ) -> Option<(u16, u16)> {
3279 let (pos_row, pos_col) = buf_cursor_rc(&self.buffer);
3280 let v = self.host.viewport();
3281 if pos_row < v.top_row || pos_col < v.top_col {
3282 return None;
3283 }
3284 let lnum_width = self.lnum_width();
3285 // Full offset from the left edge of the window to the first text cell.
3286 let gutter_total = lnum_width + extra_gutter_width;
3287 // Screen row delta: delegate to the single fold- and wrap-aware
3288 // calculator that already drives scrolling + scrolloff, rather than
3289 // recomputing `pos_row - top_row` here. That naive delta ignored rows
3290 // collapsed by closed folds, painting the cursor block N rows too low
3291 // while the (fold-aware) text + line-highlight rendered correctly.
3292 // One source of truth → no drift between scroll math and cursor math. (#244)
3293 let folds = crate::buffer_impl::SnapshotFoldProvider::from_buffer(&self.buffer);
3294 let dy = crate::viewport_math::cursor_screen_row_from(&self.buffer, &folds, v, v.top_row)?
3295 as u16;
3296 // Convert char column to visual column so cursor lands on the
3297 // correct cell when the line contains tabs (which the renderer
3298 // expands to TAB_WIDTH stops). Tab width must match the renderer.
3299 let cursor_rope = self.buffer.rope();
3300 let pos_row_safe = pos_row.min(cursor_rope.len_lines().saturating_sub(1));
3301 let line = hjkl_buffer::rope_line_str(&cursor_rope, pos_row_safe);
3302 let tab_width = if v.tab_width == 0 {
3303 4
3304 } else {
3305 v.tab_width as usize
3306 };
3307 let visual_pos = visual_col_for_char(&line, pos_col, tab_width);
3308 let visual_top = visual_col_for_char(&line, v.top_col, tab_width);
3309 let dx = (visual_pos - visual_top) as u16;
3310 if dy >= area_height || dx + gutter_total >= area_width {
3311 return None;
3312 }
3313 Some((area_x + gutter_total + dx, area_y + dy))
3314 }
3315
3316 /// Discipline-agnostic coarse mode for app chrome (status badge, cursor
3317 /// shape). App code that only needs "inserting / selecting / idle" — not the
3318 /// precise vim mode — should read this so it works identically under any
3319 /// keybinding discipline (vim, vscode, future helix/emacs). See
3320 /// [`crate::CoarseMode`] (epic #265 G3). Today this projects from the vim
3321 /// mode; once FSM state is pluggable each discipline supplies its own.
3322 pub fn coarse_mode(&self) -> crate::CoarseMode {
3323 self.discipline.coarse_mode()
3324 }
3325
3326 /// The secondary selections, in char columns. Empty for a single-cursor
3327 /// editor.
3328 ///
3329 /// The primary selection is *not* included: its head is [`Editor::cursor`]
3330 /// and its anchor lives in the discipline — see the `extra_selections` field
3331 /// docs for why.
3332 pub fn extra_selections(&self) -> &[crate::selection_shift::Sel] {
3333 &self.extra_selections
3334 }
3335
3336 /// The **heads** of the secondary selections — the carets a user sees.
3337 ///
3338 /// Convenience view over [`Editor::extra_selections`] for callers that only
3339 /// care where the carets are (rendering, tests).
3340 pub fn extra_cursors(&self) -> Vec<hjkl_buffer::Position> {
3341 self.extra_selections.iter().map(|s| s.head).collect()
3342 }
3343
3344 /// Replace the whole secondary set.
3345 ///
3346 /// Selections whose head duplicates the primary head, or an earlier entry's
3347 /// head, are dropped: two carets on one spot would apply every edit twice at
3348 /// the same place. Same invariant [`Editor::add_cursor`] enforces, applied to
3349 /// a bulk write — a discipline recomputing every selection after a motion
3350 /// (helix does this on every keystroke) must not be able to smuggle a
3351 /// duplicate in through the back door.
3352 ///
3353 /// Any two selections whose *ranges* overlap (not just their heads) are
3354 /// merged into their union rather than kept as separate entries (audit
3355 /// A7) — [`Editor::edit_at_all_selections`]'s bottom-up fan-out assumes
3356 /// selections are disjoint, and an overlapping pair would corrupt each
3357 /// other's still-queued coordinates as edits land.
3358 pub fn set_extra_selections(&mut self, sels: Vec<crate::selection_shift::Sel>) {
3359 let (row, col) = self.cursor();
3360 let primary = hjkl_buffer::Position::new(row, col);
3361 let mut deduped: Vec<crate::selection_shift::Sel> = Vec::new();
3362 for s in sels {
3363 if s.head == primary || deduped.iter().any(|e| e.head == s.head) {
3364 continue;
3365 }
3366 deduped.push(s);
3367 }
3368 self.extra_selections = crate::selection_shift::merge_overlapping(deduped);
3369 }
3370
3371 /// Add a secondary selection. Same dedup rule as [`Editor::add_cursor`],
3372 /// plus the overlap-merge guard documented on [`Editor::set_extra_selections`]
3373 /// (audit A7): a selection whose range overlaps an existing secondary is
3374 /// merged into it instead of being kept as a second, aliasing entry.
3375 pub fn add_selection(&mut self, sel: crate::selection_shift::Sel) {
3376 let (row, col) = self.cursor();
3377 if sel.head == hjkl_buffer::Position::new(row, col)
3378 || self.extra_selections.iter().any(|s| s.head == sel.head)
3379 {
3380 return;
3381 }
3382 self.extra_selections.push(sel);
3383 self.extra_selections =
3384 crate::selection_shift::merge_overlapping(std::mem::take(&mut self.extra_selections));
3385 }
3386
3387 /// Add a secondary cursor: a zero-width selection at `pos`. Ignores a
3388 /// position that duplicates the primary head or an existing secondary head,
3389 /// so a set never carries two carets at one spot — that would apply an edit
3390 /// twice at the same place.
3391 pub fn add_cursor(&mut self, pos: hjkl_buffer::Position) {
3392 self.add_selection(crate::selection_shift::Sel::caret(pos));
3393 }
3394
3395 /// Drop every secondary selection, collapsing back to the primary.
3396 pub fn clear_extra_cursors(&mut self) {
3397 self.extra_selections.clear();
3398 }
3399
3400 /// Apply an edit at **every** cursor — the primary and all secondaries —
3401 /// and leave each cursor where its own edit left it (#63).
3402 ///
3403 /// `make` is handed each cursor's position and returns the edit to apply
3404 /// there, so the caller writes the edit once and it fans out:
3405 ///
3406 /// ```ignore
3407 /// ed.edit_at_all_cursors(|at| Edit::InsertStr { at, text: "x".into() });
3408 /// ```
3409 ///
3410 /// Returns the inverse of each applied edit, in application order, so a
3411 /// caller can push them as one undo step. This does **not** touch the undo
3412 /// stack itself — `mutate_edit` never does, and a multi-cursor keystroke is
3413 /// one user action, so the discipline pushes undo once before calling.
3414 ///
3415 /// # Why the order matters
3416 ///
3417 /// Edits are applied **bottom-up** (last cursor in the document first). An
3418 /// edit at position P only moves positions at or after P, so working
3419 /// backwards leaves every not-yet-visited cursor's coordinates still valid.
3420 /// Going top-down would invalidate them all after the first edit.
3421 ///
3422 /// Each cursor that has already been edited is parked in `extra_cursors`,
3423 /// so [`Editor::mutate_edit`]'s shift keeps it correct as the remaining
3424 /// (earlier) edits land. The bookkeeping is the same machinery, reused.
3425 ///
3426 /// # Degradation
3427 ///
3428 /// If any cursor becomes untrackable mid-apply (see `selection_shift`), the
3429 /// secondaries are dropped and the editor collapses to the primary rather
3430 /// than carrying on with a caret that no longer knows where it is.
3431 pub fn edit_at_all_cursors(
3432 &mut self,
3433 make: impl Fn(hjkl_buffer::Position) -> hjkl_buffer::Edit,
3434 ) -> Vec<hjkl_buffer::Edit> {
3435 let (pr, pc) = self.cursor();
3436 let primary = hjkl_buffer::Position::new(pr, pc);
3437 let (inverses, _) = self.edit_at_all_selections(primary, |s| make(s.head));
3438 inverses
3439 }
3440
3441 /// Apply an edit at **every selection** — the primary and all secondaries —
3442 /// where `make` sees the whole selection, not just its head (#63).
3443 ///
3444 /// This is what an operator needs: `d` on three selections has to delete
3445 /// three *ranges*, and only the caller-visible [`Sel`] carries both ends.
3446 /// [`Editor::edit_at_all_cursors`] is the caret-only special case of this.
3447 ///
3448 /// `primary_anchor` is passed in — and the primary's *new* anchor is returned
3449 /// — because the primary selection's anchor lives in the discipline's state,
3450 /// not the engine's (see the `extra_selections` field docs).
3451 ///
3452 /// Returns `(inverse of each applied edit in application order, new primary
3453 /// anchor)`. This does **not** touch the undo stack — `mutate_edit` never
3454 /// does, and a multi-cursor keystroke is one user action, so the discipline
3455 /// pushes undo once before calling.
3456 ///
3457 /// # Why the order matters
3458 ///
3459 /// Edits are applied **bottom-up** (last selection in the document first). An
3460 /// edit at position P only moves positions at or after P, so working
3461 /// backwards leaves every not-yet-visited selection's coordinates still valid.
3462 /// Going top-down would invalidate them all after the first edit.
3463 ///
3464 /// Each selection that has already been edited is parked in
3465 /// `extra_selections`, so [`Editor::mutate_edit`]'s shift keeps it correct as
3466 /// the remaining (earlier) edits land.
3467 ///
3468 /// # What happens to the anchors
3469 ///
3470 /// Each selection's anchor is shifted through *its own* edit with the same
3471 /// insertion-point semantics [`crate::selection_shift`] uses everywhere: an
3472 /// anchor swallowed by a deletion collapses onto the deletion start, which is
3473 /// exactly where the head lands — so `d` / `c` leave a caret at each edit
3474 /// site, with no bookkeeping. An anchor sitting exactly at an insertion point
3475 /// slides right with the text. A caller that needs a selection *preserved*
3476 /// across a same-length rewrite (helix's `~`, `>`) should re-set the
3477 /// selections afterwards via [`Editor::set_extra_selections`] rather than
3478 /// rely on that shift.
3479 ///
3480 /// # Degradation
3481 ///
3482 /// If any selection becomes untrackable mid-apply (see `selection_shift`), the
3483 /// secondaries are dropped and the editor collapses to the primary rather than
3484 /// carrying on with a selection that no longer knows where it is.
3485 ///
3486 /// [`Sel`]: crate::selection_shift::Sel
3487 pub fn edit_at_all_selections(
3488 &mut self,
3489 primary_anchor: hjkl_buffer::Position,
3490 make: impl Fn(crate::selection_shift::Sel) -> hjkl_buffer::Edit,
3491 ) -> (Vec<hjkl_buffer::Edit>, hjkl_buffer::Position) {
3492 use crate::selection_shift::Sel;
3493
3494 let (pr, pc) = self.cursor();
3495 let primary = Sel::new(primary_anchor, hjkl_buffer::Position::new(pr, pc));
3496
3497 let mut all: Vec<Sel> = std::iter::once(primary)
3498 .chain(self.extra_selections.iter().copied())
3499 .collect();
3500 // Bottom-up by where each selection's edit *starts* — its earlier end.
3501 // For a caret that is just the head, so this is the same order as before.
3502 all.sort_by_key(|s| std::cmp::Reverse((s.start().row, s.start().col)));
3503
3504 // Rebuilt as we go: a selection lands in here the moment its edit is done,
3505 // which enrols it in the shift for every later edit.
3506 self.extra_selections.clear();
3507
3508 let mut inverses = Vec::with_capacity(all.len());
3509 let mut primary_idx: Option<usize> = None;
3510 let mut lost_a_selection = false;
3511
3512 for (i, s) in all.iter().copied().enumerate() {
3513 // Every previous iteration should have parked exactly one selection.
3514 // If the count slipped, `mutate_edit` dropped one it could not track.
3515 if self.extra_selections.len() != i {
3516 lost_a_selection = true;
3517 break;
3518 }
3519 let edit = make(s);
3520 // The anchor has to be shifted against the PRE-edit geometry, same as
3521 // the parked selections are — so read the metrics before applying.
3522 let rows = buf_row_count(&self.buffer);
3523 let lens: Vec<usize> = (0..rows).map(|r| buf_line_chars(&self.buffer, r)).collect();
3524 let shifted_anchor = crate::selection_shift::shift_position(
3525 s.anchor,
3526 &edit,
3527 |r| lens.get(r).copied().unwrap_or(0),
3528 rows,
3529 );
3530
3531 self.set_cursor_quiet(s.head.row, s.head.col);
3532 inverses.push(self.mutate_edit(edit));
3533 let (nr, nc) = self.cursor();
3534
3535 let Some(anchor) = shifted_anchor else {
3536 lost_a_selection = true;
3537 break;
3538 };
3539 if s == primary && primary_idx.is_none() {
3540 primary_idx = Some(self.extra_selections.len());
3541 }
3542 self.extra_selections
3543 .push(Sel::new(anchor, hjkl_buffer::Position::new(nr, nc)));
3544 }
3545
3546 match (lost_a_selection, primary_idx) {
3547 (false, Some(idx)) if idx < self.extra_selections.len() => {
3548 // Pull the primary back out of the parked set; the rest stay.
3549 let landed = self.extra_selections.remove(idx);
3550 self.set_cursor_quiet(landed.head.row, landed.head.col);
3551 (inverses, landed.anchor)
3552 }
3553 _ => {
3554 // Something went untrackable: collapse to a single selection rather
3555 // than leave one pointing at text it no longer owns.
3556 self.extra_selections.clear();
3557 let (row, col) = self.cursor();
3558 (inverses, hjkl_buffer::Position::new(row, col))
3559 }
3560 }
3561 }
3562
3563 /// The installed discipline's FSM state, type-erased.
3564 ///
3565 /// A discipline crate reaches its own concrete state by downcasting:
3566 /// `ed.discipline().as_any().downcast_ref::<VimState>()`.
3567 pub fn discipline(&self) -> &dyn crate::DisciplineState {
3568 &*self.discipline
3569 }
3570
3571 /// Mutable counterpart of [`Editor::discipline`].
3572 pub fn discipline_mut(&mut self) -> &mut dyn crate::DisciplineState {
3573 &mut *self.discipline
3574 }
3575
3576 /// Install a keyboard discipline, replacing whatever was there.
3577 ///
3578 /// Host apps call this once at construction (e.g.
3579 /// `hjkl_vim::install_vim_discipline(&mut ed)`); an `Editor` that never
3580 /// receives discipline input keeps the default
3581 /// [`NoDiscipline`](crate::NoDiscipline).
3582 pub fn set_discipline(&mut self, discipline: Box<dyn crate::DisciplineState>) {
3583 self.discipline = discipline;
3584 }
3585
3586 /// The active read-only view overlay (see [`crate::ViewMode`]). Independent
3587 /// of [`Editor::vim_mode`]; the host renderer reads this as the source of
3588 /// truth for whether to draw the git-blame framing.
3589 pub fn view_mode(&self) -> crate::ViewMode {
3590 self.view
3591 }
3592
3593 /// `true` when the git-blame read-only overlay is active. Masked on the
3594 /// input mode: BLAME is only meaningful in Normal, so this returns `false`
3595 /// the instant the editor enters Insert/Visual/etc., even before the
3596 /// overlay flag is dropped. Use this for both rendering and mode-label.
3597 pub fn is_blame(&self) -> bool {
3598 self.view == crate::ViewMode::Blame && self.coarse_mode() == crate::CoarseMode::Normal
3599 }
3600
3601 /// Enter the git-blame read-only overlay. No-op unless the editor is in
3602 /// Normal mode (BLAME is a Normal-only view). While active, every mutation
3603 /// funnel is blocked and the host renders the per-commit framing.
3604 pub fn enter_blame(&mut self) {
3605 if self.coarse_mode() == crate::CoarseMode::Normal {
3606 self.view = crate::ViewMode::Blame;
3607 }
3608 }
3609
3610 /// Leave the git-blame overlay, returning to a plain Normal view. Idempotent.
3611 pub fn exit_blame(&mut self) {
3612 self.view = crate::ViewMode::Normal;
3613 }
3614
3615 /// Bounds of the active visual-block rectangle as
3616 /// `(top_row, bot_row, left_col, right_col)` — all inclusive.
3617 /// `None` when we're not in VisualBlock mode.
3618 /// Read-only view of the live `/` or `?` prompt. `None` outside
3619 /// search-prompt mode.
3620 pub fn search_prompt(&self) -> Option<&crate::search::SearchPrompt> {
3621 self.search_prompt.as_ref()
3622 }
3623
3624 /// Most recent committed search pattern (persists across `n` / `N`
3625 /// and across prompt exits). `None` before the first search. Returns an
3626 /// owned clone (the value lives behind a shared `Mutex`, so a borrow
3627 /// can't outlive the guard — mirrors [`Editor::global_marks_iter`]).
3628 pub fn last_search(&self) -> Option<String> {
3629 self.search.lock().unwrap().last.clone()
3630 }
3631
3632 /// Whether the last committed search was a forward `/` (`true`) or
3633 /// a backward `?` (`false`). `n` and `N` consult this to honour the
3634 /// direction the user committed.
3635 pub fn last_search_forward(&self) -> bool {
3636 self.search.lock().unwrap().forward
3637 }
3638
3639 /// Set the most recent committed search text + direction. Used by
3640 /// host-driven prompts (e.g. apps/hjkl's `/` `?` prompt that lives
3641 /// outside the engine's vim FSM) so `n` / `N` repeat the host's
3642 /// most recent commit with the right direction. Pass `None` /
3643 /// `true` to clear.
3644 pub fn set_last_search(&mut self, text: Option<String>, forward: bool) {
3645 let mut bank = self.search.lock().unwrap();
3646 bank.last = text;
3647 bank.forward = forward;
3648 }
3649
3650 /// Point this editor at a shared search bank. All editors in the app
3651 /// share one bank (mirrors [`Editor::set_last_substitute_arc`]) so `/`
3652 /// / `?` committed in one window/split and `n` / `N` typed in another
3653 /// see the same pattern — vim's last search (the `"/` register) is
3654 /// session-global, not per-window.
3655 pub fn set_search_arc(&mut self, search: std::sync::Arc<std::sync::Mutex<SearchBank>>) {
3656 self.search = search;
3657 }
3658
3659 /// The most recent successful `:s` command. `None` before the first substitute.
3660 /// Used by `:&` / `:&&` to repeat it. Returns an owned clone (the value
3661 /// lives behind a shared `Mutex`, so a borrow can't outlive the guard —
3662 /// mirrors [`Editor::global_marks_iter`]).
3663 pub fn last_substitute(&self) -> Option<crate::substitute::SubstituteCmd> {
3664 self.last_substitute.lock().unwrap().clone()
3665 }
3666
3667 /// The previous `:s` replacement text, or `""` when no substitute has run
3668 /// yet. Feeds the magic `~` expansion on the PATTERN side of `:s` and
3669 /// `/`/`?` searches — pass it to
3670 /// [`crate::search::resolve_case_mode`]. (The replacement-side `~`/`&`
3671 /// features read the same [`Editor::last_substitute`] bank.)
3672 pub fn last_substitute_replacement(&self) -> String {
3673 self.last_substitute
3674 .lock()
3675 .unwrap()
3676 .as_ref()
3677 .map(|c| c.replacement.clone())
3678 .unwrap_or_default()
3679 }
3680
3681 /// Store the last successful substitute so `:&` / `:&&` can repeat it.
3682 pub fn set_last_substitute(&mut self, cmd: crate::substitute::SubstituteCmd) {
3683 *self.last_substitute.lock().unwrap() = Some(cmd);
3684 }
3685
3686 /// Point this editor at a shared last-substitute bank. All editors in
3687 /// the app share one bank (mirrors [`Editor::set_global_marks_arc`]) so
3688 /// `:&` run in one window repeats the `:s` most recently executed in any
3689 /// window — vim's last substitute is session-global, not per-window.
3690 pub fn set_last_substitute_arc(
3691 &mut self,
3692 last_substitute: std::sync::Arc<std::sync::Mutex<Option<crate::substitute::SubstituteCmd>>>,
3693 ) {
3694 self.last_substitute = last_substitute;
3695 }
3696
3697 /// Number of rows (lines) in the buffer.
3698 ///
3699 /// Convenience accessor for call sites that only need the row count without
3700 /// routing through the `Query` trait directly (e.g. the VSCode selection
3701 /// dispatcher computing buffer-end positions).
3702 pub fn row_count(&self) -> usize {
3703 buf_row_count(&self.buffer)
3704 }
3705
3706 /// Row `row` as an owned `String` (no trailing newline), or `None` when
3707 /// `row` is out of bounds.
3708 ///
3709 /// Mode-agnostic buffer read. Hosts and discipline crates (e.g. the vim
3710 /// accessors on `hjkl_vim::VimEditorExt`) use this instead of reaching for
3711 /// the engine's private `buf_line` helper.
3712 pub fn line(&self, row: usize) -> Option<String> {
3713 buf_line(&self.buffer, row)
3714 }
3715
3716 pub fn content(&self) -> String {
3717 let n = buf_row_count(&self.buffer);
3718 let mut s = String::new();
3719 for r in 0..n {
3720 if r > 0 {
3721 s.push('\n');
3722 }
3723 s.push_str(&crate::types::Query::line(&self.buffer, r as u32));
3724 }
3725 s.push('\n');
3726 s
3727 }
3728
3729 /// Same logical output as [`content`], but returns a cached
3730 /// `Arc<String>` so back-to-back reads within an un-mutated window
3731 /// are ref-count bumps instead of multi-MB joins. The cache is
3732 /// invalidated by every [`mark_content_dirty`] call.
3733 pub fn content_arc(&mut self) -> std::sync::Arc<String> {
3734 if let Some(arc) = self.buffer.cached_editor_content() {
3735 return arc;
3736 }
3737 let arc = std::sync::Arc::new(self.content());
3738 self.buffer
3739 .set_cached_editor_content(std::sync::Arc::clone(&arc));
3740 arc
3741 }
3742
3743 pub fn set_content(&mut self, text: &str) {
3744 crate::types::BufferEdit::replace_all(&mut self.buffer, text);
3745 self.buffer.clear_undo_redo();
3746 // Whole-buffer replace supersedes any queued ContentEdits.
3747 self.buffer.clear_pending_content_edits();
3748 self.buffer.set_pending_content_reset(true);
3749 self.mark_content_dirty();
3750 }
3751
3752 /// Whole-buffer replace that **preserves the undo history**.
3753 ///
3754 /// Equivalent to [`Editor::set_content`] but pushes the current buffer
3755 /// state onto the undo stack first, so a subsequent `u` walks back to
3756 /// the pre-replacement content. Use this for any operation the user
3757 /// expects to undo as a single step — e.g. external formatter output
3758 /// (`hjkl-mangler`) installed via the async [`crate::app::FormatWorker`].
3759 ///
3760 /// Like `push_undo`, this clears the redo stack (vim semantics: any
3761 /// new edit invalidates redo).
3762 pub fn set_content_undoable(&mut self, text: &str) {
3763 self.push_undo();
3764 crate::types::BufferEdit::replace_all(&mut self.buffer, text);
3765 // Whole-buffer replace supersedes any queued ContentEdits.
3766 self.buffer.clear_pending_content_edits();
3767 self.buffer.set_pending_content_reset(true);
3768 self.mark_content_dirty();
3769 }
3770
3771 /// Drain the pending change log produced by buffer mutations.
3772 ///
3773 /// Returns a `Vec<EditOp>` covering edits applied since the last
3774 /// call. Empty when no edits ran. Pull-model, complementary to
3775 /// [`Editor::take_content_change`] which gives back the new full
3776 /// content.
3777 ///
3778 /// Recording is opt-in: nothing in hjkl reads this log, so it defaults
3779 /// OFF and every `mutate_edit` would otherwise pay a payload clone plus
3780 /// a `Vec` build for an entry no host consumes. A host that wants the
3781 /// log calls `buffer_mut().set_change_log_enabled(true)` once.
3782 ///
3783 /// Mapping coverage:
3784 /// - InsertChar / InsertStr → exact `EditOp` with empty range +
3785 /// replacement.
3786 /// - DeleteRange (`Char` kind) → exact range + empty replacement.
3787 /// - Replace → exact range + new replacement.
3788 /// - DeleteRange (`Line`/`Block`), JoinLines, SplitLines,
3789 /// InsertBlock, DeleteBlockChunks → best-effort placeholder
3790 /// covering the touched range. Hosts wanting per-cell deltas
3791 /// should diff their own `lines()` snapshot.
3792 pub fn take_changes(&mut self) -> Vec<crate::types::Edit> {
3793 self.buffer.take_change_log()
3794 }
3795
3796 /// Read the engine's current settings as a SPEC
3797 /// [`crate::types::Options`].
3798 ///
3799 /// Bridges between the legacy [`Settings`] (which carries fewer
3800 /// fields than SPEC) and the planned 0.1.0 trait surface. Fields
3801 /// not present in `Settings` fall back to vim defaults (e.g.,
3802 /// `expandtab=false`, `wrapscan=true`, `timeout_len=1000ms`).
3803 /// Once trait extraction lands, this becomes the canonical config
3804 /// reader and `Settings` retires.
3805 pub fn current_options(&self) -> crate::types::Options {
3806 self.settings.to_options()
3807 }
3808
3809 /// Apply a SPEC [`crate::types::Options`] to the engine's settings.
3810 /// Only the fields backed by today's [`Settings`] take effect;
3811 /// remaining options become live once trait extraction wires them
3812 /// through.
3813 pub fn apply_options(&mut self, opts: &crate::types::Options) {
3814 self.settings.apply_options(opts);
3815 }
3816
3817 /// SPEC-typed highlights for `line`.
3818 ///
3819 /// Two emission modes:
3820 ///
3821 /// - **IncSearch**: the user is typing a `/` or `?` prompt and
3822 /// `Editor::search_prompt` is `Some`. Live-preview matches of
3823 /// the in-flight pattern surface as
3824 /// [`crate::types::HighlightKind::IncSearch`].
3825 /// - **SearchMatch**: the prompt has been committed (or absent)
3826 /// and the buffer's armed pattern is non-empty. Matches surface
3827 /// as [`crate::types::HighlightKind::SearchMatch`].
3828 ///
3829 /// Selection / MatchParen / Syntax(id) variants land once the
3830 /// trait extraction routes the FSM's selection set + the host's
3831 /// syntax pipeline through the [`crate::types::Host`] trait.
3832 ///
3833 /// Returns an empty vec when there is nothing to highlight or
3834 /// `line` is out of bounds.
3835 pub fn highlights_for_line(&mut self, line: u32) -> Vec<crate::types::Highlight> {
3836 use crate::types::{Highlight, HighlightKind, Pos};
3837 let row = line as usize;
3838 if row >= buf_row_count(&self.buffer) {
3839 return Vec::new();
3840 }
3841
3842 // Live preview while the prompt is open beats the committed
3843 // pattern.
3844 if let Some(prompt) = self.search_prompt() {
3845 if prompt.text.is_empty() {
3846 return Vec::new();
3847 }
3848 use crate::search::{CaseMode, resolve_case_mode};
3849 let base =
3850 CaseMode::from_options(self.settings().ignore_case, self.settings().smartcase);
3851 let last_sub = self.last_substitute_replacement();
3852 let (stripped, mode) = resolve_case_mode(&prompt.text, base, &last_sub);
3853 let src = if mode == CaseMode::Insensitive {
3854 format!("(?i){stripped}")
3855 } else {
3856 stripped
3857 };
3858 let Ok(re) = regex::Regex::new(&src) else {
3859 return Vec::new();
3860 };
3861 let Some(haystack) = buf_line(&self.buffer, row) else {
3862 return Vec::new();
3863 };
3864 return re
3865 .find_iter(&haystack)
3866 .map(|m| Highlight {
3867 range: Pos {
3868 line,
3869 col: m.start() as u32,
3870 }..Pos {
3871 line,
3872 col: m.end() as u32,
3873 },
3874 kind: HighlightKind::IncSearch,
3875 })
3876 .collect();
3877 }
3878
3879 if self.search_state.pattern.is_none() {
3880 return Vec::new();
3881 }
3882 let dgen = crate::types::Query::dirty_gen(&self.buffer);
3883 crate::search::search_matches(&self.buffer, &mut self.search_state, dgen, row)
3884 .iter()
3885 .map(|&(start, end)| Highlight {
3886 range: Pos {
3887 line,
3888 col: start as u32,
3889 }..Pos {
3890 line,
3891 col: end as u32,
3892 },
3893 kind: HighlightKind::SearchMatch,
3894 })
3895 .collect()
3896 }
3897
3898 /// Populate the per-row hlsearch match cache for rows `top..bottom`
3899 /// (no-op when no pattern). Lets the renderer read cached byte ranges
3900 /// instead of re-scanning each visible line every frame.
3901 pub fn populate_search_cache(&mut self, top: usize, bottom: usize) {
3902 if self.search_state.pattern.is_none() {
3903 return;
3904 }
3905 let dgen = crate::types::Query::dirty_gen(&self.buffer);
3906 let end = bottom.min(crate::types::Query::line_count(&self.buffer) as usize);
3907 for row in top..end {
3908 crate::search::warm_matches(&self.buffer, &mut self.search_state, dgen, row);
3909 }
3910 }
3911
3912 /// Build the engine's [`crate::types::RenderFrame`] for the
3913 /// current state. Hosts call this once per redraw and diff
3914 /// across frames.
3915 ///
3916 /// Coarse today — covers mode + cursor + cursor shape + viewport
3917 /// top + line count. SPEC-target fields (selections, highlights,
3918 /// command line, search prompt, status line) land once trait
3919 /// extraction routes them through `SelectionSet` and the
3920 /// `Highlight` pipeline.
3921 pub fn render_frame(&self) -> crate::types::RenderFrame {
3922 use crate::types::{CursorShape, RenderFrame, SnapshotMode};
3923 let (cursor_row, cursor_col) = self.cursor();
3924 // Coarse, not vim: render output must not depend on which discipline
3925 // is installed (#265). CoarseMode is a bijection with SnapshotMode.
3926 let (mode, shape) = match self.coarse_mode() {
3927 crate::CoarseMode::Normal => (SnapshotMode::Normal, CursorShape::Block),
3928 crate::CoarseMode::Insert => (SnapshotMode::Insert, CursorShape::Bar),
3929 crate::CoarseMode::Select => (SnapshotMode::Visual, CursorShape::Block),
3930 crate::CoarseMode::SelectLine => (SnapshotMode::VisualLine, CursorShape::Block),
3931 crate::CoarseMode::SelectBlock => (SnapshotMode::VisualBlock, CursorShape::Block),
3932 };
3933 RenderFrame {
3934 mode,
3935 cursor_row: cursor_row as u32,
3936 cursor_col: cursor_col as u32,
3937 cursor_shape: shape,
3938 viewport_top: self.host.viewport().top_row as u32,
3939 line_count: crate::types::Query::line_count(&self.buffer),
3940 }
3941 }
3942
3943 /// Capture the editor's coarse state into a serde-friendly
3944 /// [`crate::types::EditorSnapshot`].
3945 ///
3946 /// Today's snapshot covers mode, cursor, lines, viewport top.
3947 /// Registers, marks, jump list, undo tree, and full options arrive
3948 /// once phase 5 trait extraction lands the generic
3949 /// `Editor<B: View, H: Host>` constructor — this method's surface
3950 /// stays stable; only the snapshot's internal fields grow.
3951 ///
3952 /// Distinct from the internal `snapshot` used by undo (which
3953 /// returns `(Vec<String>, (usize, usize))`); host-facing
3954 /// persistence goes through this one.
3955 pub fn take_snapshot(&self) -> crate::types::EditorSnapshot {
3956 use crate::types::{EditorSnapshot, SnapshotMode};
3957 let mode = match self.coarse_mode() {
3958 crate::CoarseMode::Normal => SnapshotMode::Normal,
3959 crate::CoarseMode::Insert => SnapshotMode::Insert,
3960 crate::CoarseMode::Select => SnapshotMode::Visual,
3961 crate::CoarseMode::SelectLine => SnapshotMode::VisualLine,
3962 crate::CoarseMode::SelectBlock => SnapshotMode::VisualBlock,
3963 };
3964 let cursor = self.cursor();
3965 let cursor = (cursor.0 as u32, cursor.1 as u32);
3966 let rope = crate::types::Query::rope(&self.buffer);
3967 let lines: Vec<String> = (0..rope.len_lines())
3968 .map(|r| {
3969 let s = rope.line(r).to_string();
3970 if s.ends_with('\n') {
3971 s[..s.len() - 1].to_string()
3972 } else {
3973 s
3974 }
3975 })
3976 .collect();
3977 let viewport_top = self.host.viewport().top_row as u32;
3978 let marks = self
3979 .buffer
3980 .marks_cloned()
3981 .into_iter()
3982 .map(|(c, (r, col))| (c, (r as u32, col as u32)))
3983 .collect();
3984 let global_marks = self
3985 .global_marks
3986 .lock()
3987 .unwrap()
3988 .iter()
3989 .map(|(c, &(bid, r, col))| (*c, (bid, r as u32, col as u32)))
3990 .collect();
3991 EditorSnapshot {
3992 version: EditorSnapshot::VERSION,
3993 mode,
3994 cursor,
3995 lines,
3996 viewport_top,
3997 registers: self.registers.lock().unwrap().clone(),
3998 marks,
3999 global_marks,
4000 }
4001 }
4002
4003 /// Restore editor state from an [`EditorSnapshot`]. Returns
4004 /// [`crate::EngineError::SnapshotVersion`] if the snapshot's
4005 /// `version` doesn't match [`EditorSnapshot::VERSION`].
4006 ///
4007 /// Mode is best-effort: `SnapshotMode` only round-trips the
4008 /// status-line summary, not the full FSM state. Visual / Insert
4009 /// mode entry happens through synthetic key dispatch when needed.
4010 pub fn restore_snapshot(
4011 &mut self,
4012 snap: crate::types::EditorSnapshot,
4013 ) -> Result<(), crate::EngineError> {
4014 use crate::types::EditorSnapshot;
4015 if snap.version != EditorSnapshot::VERSION {
4016 return Err(crate::EngineError::SnapshotVersion(
4017 snap.version,
4018 EditorSnapshot::VERSION,
4019 ));
4020 }
4021 let text = snap.lines.join("\n");
4022 self.set_content(&text);
4023 self.jump_cursor(snap.cursor.0 as usize, snap.cursor.1 as usize);
4024 self.host.viewport_mut().top_row = snap.viewport_top as usize;
4025 *self.registers.lock().unwrap() = snap.registers;
4026 self.buffer.set_marks(
4027 snap.marks
4028 .into_iter()
4029 .map(|(c, (r, col))| (c, (r as usize, col as usize)))
4030 .collect(),
4031 );
4032 *self.global_marks.lock().unwrap() = snap
4033 .global_marks
4034 .into_iter()
4035 .map(|(c, (bid, r, col))| (c, (bid, r as usize, col as usize)))
4036 .collect();
4037 Ok(())
4038 }
4039
4040 /// Install `text` as the pending yank buffer so the next `p`/`P` pastes
4041 /// it. Linewise is inferred from a trailing newline, matching how `yy`/`dd`
4042 /// shape their payload.
4043 pub fn seed_yank(&mut self, text: String) {
4044 let linewise = text.ends_with('\n');
4045 self.yank_linewise = linewise;
4046 self.registers.lock().unwrap().unnamed = crate::registers::Slot {
4047 text,
4048 linewise,
4049 ..Default::default()
4050 };
4051 }
4052
4053 /// Scroll the viewport down by `rows`. The cursor stays on its
4054 /// absolute line (vim convention) unless the scroll would take it
4055 /// off-screen — in that case it's clamped to the first row still
4056 /// visible.
4057 pub fn scroll_down(&mut self, rows: i16) {
4058 self.scroll_viewport(rows);
4059 }
4060
4061 /// Scroll the viewport up by `rows`. Cursor stays unless it would
4062 /// fall off the bottom of the new viewport, then clamp to the
4063 /// bottom-most visible row.
4064 pub fn scroll_up(&mut self, rows: i16) {
4065 self.scroll_viewport(-rows);
4066 }
4067
4068 /// Scroll the viewport right by `cols` columns. Only the horizontal
4069 /// offset (`top_col`) moves — the cursor is NOT adjusted (matches
4070 /// vim's `zl` behaviour for horizontal scroll without wrap).
4071 pub fn scroll_right(&mut self, cols: i16) {
4072 let vp = self.host.viewport_mut();
4073 let cols_i = cols as isize;
4074 let new_top = (vp.top_col as isize + cols_i).max(0) as usize;
4075 vp.top_col = new_top;
4076 }
4077
4078 /// Scroll the viewport left by `cols` columns. Delegates to
4079 /// `scroll_right` with a negated argument so the floor-at-zero
4080 /// clamp is shared.
4081 pub fn scroll_left(&mut self, cols: i16) {
4082 self.scroll_right(-cols);
4083 }
4084
4085 /// Scroll the viewport so the cursor stays at least `scrolloff`
4086 /// rows from each edge. Replaces the bare
4087 /// `View::ensure_cursor_visible` call at end-of-step so motions
4088 /// don't park the cursor on the very last visible row.
4089 pub fn ensure_cursor_in_scrolloff(&mut self) {
4090 let height = self.viewport_height.load(Ordering::Relaxed) as usize;
4091 if height == 0 {
4092 // 0.0.42 (Patch C-δ.7): viewport math lifted onto engine
4093 // free fns over `B: Query [+ Cursor]` + `&dyn FoldProvider`.
4094 // Disjoint-field borrow split: `self.buffer` (immutable via
4095 // `folds` snapshot + cursor) and `self.host` (mutable
4096 // viewport ref) live on distinct struct fields, so one
4097 // statement satisfies the borrow checker.
4098 let folds = crate::buffer_impl::BufferFoldProvider::new(&self.buffer);
4099 crate::viewport_math::ensure_cursor_visible(
4100 &self.buffer,
4101 &folds,
4102 self.host.viewport_mut(),
4103 );
4104 return;
4105 }
4106 // Cap margin at (height - 1) / 2 so the upper + lower bands
4107 // can't overlap on tiny windows (margin=5 + height=10 would
4108 // otherwise produce contradictory clamp ranges).
4109 let margin = self.settings.scrolloff.min(height.saturating_sub(1) / 2);
4110 // Screen rows ≠ doc rows only under soft-wrap (a doc row spans many
4111 // screen lines) or folds (a closed fold collapses many doc rows to
4112 // one); doc-row margin math drifts in those cases. Dispatch:
4113 // • wrap → the incremental screen-row walk.
4114 // • folds, no wrap → the O(height) fold-aware clamp below.
4115 // • neither → the fast O(1) doc-row math (every plain j/k/G).
4116 let wrapped = !matches!(self.host.viewport().wrap, hjkl_buffer::Wrap::None);
4117 if wrapped {
4118 self.ensure_scrolloff_vertical(height, margin);
4119 return;
4120 }
4121 if self.buffer.has_folds() {
4122 self.ensure_scrolloff_folds_nowrap(height, margin);
4123 // Column-side (horizontal) scroll only — keep the fold-aware
4124 // top_row by snapshotting it across `ensure_visible`.
4125 let cursor = buf_cursor_pos(&self.buffer);
4126 let saved_top = self.host.viewport().top_row;
4127 self.host.viewport_mut().ensure_visible(cursor);
4128 self.host.viewport_mut().top_row = saved_top;
4129 return;
4130 }
4131 let cursor_row = buf_cursor_row(&self.buffer);
4132 let last_row = buf_row_count(&self.buffer).saturating_sub(1);
4133 let v = self.host.viewport_mut();
4134 // Top edge: cursor_row should sit at >= top_row + margin.
4135 if cursor_row < v.top_row + margin {
4136 v.top_row = cursor_row.saturating_sub(margin);
4137 }
4138 // Bottom edge: cursor_row should sit at <= top_row + height - 1 - margin.
4139 let max_bottom = height.saturating_sub(1).saturating_sub(margin);
4140 if cursor_row > v.top_row + max_bottom {
4141 v.top_row = cursor_row.saturating_sub(max_bottom);
4142 }
4143 // Clamp top_row so we never scroll past the buffer's bottom.
4144 let max_top = last_row.saturating_sub(height.saturating_sub(1));
4145 if v.top_row > max_top {
4146 v.top_row = max_top;
4147 }
4148 // Column-side scroll (vim default `sidescrolloff = 0`).
4149 let cursor = buf_cursor_pos(&self.buffer);
4150 self.host.viewport_mut().ensure_visible(cursor);
4151 }
4152
4153 /// Fold-aware vertical scrolloff for `Wrap::None`, in **O(height)**.
4154 ///
4155 /// A closed fold collapses its body to one screen row, so the cursor's
4156 /// screen row is the count of *visible* rows above it — not the doc-row
4157 /// delta. Instead of re-walking that count on every candidate `top_row`
4158 /// (the pre-0.0.43 [`Self::ensure_scrolloff_vertical`], O(distance²) on
4159 /// a big jump like `G` over a fold-heavy file), compute the valid
4160 /// `top_row` window directly: at most `height-1-margin` visible rows may
4161 /// sit above the cursor (bottom edge) and at least `margin` (top edge).
4162 /// Walk those two bounds up from the cursor via `prev_visible_row`,
4163 /// clamp the current `top_row` into the window, then clamp to
4164 /// `max_top_for_height` so the buffer's bottom never leaves blank rows.
4165 /// Each walk is bounded by `height`, so the whole thing is O(height)
4166 /// regardless of jump distance.
4167 fn ensure_scrolloff_folds_nowrap(&mut self, height: usize, margin: usize) {
4168 let cursor_row = buf_cursor_row(&self.buffer);
4169 let max_csr = height.saturating_sub(1).saturating_sub(margin);
4170 // `top_lo`: the row `max_csr` visible rows above the cursor — `top_row`
4171 // must be >= this to keep the cursor within the bottom margin.
4172 let mut top_lo = cursor_row;
4173 for _ in 0..max_csr {
4174 match self.buffer.prev_visible_row(top_lo) {
4175 Some(p) => top_lo = p,
4176 None => break,
4177 }
4178 }
4179 // `top_hi`: the row `margin` visible rows above the cursor — `top_row`
4180 // must be <= this to keep the cursor below the top margin.
4181 let mut top_hi = cursor_row;
4182 for _ in 0..margin {
4183 match self.buffer.prev_visible_row(top_hi) {
4184 Some(p) => top_hi = p,
4185 None => break,
4186 }
4187 }
4188 // `max_csr >= margin` (margin is capped at (height-1)/2), so
4189 // `top_lo <= top_hi` and the clamp range is well-formed.
4190 let cur = self.host.viewport().top_row;
4191 let mut new_top = cur.clamp(top_lo, top_hi);
4192 let max_top = {
4193 let folds = crate::buffer_impl::BufferFoldProvider::new(&self.buffer);
4194 crate::viewport_math::max_top_for_height(
4195 &self.buffer,
4196 &folds,
4197 self.host.viewport(),
4198 height,
4199 )
4200 };
4201 if new_top > max_top {
4202 new_top = max_top;
4203 }
4204 self.host.viewport_mut().top_row = new_top;
4205 }
4206
4207 /// Screen-row-aware vertical scrolloff. Walks `top_row` one visible
4208 /// doc row at a time so the cursor's *screen* row stays inside
4209 /// `[margin, height - 1 - margin]`, then clamps `top_row` so the
4210 /// buffer's bottom never leaves blank rows below it.
4211 ///
4212 /// Correct under BOTH soft-wrap (a doc row spans many screen lines)
4213 /// and folds (a closed fold collapses many doc rows to one screen
4214 /// row): [`crate::viewport_math::cursor_screen_row_from`] counts
4215 /// visible/wrapped screen rows, so doc-row arithmetic can't drift the
4216 /// margin around a fold. Horizontal (column) scroll is the caller's
4217 /// job — this only moves `top_row`.
4218 fn ensure_scrolloff_vertical(&mut self, height: usize, margin: usize) {
4219 use crate::types::FoldProvider;
4220 let cursor_row = buf_cursor_row(&self.buffer);
4221 // Step 1 — cursor above viewport: snap top to cursor row,
4222 // then we'll fix up the margin below.
4223 if cursor_row < self.host.viewport().top_row {
4224 let v = self.host.viewport_mut();
4225 v.top_row = cursor_row;
4226 v.top_col = 0;
4227 }
4228 // Step 2 — push top forward until cursor's screen row is
4229 // within the bottom margin (`csr <= height - 1 - margin`).
4230 // 0.0.33 (Patch C-γ): fold-iteration goes through the
4231 // [`crate::types::FoldProvider`] surface via
4232 // [`crate::buffer_impl::BufferFoldProvider`]. 0.0.34 (Patch
4233 // C-δ.1): `cursor_screen_row` / `max_top_for_height` now take
4234 // a `&Viewport` parameter; the host owns the viewport, so the
4235 // disjoint `(self.host, self.buffer)` borrows split cleanly.
4236 let max_csr = height.saturating_sub(1).saturating_sub(margin);
4237 // The cursor's screen row from the current top, computed ONCE (one
4238 // linear pass) and then adjusted per dropped/added visible row —
4239 // the incremental walk [`crate::viewport_math::ensure_cursor_visible`]
4240 // uses. Re-running `cursor_screen_row_from` (itself O(distance))
4241 // per candidate `top_row` made a big soft-wrapped jump O(distance²);
4242 // subtracting/adding one row's wrap height per step keeps it
4243 // O(distance). `None` mirrors the old `unwrap_or(0)`: a cursor above
4244 // `top_row` (a stale per-window cursor past EOF, or a hidden cursor
4245 // row) reads as screen row 0, so step 2 no-ops and step 3 pulls
4246 // `top_row` back until the cursor enters the window.
4247 let row_count = buf_row_count(&self.buffer);
4248 let folds = crate::buffer_impl::BufferFoldProvider::new(&self.buffer);
4249 let rope = crate::types::Query::rope(&self.buffer);
4250 let v = *self.host.viewport();
4251 let mut screen = crate::viewport_math::cursor_screen_row_from(
4252 &self.buffer,
4253 &folds,
4254 self.host.viewport(),
4255 self.host.viewport().top_row,
4256 );
4257 // Step 2 — push top forward until cursor's screen row is
4258 // within the bottom margin (`csr <= height - 1 - margin`).
4259 if let Some(mut s) = screen {
4260 while s > max_csr {
4261 let top = self.host.viewport().top_row;
4262 let next =
4263 <crate::buffer_impl::BufferFoldProvider<'_> as crate::types::FoldProvider>::next_visible_row(&folds, top, row_count);
4264 let Some(next) = next else {
4265 break;
4266 };
4267 // Don't walk past the cursor's row. Only reachable when
4268 // `top` already equals the cursor's row (a visible cursor
4269 // row at-or-after `top` bounds `next_visible_row`), so the
4270 // screen value stays valid for step 3.
4271 if next > cursor_row {
4272 self.host.viewport_mut().top_row = cursor_row;
4273 break;
4274 }
4275 // Removing rows [top, next) from the top of the range drops
4276 // their visible heights (hidden rows contribute 0); after
4277 // this `s` equals `cursor_screen_row_from(..., next)`.
4278 for r in top..next {
4279 if !folds.is_row_hidden(r) {
4280 let line = crate::viewport_math::rope_line_slice(&rope, r);
4281 s -= hjkl_buffer::wrap::wrap_segments(&line, v.text_width, v.wrap).len();
4282 }
4283 }
4284 self.host.viewport_mut().top_row = next;
4285 }
4286 screen = Some(s);
4287 }
4288 // Step 3 — pull top backward until cursor's screen row is
4289 // past the top margin (`csr >= margin`). The same incremental walk,
4290 // run in reverse: `prev_visible_row` lands on the nearest visible
4291 // row above `top` (the rows between are hidden and contribute 0), so
4292 // pulling `top_row` back to `prev` adds exactly `prev`'s wrap height
4293 // back to the cursor's screen row.
4294 let clamped_cursor_row = cursor_row.min(row_count.saturating_sub(1));
4295 loop {
4296 match screen {
4297 Some(s) if s >= margin => break,
4298 // `None` reads as screen row 0: a zero margin satisfies
4299 // `csr >= margin` immediately, as in the old loop.
4300 None if margin == 0 => break,
4301 _ => {}
4302 }
4303 let top = self.host.viewport().top_row;
4304 // A `None` screen means the (clamped) cursor still sits above
4305 // the window; once `top` walks down to it, recompute the screen
4306 // row once and continue incrementally from there. A visible
4307 // clamped cursor row guarantees the recompute succeeds.
4308 if screen.is_none()
4309 && top <= clamped_cursor_row
4310 && !folds.is_row_hidden(clamped_cursor_row)
4311 {
4312 screen = crate::viewport_math::cursor_screen_row_from(
4313 &self.buffer,
4314 &folds,
4315 self.host.viewport(),
4316 top,
4317 );
4318 continue;
4319 }
4320 let prev =
4321 <crate::buffer_impl::BufferFoldProvider<'_> as crate::types::FoldProvider>::prev_visible_row(&folds, top);
4322 let Some(prev) = prev else {
4323 break;
4324 };
4325 if let Some(s) = screen {
4326 let line = crate::viewport_math::rope_line_slice(&rope, prev);
4327 screen =
4328 Some(s + hjkl_buffer::wrap::wrap_segments(&line, v.text_width, v.wrap).len());
4329 }
4330 self.host.viewport_mut().top_row = prev;
4331 }
4332 // Step 4 — clamp top so the buffer's bottom doesn't leave
4333 // blank rows below it. `max_top_for_height` walks segments
4334 // backward from the last row until it accumulates `height`
4335 // screen rows.
4336 let max_top = {
4337 let folds = crate::buffer_impl::BufferFoldProvider::new(&self.buffer);
4338 crate::viewport_math::max_top_for_height(
4339 &self.buffer,
4340 &folds,
4341 self.host.viewport(),
4342 height,
4343 )
4344 };
4345 if self.host.viewport().top_row > max_top {
4346 self.host.viewport_mut().top_row = max_top;
4347 }
4348 self.host.viewport_mut().top_col = 0;
4349 }
4350
4351 fn scroll_viewport(&mut self, delta: i16) {
4352 if delta == 0 {
4353 return;
4354 }
4355 // Bump the host viewport's top within bounds.
4356 let total_rows = buf_row_count(&self.buffer) as isize;
4357 let height = self.viewport_height.load(Ordering::Relaxed) as usize;
4358 let cur_top = self.host.viewport().top_row as isize;
4359 let new_top = (cur_top + delta as isize)
4360 .max(0)
4361 .min((total_rows - 1).max(0)) as usize;
4362 self.host.viewport_mut().top_row = new_top;
4363 if height == 0 {
4364 return;
4365 }
4366 // Apply scrolloff: keep the cursor at least scrolloff rows
4367 // from the visible viewport edges.
4368 let (cursor_row, cursor_col) = buf_cursor_rc(&self.buffer);
4369 let margin = self.settings.scrolloff.min(height / 2);
4370 let min_row = new_top + margin;
4371 let max_row = new_top + height.saturating_sub(1).saturating_sub(margin);
4372 let target_row = cursor_row.clamp(min_row, max_row.max(min_row));
4373 if target_row != cursor_row {
4374 let line_len = buf_line(&self.buffer, target_row).map_or(0, |l| l.chars().count());
4375 let target_col = cursor_col.min(line_len.saturating_sub(1));
4376 buf_set_cursor_rc(&mut self.buffer, target_row, target_col);
4377 }
4378 }
4379
4380 pub fn goto_line(&mut self, line: usize) {
4381 let row = line.saturating_sub(1);
4382 let max = buf_row_count(&self.buffer).saturating_sub(1);
4383 let target = row.min(max);
4384 // If the target row is hidden inside one or more closed folds, open
4385 // every fold that collapses it so the landing line is actually
4386 // visible — a jump to an unseen row is useless. `reveal_row` opens
4387 // all hiding folds (outer + nested) in one pass; `open_fold_at` /
4388 // `FoldOp::OpenAt` can't, because they only act on the first fold
4389 // containing the row and so can never reach a nested inner fold.
4390 self.buffer.reveal_row(target);
4391 buf_set_cursor_rc(&mut self.buffer, target, 0);
4392 // Vim: `:N` / `+N` jump scrolls the viewport too — without this
4393 // the cursor lands off-screen and the user has to scroll
4394 // manually to see it.
4395 self.ensure_cursor_in_scrolloff();
4396 }
4397
4398 /// Scroll so the cursor row lands at the given viewport position:
4399 /// `Center` → middle row, `Top` → first row, `Bottom` → last row.
4400 /// Cursor stays on its absolute line; only the viewport moves.
4401 pub fn scroll_cursor_to(&mut self, pos: CursorScrollTarget) {
4402 let height = self.viewport_height.load(Ordering::Relaxed) as usize;
4403 if height == 0 {
4404 return;
4405 }
4406 let cur_row = buf_cursor_row(&self.buffer);
4407 let cur_top = self.host.viewport().top_row;
4408 // Scrolloff awareness: `zt` lands the cursor at the top edge
4409 // of the viable area (top + margin), `zb` at the bottom edge
4410 // (top + height - 1 - margin). Match the cap used by
4411 // `ensure_cursor_in_scrolloff` so contradictory bounds are
4412 // impossible on tiny viewports.
4413 let margin = self.settings.scrolloff.min(height.saturating_sub(1) / 2);
4414 let new_top = match pos {
4415 CursorScrollTarget::Center => cur_row.saturating_sub(height / 2),
4416 CursorScrollTarget::Top => cur_row.saturating_sub(margin),
4417 CursorScrollTarget::Bottom => {
4418 cur_row.saturating_sub(height.saturating_sub(1).saturating_sub(margin))
4419 }
4420 };
4421 if new_top == cur_top {
4422 return;
4423 }
4424 self.host.viewport_mut().top_row = new_top;
4425 }
4426
4427 /// Jump the cursor to the given 1-based line/column, clamped to the document.
4428 pub fn jump_to(&mut self, line: usize, col: usize) {
4429 let r = line.saturating_sub(1);
4430 let max_row = buf_row_count(&self.buffer).saturating_sub(1);
4431 let r = r.min(max_row);
4432 let line_len = buf_line(&self.buffer, r).map_or(0, |l| l.chars().count());
4433 let c = col.saturating_sub(1).min(line_len);
4434 buf_set_cursor_rc(&mut self.buffer, r, c);
4435 }
4436
4437 // ── Host-agnostic doc-coord mouse primitives (Phase 1 of issue #114) ─────
4438 //
4439 // These primitives operate on document (row, col) coordinates that the HOST
4440 // computes from its own layout knowledge (cell geometry for the TUI host,
4441 // pixel geometry for the future GUI host). The engine has no u16 terminal
4442 // assumption here — it just moves the cursor in doc-space.
4443
4444 /// Set the cursor to the given doc-space `(row, col)`, clamped to the
4445 /// document bounds. Hosts use this for programmatic cursor placement and
4446 /// as the building block for the mouse-click path.
4447 ///
4448 /// `col` may equal `line.chars().count()` (Insert-mode "one past end"
4449 /// position); values beyond that are clamped to `char_count`.
4450 pub fn set_cursor_doc(&mut self, row: usize, col: usize) {
4451 let max_row = buf_row_count(&self.buffer).saturating_sub(1);
4452 let r = row.min(max_row);
4453 let line_len = buf_line(&self.buffer, r).map_or(0, |l| l.chars().count());
4454 let c = col.min(line_len);
4455 buf_set_cursor_rc(&mut self.buffer, r, c);
4456 }
4457
4458 /// Extend an in-progress mouse drag to doc-space `(row, col)`.
4459 ///
4460 /// Moves the live cursor; the Visual anchor stays where
4461 /// [`Editor::mouse_begin_drag`] set it. Call after the host has
4462 /// translated the drag position to doc coordinates.
4463 pub fn mouse_extend_drag_doc(&mut self, row: usize, col: usize) {
4464 self.set_cursor_doc(row, col);
4465 }
4466
4467 pub fn insert_str(&mut self, text: &str) {
4468 let pos = crate::types::Cursor::cursor(&self.buffer);
4469 crate::types::BufferEdit::insert_at(&mut self.buffer, pos, text);
4470 self.push_buffer_content_to_textarea();
4471 self.mark_content_dirty();
4472 }
4473
4474 pub fn accept_completion(&mut self, completion: &str) {
4475 use crate::types::{BufferEdit, Cursor as CursorTrait, Pos};
4476 let cursor_pos = CursorTrait::cursor(&self.buffer);
4477 let cursor_row = cursor_pos.line as usize;
4478 let cursor_col = cursor_pos.col as usize;
4479 let line = buf_line(&self.buffer, cursor_row).unwrap_or_default();
4480 let chars: Vec<char> = line.chars().collect();
4481 let prefix_len = chars[..cursor_col.min(chars.len())]
4482 .iter()
4483 .rev()
4484 .take_while(|c| c.is_alphanumeric() || **c == '_')
4485 .count();
4486 if prefix_len > 0 {
4487 let start = Pos {
4488 line: cursor_row as u32,
4489 col: (cursor_col - prefix_len) as u32,
4490 };
4491 BufferEdit::delete_range(&mut self.buffer, start..cursor_pos);
4492 }
4493 let cursor = CursorTrait::cursor(&self.buffer);
4494 BufferEdit::insert_at(&mut self.buffer, cursor, completion);
4495 self.push_buffer_content_to_textarea();
4496 self.mark_content_dirty();
4497 }
4498
4499 /// Capture the buffer state for undo / redo. Uses
4500 /// [`Query::content_joined`], which the `View` impl caches as an
4501 /// `Arc<String>` against `dirty_gen` — so when LSP / git / syntax
4502 /// already joined this generation, the snapshot is an `Arc::clone`
4503 /// (one ptr bump). Previously this cloned every line into a
4504 /// `Vec<String>` (162 k allocations on a 162 k-row buffer) and the
4505 /// matching `restore` re-joined them — samply showed it at ~9 % of
4506 /// CPU on a big-paste session.
4507 pub(super) fn snapshot(&self) -> (ropey::Rope, (usize, usize)) {
4508 use crate::types::Query;
4509 let rc = buf_cursor_rc(&self.buffer);
4510 (Query::rope(&self.buffer), rc)
4511 }
4512
4513 /// Snapshot the buffer-scoped "edit coherence" state alongside a rope
4514 /// snapshot, so undo/redo can restore marks/jumplist/changelist, not
4515 /// just text (audit-r2 fix 2).
4516 ///
4517 /// Called at all three `UndoEntry` construction sites
4518 /// (`push_undo_at`, `undo_core`, `redo_core`) with the LIVE state at
4519 /// push time — never the popped entry's own snapshot, since the entry
4520 /// being pushed describes "the other side" of the history walk (e.g.
4521 /// `undo_core`'s redo-push needs the CURRENT, post-edit marks so a
4522 /// later redo restores them, not the pre-edit marks it's about to
4523 /// pop).
4524 pub(super) fn snapshot_marks(&self) -> hjkl_buffer::MarkSnapshot {
4525 let cur_bid = self.current_buffer_id;
4526 let global_marks = self
4527 .global_marks
4528 .lock()
4529 .unwrap()
4530 .iter()
4531 .filter(|(_, (bid, _, _))| *bid == cur_bid)
4532 .map(|(c, (_, row, col))| (*c, (*row, *col)))
4533 .collect();
4534 let bank = self.change_bank.lock().unwrap();
4535 hjkl_buffer::MarkSnapshot {
4536 local_marks: self.buffer.marks_cloned(),
4537 jump_back: self.jump_back.clone(),
4538 jump_fwd: self.jump_fwd.clone(),
4539 change_last_edit: bank.last_edit,
4540 change_list: bank.list.clone(),
4541 change_cursor: bank.cursor,
4542 global_marks,
4543 }
4544 }
4545
4546 /// Restore the buffer-scoped state captured by [`Editor::snapshot_marks`]
4547 /// — the undo/redo counterpart to `restore_rope`/`restore_text`.
4548 ///
4549 /// Only entries belonging to THIS buffer (`current_buffer_id`) are
4550 /// touched in the session-global `global_marks` map: other buffers'
4551 /// global marks are left completely alone. Local marks and the
4552 /// changelist bank are already per-buffer (shared via `Arc` across
4553 /// windows on the same buffer, same as the text), so restoring them
4554 /// here is visible to every window on this buffer, matching vim.
4555 pub(super) fn restore_marks(&mut self, snap: &hjkl_buffer::MarkSnapshot) {
4556 self.buffer.set_marks(snap.local_marks.clone());
4557 self.jump_back.clone_from(&snap.jump_back);
4558 self.jump_fwd.clone_from(&snap.jump_fwd);
4559 {
4560 let mut bank = self.change_bank.lock().unwrap();
4561 bank.last_edit = snap.change_last_edit;
4562 bank.list.clone_from(&snap.change_list);
4563 bank.cursor = snap.change_cursor;
4564 }
4565 let cur_bid = self.current_buffer_id;
4566 let mut global_marks = self.global_marks.lock().unwrap();
4567 global_marks.retain(|_, (bid, _, _)| *bid != cur_bid);
4568 for (c, (row, col)) in snap.global_marks.iter() {
4569 global_marks.insert(*c, (cur_bid, *row, *col));
4570 }
4571 }
4572
4573 // ── Undo / redo (discipline-agnostic, #265) ──────────────────────────────
4574 //
4575 // The rope-level work is generic — every discipline undoes. The only
4576 // discipline-specific part is what state the editor is left in afterwards,
4577 // which goes through `DisciplineState::reset_to_idle` plus a coarse cursor
4578 // clamp, so the engine never names vim.
4579
4580 /// Rope-level undo, then return the discipline to idle.
4581 ///
4582 /// Drives the undo arena tree: [`View::undo_step`](hjkl_buffer::View) writes
4583 /// the live state into the node we leave (that node becomes the redo target)
4584 /// and returns the parent snapshot to restore. Behaviourally identical to
4585 /// the old pop-undo / push-redo dance — the moved-across node inherits the
4586 /// destination's timestamp, exactly as the old redo entry did.
4587 fn undo_core(&mut self) {
4588 if !self.buffer.undo_stack_is_empty() {
4589 let (cur_rope, cur_cursor) = self.snapshot();
4590 let cur_marks = self.snapshot_marks();
4591 if let Some(entry) = self.buffer.undo_step(cur_rope, cur_cursor, cur_marks) {
4592 self.restore_rope(&entry.rope, entry.cursor);
4593 self.restore_marks(&entry.marks);
4594 }
4595 }
4596 self.settle_after_history_jump();
4597 }
4598
4599 /// Rope-level redo, then return the discipline to idle.
4600 fn redo_core(&mut self) {
4601 if !self.buffer.redo_stack_is_empty() {
4602 let (cur_rope, cur_cursor) = self.snapshot();
4603 let cur_marks = self.snapshot_marks();
4604 let before = cur_rope.clone();
4605 if let Some(entry) = self.buffer.redo_step(cur_rope, cur_cursor, cur_marks) {
4606 self.cap_undo();
4607 self.restore_rope(&entry.rope, entry.cursor);
4608 self.restore_marks(&entry.marks);
4609 // Park the cursor at the START of the reapplied change rather
4610 // than the end-of-insert position stored in the redo snapshot
4611 // (vim parity). Recompute from the first differing character.
4612 let after = crate::types::Query::rope(&self.buffer);
4613 if let Some((row, col)) = first_diff_pos(&before, &after) {
4614 buf_set_cursor_rc(&mut self.buffer, row, col);
4615 }
4616 }
4617 }
4618 self.settle_after_history_jump();
4619 }
4620
4621 /// Leave the editor in a known resting state after jumping through history
4622 /// (undo / redo) or after a `:!` filter rewrote the buffer.
4623 ///
4624 /// Asks the installed discipline to put its *mode* back to idle — without
4625 /// discarding an open insert session, which vscode-mode undo depends on —
4626 /// then clamps the cursor to a valid column.
4627 pub(crate) fn settle_after_history_jump(&mut self) {
4628 self.discipline.reset_mode_after_history();
4629 // Undo / redo restore a whole snapshot: the secondary selections were
4630 // computed against a document that no longer exists, and nothing tracked
4631 // them across the rewind. Drop them rather than leave carets pointing at
4632 // text that moved — the same "drop, never guess" rule `selection_shift`
4633 // applies to a single untrackable edit.
4634 self.extra_selections.clear();
4635 // Unconditional clamp: the restored cursor came from a snapshot that may
4636 // have been taken mid-insert and can sit one past the last valid column.
4637 let (row, col) = self.cursor();
4638 let max_col = buf_line_chars(&self.buffer, row).saturating_sub(1);
4639 if col > max_col {
4640 buf_set_cursor_rc(&mut self.buffer, row, max_col);
4641 }
4642 // audit-r2 fix 3(a): vim's 'foldopen' option includes "undo" — an
4643 // undo/redo that lands the cursor inside a closed fold's body must
4644 // reveal it, not strand the cursor on a hidden row with no way to
4645 // see what it's sitting on. `reveal_row` already opens every fold
4646 // (at any nesting depth) that hides a row in one pass; loop it
4647 // defensively — bounded by the fold count — so a row that's
4648 // somehow still hidden after one reveal (e.g. a future change to
4649 // `reveal_row`'s semantics) keeps getting opened rather than
4650 // silently left stranded.
4651 let row = buf_cursor_row(&self.buffer);
4652 let max_iters = self.buffer.with_folds(<[hjkl_buffer::Fold]>::len) + 1;
4653 for _ in 0..max_iters {
4654 if !self.buffer.is_row_hidden(row) {
4655 break;
4656 }
4657 if !self.buffer.reveal_row(row) {
4658 break;
4659 }
4660 }
4661 }
4662
4663 /// Walk one step back through the undo history. Equivalent to the
4664 /// user pressing `u` in normal mode. Drains the most recent undo
4665 /// entry and pushes it onto the redo stack.
4666 pub fn undo(&mut self) {
4667 self.undo_core();
4668 }
4669
4670 /// Walk one step forward through the redo history. Equivalent to
4671 /// `<C-r>` in normal mode.
4672 pub fn redo(&mut self) {
4673 self.redo_core();
4674 }
4675
4676 /// `[count]u` — undo `n` times, BRANCH-LOCAL (each step walks to the parent
4677 /// on the current branch, not the seq order). This is what `u` binds to;
4678 /// `g-`/`:earlier` use the tree-wide [`earlier_by_steps`](Self::earlier_by_steps)
4679 /// seq walk instead. Stops at the branch root.
4680 pub fn undo_by_steps(&mut self, n: usize) -> usize {
4681 let mut count = 0;
4682 for _ in 0..n {
4683 if self.buffer.undo_stack_is_empty() {
4684 break;
4685 }
4686 self.undo_core();
4687 count += 1;
4688 }
4689 count
4690 }
4691
4692 /// `[count]<C-r>` — redo `n` times, BRANCH-LOCAL (each step follows
4693 /// `last_child`). Counterpart to [`undo_by_steps`](Self::undo_by_steps).
4694 pub fn redo_by_steps(&mut self, n: usize) -> usize {
4695 let mut count = 0;
4696 for _ in 0..n {
4697 if self.buffer.redo_stack_is_empty() {
4698 break;
4699 }
4700 self.redo_core();
4701 count += 1;
4702 }
4703 count
4704 }
4705
4706 /// `U` (`:h U`): restore the line where the latest change was made to
4707 /// its state before that run of changes began — NOT necessarily the
4708 /// line the cursor is currently on (moving the cursor away without
4709 /// editing doesn't retarget `U`). A no-op when nothing has changed
4710 /// on the tracked line relative to the stored snapshot (either
4711 /// nothing has been edited yet, or a prior `U` already restored it).
4712 ///
4713 /// `U` is itself a change: it pushes one undo entry (so a plain `u`
4714 /// right after `U` undoes the restore), and it swaps the stored
4715 /// snapshot to the text it just replaced, so a second `U` toggles
4716 /// back and re-applies the changes the first one undid.
4717 pub fn undo_line(&mut self) {
4718 let target = self.change_bank.lock().unwrap().u_line.clone();
4719 let Some((row, snapshot)) = target else {
4720 return;
4721 };
4722 if row >= buf_row_count(&self.buffer) {
4723 return;
4724 }
4725 let current = buf_line(&self.buffer, row).unwrap_or_default();
4726 if current == snapshot {
4727 return;
4728 }
4729 self.push_undo();
4730 let line_chars = buf_line_chars(&self.buffer, row);
4731 self.suppress_u_line_track = true;
4732 self.mutate_edit(hjkl_buffer::Edit::DeleteRange {
4733 start: hjkl_buffer::Position::new(row, 0),
4734 end: hjkl_buffer::Position::new(row, line_chars),
4735 kind: hjkl_buffer::MotionKind::Char,
4736 });
4737 self.mutate_edit(hjkl_buffer::Edit::InsertStr {
4738 at: hjkl_buffer::Position::new(row, 0),
4739 text: snapshot,
4740 });
4741 self.suppress_u_line_track = false;
4742 self.change_bank.lock().unwrap().u_line = Some((row, current));
4743 buf_set_cursor_rc(&mut self.buffer, row, 0);
4744 }
4745
4746 /// One `g-` step: restore the next-lower-`seq` state anywhere in the undo
4747 /// tree. Branch-crossing counterpart of
4748 /// [`undo_core`](Self::undo_core); restores the destination snapshot exactly
4749 /// like an undo. Returns `false` when already at the lowest state.
4750 fn seq_earlier_core(&mut self) -> bool {
4751 let (cur_rope, cur_cursor) = self.snapshot();
4752 let cur_marks = self.snapshot_marks();
4753 if let Some(entry) = self
4754 .buffer
4755 .seq_earlier_step(cur_rope, cur_cursor, cur_marks)
4756 {
4757 self.restore_rope(&entry.rope, entry.cursor);
4758 self.restore_marks(&entry.marks);
4759 self.settle_after_history_jump();
4760 true
4761 } else {
4762 false
4763 }
4764 }
4765
4766 /// One `g+` step: restore the next-higher-`seq` state anywhere in the undo
4767 /// tree. Branch-crossing counterpart of [`redo_core`](Self::redo_core),
4768 /// including its vim-parity cursor-park at the start of the reapplied
4769 /// change. Returns `false` when already at the highest state.
4770 fn seq_later_core(&mut self) -> bool {
4771 let (cur_rope, cur_cursor) = self.snapshot();
4772 let cur_marks = self.snapshot_marks();
4773 let before = cur_rope.clone();
4774 if let Some(entry) = self.buffer.seq_later_step(cur_rope, cur_cursor, cur_marks) {
4775 self.cap_undo();
4776 self.restore_rope(&entry.rope, entry.cursor);
4777 self.restore_marks(&entry.marks);
4778 let after = crate::types::Query::rope(&self.buffer);
4779 if let Some((row, col)) = first_diff_pos(&before, &after) {
4780 buf_set_cursor_rc(&mut self.buffer, row, col);
4781 }
4782 self.settle_after_history_jump();
4783 true
4784 } else {
4785 false
4786 }
4787 }
4788
4789 /// `g-` / `:earlier N` — travel `n` states back through the undo TREE by
4790 /// `seq` (crossing branches), not the branch-local `u` path. Returns the
4791 /// number of steps actually applied (clamped at the oldest state).
4792 pub fn earlier_by_steps(&mut self, n: usize) -> usize {
4793 let mut count = 0;
4794 for _ in 0..n {
4795 if self.seq_earlier_core() {
4796 count += 1;
4797 } else {
4798 break;
4799 }
4800 }
4801 count
4802 }
4803
4804 /// `g+` / `:later N` — travel `n` states forward through the undo TREE by
4805 /// `seq`. Returns the number of steps actually applied (clamped at the
4806 /// newest state).
4807 pub fn later_by_steps(&mut self, n: usize) -> usize {
4808 let mut count = 0;
4809 for _ in 0..n {
4810 if self.seq_later_core() {
4811 count += 1;
4812 } else {
4813 break;
4814 }
4815 }
4816 count
4817 }
4818
4819 /// Travel back through the tree (by `seq`) while the next-older state's
4820 /// timestamp is strictly greater than `target`; stop once it is at/below.
4821 /// Returns the number of steps applied.
4822 ///
4823 /// Vim `:earlier Ns` semantics: `target = SystemTime::now() - N seconds`.
4824 /// The walk is tree-wide (same seq order as `g-`), so it crosses branches.
4825 pub fn earlier_by_time(&mut self, target: SystemTime) -> usize {
4826 let mut count = 0;
4827 loop {
4828 match self.buffer.seq_earlier_timestamp() {
4829 None => break,
4830 Some(ts) => {
4831 if ts <= target {
4832 break;
4833 }
4834 }
4835 }
4836 if self.seq_earlier_core() {
4837 count += 1;
4838 } else {
4839 break;
4840 }
4841 }
4842 count
4843 }
4844
4845 /// Travel forward through the tree (by `seq`) while the next-newer state's
4846 /// timestamp is at/below `target`. Returns the number of steps applied.
4847 ///
4848 /// Vim `:later Ns` semantics: `target = current_state_time + N seconds`.
4849 pub fn later_by_time(&mut self, target: SystemTime) -> usize {
4850 let mut count = 0;
4851 loop {
4852 match self.buffer.seq_later_timestamp() {
4853 None => break,
4854 Some(ts) => {
4855 if ts > target {
4856 break;
4857 }
4858 }
4859 }
4860 if self.seq_later_core() {
4861 count += 1;
4862 } else {
4863 break;
4864 }
4865 }
4866 count
4867 }
4868
4869 /// Undo-tree leaves for `:undolist`: `(seq, changes/depth, timestamp,
4870 /// is_current)` sorted by `seq`. Like nvim, `:undolist` shows only branch
4871 /// leaves, not every intermediate node.
4872 pub fn undo_leaves(&self) -> Vec<(u64, usize, SystemTime, bool)> {
4873 self.buffer.undo_leaves()
4874 }
4875
4876 /// Snapshot current buffer state onto the undo stack and clear
4877 /// the redo stack. Bounded by `settings.undo_levels` — older
4878 /// entries pruned. Call before any group of buffer mutations the
4879 /// user might want to undo as a single step.
4880 pub fn push_undo(&mut self) {
4881 self.push_undo_at(SystemTime::now());
4882 }
4883
4884 /// Open an undo group. Every [`push_undo`](Self::push_undo) until the
4885 /// returned guard drops collapses into a single undo step. Re-entrant
4886 /// (depth-counted): nested `undo_group()` calls just nest, and only the
4887 /// OUTERMOST close commits — so a `:g` whose sub-command is itself grouped
4888 /// still yields one undo step. A group that mutates nothing leaves zero
4889 /// undo entries. Closing on `Drop` makes it early-return / panic safe.
4890 ///
4891 /// The returned guard is `#[must_use]`;
4892 /// bind it (`let _g = …`) so it lives for the whole grouped operation.
4893 pub fn undo_group(&mut self) -> UndoGroup {
4894 let content = self.buffer.content_arc();
4895 content.lock().unwrap().undo_group_enter();
4896 UndoGroup { content }
4897 }
4898
4899 /// Like [`push_undo`] but uses a caller-supplied timestamp. Used by
4900 /// tests that need deterministic time values without `sleep`.
4901 #[doc(hidden)]
4902 pub fn push_undo_at(&mut self, timestamp: SystemTime) {
4903 // Inside an open undo group, coalesce: only the FIRST mutating
4904 // push_undo in the outermost group takes a snapshot; every later one
4905 // is suppressed (no create-then-pop). At depth 0 (`undo_group_active`
4906 // is false) the `&&` short-circuits before `undo_group_arm`, so no
4907 // group state is touched and the path below is byte-identical to the
4908 // pre-group behavior.
4909 if self.buffer.undo_group_active() && !self.buffer.undo_group_arm() {
4910 return;
4911 }
4912 let (rope, cursor) = self.snapshot();
4913 let marks = self.snapshot_marks();
4914 self.buffer.push_undo_entry(hjkl_buffer::UndoEntry {
4915 rope,
4916 cursor,
4917 timestamp,
4918 marks,
4919 });
4920 self.cap_undo();
4921 self.buffer.clear_redo();
4922 }
4923
4924 /// Trim the undo stack down to `settings.undo_levels`, dropping
4925 /// the oldest entries. `undo_levels == 0` is treated as
4926 /// "unlimited" (vim's 0-means-no-undo semantics intentionally
4927 /// skipped — guarding with `> 0` is one line shorter than gating
4928 /// the cap path with an explicit zero-check above the call site).
4929 pub(crate) fn cap_undo(&mut self) {
4930 let cap = self.settings.undo_levels as usize;
4931 self.buffer.cap_undo(cap);
4932 }
4933
4934 /// Test-only accessor for the undo stack length.
4935 #[doc(hidden)]
4936 pub fn undo_stack_len(&self) -> usize {
4937 self.buffer.undo_stack_len()
4938 }
4939
4940 /// Replace the buffer with `lines` joined by `\n` and set the
4941 /// cursor to `cursor`. Used by undo / `:e!` / snapshot restore
4942 /// paths. Marks the editor dirty.
4943 ///
4944 /// Emits a single whole-buffer `ContentEdit` describing the
4945 /// transition so the syntax layer can apply it as an `InputEdit`
4946 /// on the retained tree and run an INCREMENTAL parse — tree-sitter
4947 /// reuses unchanged subtrees and `Tree::changed_ranges` reports
4948 /// just the bytes that differ, which lets the install path walk
4949 /// only the changed rows instead of the full viewport. Big undos
4950 /// that revert a large paste now refresh in ~1ms per affected
4951 /// row instead of a ~30ms full-viewport sync walk.
4952 pub fn restore(&mut self, lines: &[String], cursor: (usize, usize)) {
4953 let text = lines.join("\n");
4954 self.restore_text(&text, cursor);
4955 }
4956
4957 /// Restore the buffer from a `ropey::Rope` snapshot. Used by undo /
4958 /// redo: snapshots are stored as `Rope` (O(1) Arc-clone via
4959 /// `View::rope()`), so this avoids the full-document `to_string`
4960 /// materialization that the old `Arc<String>` snapshot path forced
4961 /// on every undo group boundary.
4962 ///
4963 /// Internally materializes the rope to a `String` for `restore_text`
4964 /// — paying the cost on the restore side instead of the snapshot
4965 /// side trades one ~3 MB build per undo for none-per-snapshot. Undo
4966 /// is user-initiated and rare; snapshots fire on every `i` / `o`.
4967 pub fn restore_rope(&mut self, rope: &ropey::Rope, cursor: (usize, usize)) {
4968 let text = rope.to_string();
4969 self.restore_text(&text, cursor);
4970 }
4971
4972 fn restore_text(&mut self, text: &str, cursor: (usize, usize)) {
4973 // Diff the old rope (O(1) Arc-clone) against the incoming text
4974 // to emit a minimal ContentEdit — without it the syntax layer's
4975 // tree.edit() marks the whole document changed and tree-sitter
4976 // cold-parses on every undo.
4977 let old_rope = self.buffer.rope();
4978 let edit = minimal_content_edit_rope(&old_rope, text);
4979
4980 crate::types::BufferEdit::replace_all(&mut self.buffer, text);
4981 buf_set_cursor_rc(&mut self.buffer, cursor.0, cursor.1);
4982
4983 // Bulk replace supersedes any prior queued edits.
4984 self.buffer.clear_pending_content_edits();
4985 self.buffer.push_pending_content_edit(edit);
4986 self.mark_content_dirty();
4987 }
4988
4989 // ─── Range-query helpers for partial-format dispatch (#119) ─────────────
4990
4991 /// Drain the row range set by the most recent auto-indent operation.
4992 ///
4993 /// Returns `Some((top_row, bot_row))` (inclusive) on the first call after
4994 /// an `=` / `==` / `=G` / Visual-`=` operator, then clears the stored
4995 /// value so a subsequent call returns `None`. The host (e.g. `apps/hjkl`)
4996 /// uses this to arm a brief visual flash over the reindented rows.
4997 pub fn take_last_indent_range(&mut self) -> Option<(usize, usize)> {
4998 self.last_indent_range.take()
4999 }
5000
5001 /// Queue a user-visible error message. Engine and discipline code calls
5002 /// this where a host would call its message bar; the host drains it with
5003 /// [`Editor::take_errors`].
5004 ///
5005 /// Messages carry vim's own `E`-codes so they read the same as the ones
5006 /// `hjkl-ex` and `apps/hjkl` raise directly.
5007 pub fn push_error(&mut self, message: impl Into<String>) {
5008 self.pending_errors.push(message.into());
5009 }
5010
5011 /// Drain every message queued by [`Editor::push_error`] since the last
5012 /// call. A host that never drains this leaks the messages, which is why
5013 /// `apps/hjkl` drains once per key rather than per command.
5014 pub fn take_errors(&mut self) -> Vec<String> {
5015 std::mem::take(&mut self.pending_errors)
5016 }
5017
5018 /// Replace rows `top..=bot` (0-based, inclusive) with `new_lines` via a
5019 /// single bounded [`hjkl_buffer::Edit::Replace`] splice.
5020 ///
5021 /// Shared by [`Editor::toggle_comment_range`] and
5022 /// [`Editor::filter_range`] (audit D1 / D4): both used to rebuild the
5023 /// entire document as a `Vec<String>` + rejoin on every call —
5024 /// O(document size) for a range-scoped edit — which made `gcc` /
5025 /// `gc{motion}` and `:!`/`:%!` filters cost a full-document
5026 /// reallocation even when touching a single line. Routing through
5027 /// [`Editor::mutate_edit`] instead touches only the affected char span
5028 /// in the rope, so cost is O(edit size).
5029 ///
5030 /// `new_lines` may have a different row count than `bot - top + 1`
5031 /// (a filter can add/remove/keep lines) — including empty (deletes
5032 /// the range entirely). This is why the caller passes rows rather
5033 /// than a pre-joined string: `&[]` (delete) and `&[String::new()]`
5034 /// (replace with one blank line) join to the same `""` but must
5035 /// splice differently — the former must also swallow one of the
5036 /// range's boundary newlines, the latter must not.
5037 ///
5038 /// The boundary-newline math mirrors `do_delete_range`'s
5039 /// `MotionKind::Line` case (which already handles vim's "last row
5040 /// keeps no trailing newline" rule): when `bot` is not the buffer's
5041 /// last row, the replace span runs through the newline *after* `bot`
5042 /// and the inserted text re-adds it; when `bot` *is* the last row,
5043 /// the span instead runs from the end of row `top - 1` (swallowing
5044 /// the newline *before* `top`) so the buffer never grows a trailing
5045 /// empty row that didn't exist before.
5046 ///
5047 /// Cursor lands at `(top, 0)` — vim-commentary / filter parity —
5048 /// overriding wherever [`hjkl_buffer::Edit::Replace`] would otherwise
5049 /// leave it (end of the inserted text).
5050 ///
5051 /// Callers must call [`Editor::push_undo`] first so the whole
5052 /// operation lands as a single undo step (same contract `restore`
5053 /// callers already followed).
5054 fn splice_row_range(&mut self, top: usize, bot: usize, new_lines: &[String]) {
5055 let row_count = buf_row_count(&self.buffer);
5056 let bot_is_last_row = bot + 1 >= row_count;
5057 let joined = new_lines.join("\n");
5058
5059 let (start, end, with) = if !bot_is_last_row {
5060 // Rows exist after `bot` — span through the newline that
5061 // separates `bot` from `bot + 1` and re-add it (unless the
5062 // range is being deleted outright, i.e. `new_lines` is empty).
5063 let with = if new_lines.is_empty() {
5064 String::new()
5065 } else {
5066 format!("{joined}\n")
5067 };
5068 (
5069 hjkl_buffer::Position::new(top, 0),
5070 hjkl_buffer::Position::new(bot + 1, 0),
5071 with,
5072 )
5073 } else if top > 0 {
5074 // `bot` is the last row but rows exist before `top` — span
5075 // from the end of row `top - 1` (swallowing the newline
5076 // before `top`) through end-of-buffer, mirroring the
5077 // linewise-delete "no trailing-newline orphan" rule.
5078 let prev_end_col = buf_line_chars(&self.buffer, top - 1);
5079 let bot_end_col = buf_line_chars(&self.buffer, bot);
5080 let with = if new_lines.is_empty() {
5081 String::new()
5082 } else {
5083 format!("\n{joined}")
5084 };
5085 (
5086 hjkl_buffer::Position::new(top - 1, prev_end_col),
5087 hjkl_buffer::Position::new(bot, bot_end_col),
5088 with,
5089 )
5090 } else {
5091 // Whole buffer is the range (`top == 0`, `bot` == last row).
5092 let bot_end_col = buf_line_chars(&self.buffer, bot);
5093 (
5094 hjkl_buffer::Position::new(0, 0),
5095 hjkl_buffer::Position::new(bot, bot_end_col),
5096 joined,
5097 )
5098 };
5099
5100 self.mutate_edit(hjkl_buffer::Edit::Replace { start, end, with });
5101 buf_set_cursor_rc(&mut self.buffer, top, 0);
5102 }
5103
5104 /// Filter rows `top_row..=bot_row` through an external shell command.
5105 ///
5106 /// Spawns `sh -c "<command>"` (or `cmd /C "<command>"` on Windows), pipes
5107 /// the selected lines (joined by `\n`) to stdin, and waits up to
5108 /// `timeout_secs` seconds (default 10) for the process to finish.
5109 ///
5110 /// On success: the rows are replaced with stdout. No trailing-newline trim.
5111 /// On non-zero exit, spawn failure, or timeout: returns `Err(stderr_or_msg)`
5112 /// without mutating the buffer.
5113 ///
5114 /// `top_row` and `bot_row` are clamped to the buffer's valid row range.
5115 pub fn filter_range(
5116 &mut self,
5117 top_row: usize,
5118 bot_row: usize,
5119 command: &str,
5120 timeout_secs: Option<u64>,
5121 ) -> Result<(), String> {
5122 use std::io::Write;
5123 use std::process::{Command, Stdio};
5124 use std::thread;
5125 use std::time::Instant;
5126
5127 if crate::policy::shell_disabled() {
5128 return Err(
5129 "shell commands are disabled in this mode (pass --allow-shell to enable)".into(),
5130 );
5131 }
5132
5133 let timeout = std::time::Duration::from_secs(timeout_secs.unwrap_or(10));
5134 let rope = crate::types::Query::rope(self.buffer());
5135 let line_count = rope.len_lines();
5136 let top = top_row.min(line_count.saturating_sub(1));
5137 let bot = bot_row.min(line_count.saturating_sub(1));
5138 let (top, bot) = (top.min(bot), top.max(bot));
5139 let input_text = crate::rope_util::rope_row_range_str(&rope, top, bot);
5140
5141 tracing::debug!(
5142 top_row = top,
5143 bot_row = bot,
5144 command = command,
5145 "filter_range: spawning shell command"
5146 );
5147
5148 #[cfg(not(windows))]
5149 let mut child = Command::new("sh")
5150 .args(["-c", command])
5151 .stdin(Stdio::piped())
5152 .stdout(Stdio::piped())
5153 .stderr(Stdio::piped())
5154 .spawn()
5155 .map_err(|e| format!("spawn failed: {e}"))?;
5156
5157 #[cfg(windows)]
5158 let mut child = Command::new("cmd")
5159 .args(["/C", command])
5160 .stdin(Stdio::piped())
5161 .stdout(Stdio::piped())
5162 .stderr(Stdio::piped())
5163 .spawn()
5164 .map_err(|e| format!("spawn failed: {e}"))?;
5165
5166 // Write stdin on a thread to avoid deadlock when output > pipe buffer.
5167 let mut stdin = child.stdin.take().ok_or("no stdin handle")?;
5168 let input_bytes = input_text.into_bytes();
5169 thread::spawn(move || {
5170 let _ = stdin.write_all(&input_bytes);
5171 // stdin drops here, signalling EOF to the child.
5172 });
5173
5174 // Drain stdout/stderr on separate threads so the child's pipes don't
5175 // fill and deadlock the child. Keep `child` here so we can kill it on
5176 // timeout.
5177 let mut stdout_pipe = child.stdout.take().ok_or("no stdout handle")?;
5178 let mut stderr_pipe = child.stderr.take().ok_or("no stderr handle")?;
5179 let stdout_thread = thread::spawn(move || {
5180 let mut buf = Vec::new();
5181 let _ = std::io::Read::read_to_end(&mut stdout_pipe, &mut buf);
5182 buf
5183 });
5184 let stderr_thread = thread::spawn(move || {
5185 let mut buf = Vec::new();
5186 let _ = std::io::Read::read_to_end(&mut stderr_pipe, &mut buf);
5187 buf
5188 });
5189
5190 // Poll try_wait until exit or timeout. On timeout: SIGKILL the child
5191 // (std Child::kill sends SIGKILL on Unix / TerminateProcess on Windows).
5192 // A proper TERM→KILL escalation would need nix/libc; skip for v1.
5193 let start = Instant::now();
5194 let status = loop {
5195 match child.try_wait() {
5196 Ok(Some(status)) => break status,
5197 Ok(None) => {
5198 if start.elapsed() >= timeout {
5199 tracing::debug!(command, "filter_range: timeout — killing child");
5200 let _ = child.kill();
5201 let _ = child.wait(); // reap so the OS can free resources
5202 return Err(format!("command timed out after {}s", timeout.as_secs()));
5203 }
5204 thread::sleep(std::time::Duration::from_millis(20));
5205 }
5206 Err(e) => return Err(format!("wait failed: {e}")),
5207 }
5208 };
5209
5210 let stdout_bytes = stdout_thread.join().unwrap_or_default();
5211 let stderr_bytes = stderr_thread.join().unwrap_or_default();
5212
5213 if !status.success() {
5214 let stderr = String::from_utf8_lossy(&stderr_bytes).into_owned();
5215 tracing::debug!(
5216 command,
5217 exit_code = ?status.code(),
5218 "filter_range: command exited with non-zero status"
5219 );
5220 return Err(if stderr.is_empty() {
5221 format!("command exited with status {}", status.code().unwrap_or(-1))
5222 } else {
5223 stderr
5224 });
5225 }
5226
5227 let stdout = String::from_utf8_lossy(&stdout_bytes).into_owned();
5228 tracing::debug!(
5229 command,
5230 stdout_bytes = stdout_bytes.len(),
5231 "filter_range: command succeeded, replacing rows"
5232 );
5233
5234 // Replace rows `top..=bot` with the stdout lines — a single
5235 // bounded splice (audit D4), not a whole-document rebuild.
5236 // `stdout.lines()` already drops the trailing-newline sentinel —
5237 // this preserves vim's "no trailing-newline trim" spec because a
5238 // trailing '\n' from the command means the last replacement line
5239 // is the line BEFORE the newline, not an empty line after it.
5240 let new_lines: Vec<String> = stdout.lines().map(|l| l.to_owned()).collect();
5241
5242 self.push_undo();
5243 self.splice_row_range(top, bot, &new_lines);
5244 // Leave the editor idle after a successful filter (vim parity: Normal).
5245 // Goes through the discipline hook, so the engine does not name vim.
5246 self.discipline.reset_to_idle();
5247
5248 Ok(())
5249 }
5250
5251 // ─── Comment toggle (#187) ───────────────────────────────────────────────
5252
5253 /// Toggle line comments on rows `top_row..=bot_row` (0-based, inclusive).
5254 ///
5255 /// **Algorithm** (vim-commentary parity):
5256 ///
5257 /// 1. Determine the comment marker(s) for the active filetype.
5258 /// Priority: `settings.commentstring` (`:set commentstring=…`) → per-filetype
5259 /// default from `hjkl_lang::comment::commentstring_for_lang` → no-op.
5260 /// 2. Scan non-blank lines. If every non-blank line is already commented →
5261 /// strip the comment marker from each. Otherwise → add it to all non-blank
5262 /// lines.
5263 /// 3. Blank / whitespace-only lines are skipped (no marker added or removed).
5264 /// 4. The marker is inserted AFTER the leading whitespace (indent-preserving).
5265 /// 5. The entire operation is a single undo step.
5266 ///
5267 /// For block-comment languages (HTML, CSS) each line is individually wrapped
5268 /// as `start text end` (per-line block style, not one multi-line block).
5269 ///
5270 /// `top_row` and `bot_row` are clamped to the buffer's valid row range.
5271 pub fn toggle_comment_range(&mut self, top_row: usize, bot_row: usize) {
5272 use hjkl_lang::comment::commentstring_for_lang;
5273
5274 let lang = self.settings.filetype.clone();
5275
5276 // Resolve the comment markers.
5277 // If `settings.commentstring` is set (non-empty) parse `start %s end`
5278 // from it; otherwise fall back to the filetype table.
5279 let (start, end) = if !self.settings.commentstring.is_empty() {
5280 let cs = &self.settings.commentstring;
5281 if let Some(idx) = cs.find("%s") {
5282 let s = cs[..idx].trim_end().to_string();
5283 let e_raw = cs[idx + 2..].trim_start();
5284 let e: Option<String> = if e_raw.is_empty() {
5285 None
5286 } else {
5287 Some(e_raw.to_string())
5288 };
5289 (s, e)
5290 } else {
5291 // No %s placeholder — treat the whole string as start marker.
5292 (cs.clone(), None)
5293 }
5294 } else {
5295 match commentstring_for_lang(&lang) {
5296 Some((s, e)) => (s.to_string(), e.map(|v| v.to_string())),
5297 None => return, // no known comment syntax → no-op
5298 }
5299 };
5300
5301 let row_count = buf_row_count(&self.buffer);
5302 let top = top_row.min(row_count.saturating_sub(1));
5303 let bot = bot_row.min(row_count.saturating_sub(1));
5304
5305 // Collect all lines in the range.
5306 let lines: Vec<String> = (top..=bot)
5307 .map(|r| buf_line(&self.buffer, r).unwrap_or_default())
5308 .collect();
5309
5310 // Check whether every non-blank line is already commented.
5311 let all_commented = lines.iter().all(|line| {
5312 let trimmed = line.trim_start();
5313 if trimmed.is_empty() {
5314 return true; // blank lines don't count against "all commented"
5315 }
5316 if let Some(ref end_marker) = end {
5317 // Block style: line starts with start and ends with end.
5318 trimmed.starts_with(start.as_str())
5319 && line.trim_end().ends_with(end_marker.as_str())
5320 } else {
5321 trimmed.starts_with(start.as_str())
5322 }
5323 });
5324
5325 let mut new_lines: Vec<String> = Vec::with_capacity(lines.len());
5326 for line in &lines {
5327 let trimmed = line.trim_start();
5328 if trimmed.is_empty() {
5329 // Blank line — leave as-is.
5330 new_lines.push(line.clone());
5331 continue;
5332 }
5333 let indent_len = line.len() - trimmed.len();
5334 let indent = &line[..indent_len];
5335
5336 if all_commented {
5337 // Uncomment: strip exactly one occurrence of start (+ optional space).
5338 if let Some(after_start) = trimmed.strip_prefix(start.as_str()) {
5339 // Strip one leading space after the marker if present.
5340 let after_space = after_start.strip_prefix(' ').unwrap_or(after_start);
5341 // For block style also strip the trailing end marker.
5342 let text = if let Some(ref end_marker) = end {
5343 after_space
5344 .trim_end()
5345 .strip_suffix(end_marker.as_str())
5346 .map_or(after_space, |s| s.trim_end())
5347 } else {
5348 after_space
5349 };
5350 new_lines.push(format!("{indent}{text}"));
5351 } else {
5352 new_lines.push(line.clone());
5353 }
5354 } else {
5355 // Comment: insert marker after indent.
5356 let commented = if let Some(ref end_marker) = end {
5357 format!("{indent}{start} {trimmed} {end_marker}")
5358 } else {
5359 format!("{indent}{start} {trimmed}")
5360 };
5361 new_lines.push(commented);
5362 }
5363 }
5364
5365 // Replace the row range in the buffer — single undo step, O(edit
5366 // size) rather than O(document size) (audit D1): `gcc` on one line
5367 // of a huge file no longer rebuilds the whole document.
5368 self.push_undo();
5369 self.splice_row_range(top, bot, &new_lines);
5370 }
5371
5372 // ─── Phase 6.1: public insert-mode primitives (kryptic-sh/hjkl#87) ────────
5373 //
5374 // Each method is the publicly callable form of one insert-mode action.
5375 // All logic lives in the corresponding `vim::*_bridge` free function;
5376 // these methods are thin delegators so the public surface stays on `Editor`.
5377 //
5378 // Invariants (enforced by the bridge fns):
5379 // - View mutations go through `mutate_edit` (dirty/undo/change-list).
5380 // - Navigation keys call `break_undo_group_in_insert` when the FSM did.
5381}
5382
5383// ── Phase 6.6b: FSM state accessors (for hjkl-vim ownership) ─────────────────
5384//
5385// The FSM (now in hjkl-vim) reads/writes `VimState` fields through public
5386// `Editor` accessors and mutators defined in this block. Each method gets a
5387// one-line `///` rustdoc. Fields mutated as a unit get a combined action method
5388// rather than individual getters + setters (e.g. `accumulate_count_digit`).
5389
5390impl<H: crate::types::Host> Editor<hjkl_buffer::View, H> {
5391 // ── Pending chord ─────────────────────────────────────────────────────────
5392
5393 // ── Abbreviations ─────────────────────────────────────────────────────────
5394
5395 /// Register an abbreviation. If an entry for `lhs` already exists (same
5396 /// mode flags), it is replaced. Inserts at the front so newer definitions
5397 /// take priority (first-match wins in `try_abbrev_expand`).
5398 pub fn add_abbrev(&mut self, lhs: &str, rhs: &str, insert: bool, cmdline: bool, noremap: bool) {
5399 let mut abbrevs = self.abbrevs.lock().unwrap();
5400 // Remove existing entry with same lhs + overlapping mode flags.
5401 abbrevs.retain(|a| a.lhs != lhs || (a.insert && !insert) || (a.cmdline && !cmdline));
5402 abbrevs.insert(
5403 0,
5404 crate::abbrev::Abbrev {
5405 lhs: lhs.to_string(),
5406 rhs: rhs.to_string(),
5407 insert,
5408 cmdline,
5409 noremap,
5410 },
5411 );
5412 }
5413
5414 /// Remove the abbreviation with the given `lhs`. Only removes entries
5415 /// whose mode flags overlap with the requested `insert`/`cmdline` flags.
5416 pub fn remove_abbrev(&mut self, lhs: &str, insert: bool, cmdline: bool) {
5417 self.abbrevs
5418 .lock()
5419 .unwrap()
5420 .retain(|a| a.lhs != lhs || (!insert || !a.insert) && (!cmdline || !a.cmdline));
5421 }
5422
5423 /// Clear all abbreviations matching the given mode flags.
5424 ///
5425 /// `insert=true` removes insert-mode abbrevs; `cmdline=true` removes
5426 /// cmdline-mode abbrevs. Both `true` clears everything.
5427 pub fn clear_abbrevs(&mut self, insert: bool, cmdline: bool) {
5428 self.abbrevs.lock().unwrap().retain(|a| {
5429 // Keep entries that do NOT match any of the cleared modes.
5430 let cleared = (insert && a.insert) || (cmdline && a.cmdline);
5431 !cleared
5432 });
5433 }
5434
5435 // ── Phase 6.6c: search + jump helpers (public Editor API) ───────────────
5436 //
5437 // `push_search_pattern`, `push_jump`, `record_search_history`, and
5438 // `walk_search_history` are public `Editor` methods so that `hjkl-vim`'s
5439 // search-prompt and normal-mode FSM can call them via the public API.
5440
5441 /// Compile `pattern` into a regex and install it as the active search
5442 /// pattern. Respects `:set ignorecase` / `:set smartcase` and inline
5443 /// `\c`/`\C` overrides. An empty or invalid pattern clears the highlight
5444 /// without raising an error.
5445 pub fn push_search_pattern(&mut self, pattern: &str) {
5446 let compiled = if pattern.is_empty() {
5447 None
5448 } else {
5449 use crate::search::{CaseMode, resolve_case_mode};
5450 let base =
5451 CaseMode::from_options(self.settings().ignore_case, self.settings().smartcase);
5452 let last_sub = self.last_substitute_replacement();
5453 let (stripped, mode) = resolve_case_mode(pattern, base, &last_sub);
5454 let src = if mode == CaseMode::Insensitive {
5455 format!("(?i){stripped}")
5456 } else {
5457 stripped
5458 };
5459 regex::Regex::new(&src).ok()
5460 };
5461 let wrap = self.settings().wrapscan;
5462 self.set_search_pattern(compiled);
5463 self.search_state_mut().wrap_around = wrap;
5464 }
5465
5466 /// Record a pre-jump cursor position onto the back jumplist. Called
5467 /// before any "big jump" motion (`gg`/`G`, `%`, `*`/`#`, `n`/`N`,
5468 /// committed `/` or `?`, …). Branching off the history clears the
5469 /// forward half, matching vim's "redo-is-lost" semantics.
5470 pub fn push_jump(&mut self, from: (usize, usize)) {
5471 self.jump_back.push(from);
5472 if self.jump_back.len() > crate::types::JUMPLIST_MAX {
5473 self.jump_back.remove(0);
5474 }
5475 self.jump_fwd.clear();
5476 }
5477
5478 /// Push `pattern` onto the committed search history. Skips if the
5479 /// most recent entry already matches (consecutive dedupe) and trims
5480 /// the oldest entries beyond the history cap.
5481 pub fn record_search_history(&mut self, pattern: &str) {
5482 if pattern.is_empty() {
5483 return;
5484 }
5485 let mut bank = self.search.lock().unwrap();
5486 if bank.history.last().map(String::as_str) == Some(pattern) {
5487 return;
5488 }
5489 bank.history.push(pattern.to_string());
5490 let len = bank.history.len();
5491 if len > crate::types::SEARCH_HISTORY_MAX {
5492 bank.history
5493 .drain(0..len - crate::types::SEARCH_HISTORY_MAX);
5494 }
5495 }
5496
5497 /// Walk the search-prompt history by `dir` steps. `dir = -1` moves
5498 /// toward older entries (Ctrl-P / Up); `dir = 1` toward newer ones
5499 /// (Ctrl-N / Down). Stops at the ends; does nothing if there is no
5500 /// active search prompt.
5501 pub fn walk_search_history(&mut self, dir: isize) {
5502 if self.search_prompt.is_none() {
5503 return;
5504 }
5505 let Some(text) = ({
5506 let mut bank = self.search.lock().unwrap();
5507 if bank.history.is_empty() {
5508 None
5509 } else {
5510 let len = bank.history.len();
5511 let next_idx = match (bank.history_cursor, dir) {
5512 (None, -1) => Some(len - 1),
5513 (None, 1) => None,
5514 (Some(i), -1) => i.checked_sub(1),
5515 (Some(i), 1) if i + 1 < len => Some(i + 1),
5516 _ => None,
5517 };
5518 next_idx.map(|idx| {
5519 bank.history_cursor = Some(idx);
5520 bank.history[idx].clone()
5521 })
5522 }
5523 }) else {
5524 return;
5525 };
5526 if let Some(prompt) = self.search_prompt.as_mut() {
5527 prompt.cursor = text.chars().count();
5528 prompt.text.clone_from(&text);
5529 }
5530 self.push_search_pattern(&text);
5531 }
5532
5533 // The per-step prelude/epilogue (`begin_step`/`end_step` + `StepBookkeeping`)
5534 // moved to `hjkl_vim::step` (#267); the engine no longer owns FSM bookkeeping.
5535
5536 /// Return the character count (code-point count) of line `row`, or `0`
5537 /// when `row` is out of range.
5538 ///
5539 /// A raw buffer read with no vim semantics, so it stays on the engine core
5540 /// while the vim-specific visual/block primitives move to
5541 /// `hjkl_vim::VimEditorExt` (#267).
5542 pub fn line_char_count(&self, row: usize) -> usize {
5543 buf_line_chars(&self.buffer, row)
5544 }
5545}
5546
5547/// First `(row, col)` where two ropes differ, or `None` if identical. Used to
5548/// place the cursor at the start of a redone change (vim parity).
5549fn first_diff_pos(a: &ropey::Rope, b: &ropey::Rope) -> Option<(usize, usize)> {
5550 let rows = a.len_lines().max(b.len_lines());
5551 for r in 0..rows {
5552 let la = if r < a.len_lines() {
5553 hjkl_buffer::rope_line_str(a, r)
5554 } else {
5555 String::new()
5556 };
5557 let lb = if r < b.len_lines() {
5558 hjkl_buffer::rope_line_str(b, r)
5559 } else {
5560 String::new()
5561 };
5562 if la != lb {
5563 let col = la
5564 .chars()
5565 .zip(lb.chars())
5566 .take_while(|(x, y)| x == y)
5567 .count();
5568 return Some((r, col));
5569 }
5570 }
5571 None
5572}
5573
5574/// Visual column of the character at `char_col` in `line`.
5575///
5576/// Thin alias for [`hjkl_buffer::char_col_to_visual_col`], which owns the
5577/// tab-stop and `unicode-width` rules the renderer's `paint_row` uses. This
5578/// used to be a second, naive copy that counted every non-tab char as one
5579/// cell; it drifted from the painted glyph on any line containing CJK, emoji
5580/// or a combining mark, so `cursor_screen_pos` drew the cursor block left of
5581/// the character it was on.
5582fn visual_col_for_char(line: &str, char_col: usize, tab_width: usize) -> usize {
5583 char_col_to_visual_col(line, char_col, tab_width)
5584}
5585
5586#[cfg(test)]
5587mod cursor_screen_pos_width_tests {
5588 use super::*;
5589 use crate::types::{DefaultHost, Host, Options};
5590 use hjkl_buffer::View;
5591
5592 /// The terminal cursor block must be placed at the cell the glyph is
5593 /// painted in. `paint_row` gives `世` and `界` two cells each, so on
5594 /// `ab世界cd` the `c` (char index 4) is at screen x 6, not 4.
5595 #[test]
5596 fn cursor_x_accounts_for_double_width_chars() {
5597 for (char_col, expected_x) in [(0usize, 0u16), (1, 1), (2, 2), (3, 4), (4, 6), (5, 7)] {
5598 let mut e = Editor::new(
5599 View::from_str("ab世界cd"),
5600 DefaultHost::new(),
5601 Options::default(),
5602 );
5603 {
5604 let vp = e.host_mut().viewport_mut();
5605 vp.top_row = 0;
5606 vp.top_col = 0;
5607 vp.width = 80;
5608 vp.height = 10;
5609 vp.tab_width = 4;
5610 }
5611 e.jump_cursor(0, char_col);
5612 let (x, _y) = e
5613 .cursor_screen_pos(0, 0, 80, 10, 0)
5614 .expect("cursor is inside the viewport");
5615 // `lnum_width()` reserves a gutter; measure relative to char 0.
5616 let base = {
5617 let mut e0 = Editor::new(
5618 View::from_str("ab世界cd"),
5619 DefaultHost::new(),
5620 Options::default(),
5621 );
5622 {
5623 let vp = e0.host_mut().viewport_mut();
5624 vp.top_row = 0;
5625 vp.top_col = 0;
5626 vp.width = 80;
5627 vp.height = 10;
5628 vp.tab_width = 4;
5629 }
5630 e0.jump_cursor(0, 0);
5631 e0.cursor_screen_pos(0, 0, 80, 10, 0).unwrap().0
5632 };
5633 assert_eq!(x - base, expected_x, "char col {char_col}");
5634 }
5635 }
5636}
5637
5638#[cfg(test)]
5639mod shift_syntax_spans_tests {
5640 use super::*;
5641 use crate::types::{ContentEdit, DefaultHost, Options, Style};
5642 use hjkl_buffer::View;
5643
5644 fn ed_with_spans(line_count: usize) -> Editor<View, DefaultHost> {
5645 let text = (0..line_count)
5646 .map(|i| format!("row{i}"))
5647 .collect::<Vec<_>>()
5648 .join("\n");
5649 let buf = View::from_str(&text);
5650 let mut e = Editor::new(buf, DefaultHost::new(), Options::default());
5651 // Synthesize span rows so we can detect which survive a shift.
5652 // Use a distinct fg colour per row so spans are identifiable.
5653 let style = Style::default();
5654 let spans: Vec<Vec<(usize, usize, Style)>> =
5655 (0..line_count).map(|_| vec![(0, 1, style)]).collect();
5656 e.install_syntax_spans(spans);
5657 e
5658 }
5659
5660 fn edit_insert_newline_at(row: u32, col: u32) -> ContentEdit {
5661 // Pressing Enter: zero-width insertion that produces one new row.
5662 ContentEdit {
5663 start_byte: 0,
5664 old_end_byte: 0,
5665 new_end_byte: 1,
5666 start_position: (row, col),
5667 old_end_position: (row, col),
5668 new_end_position: (row + 1, 0),
5669 }
5670 }
5671
5672 fn edit_join_rows(row: u32, col: u32) -> ContentEdit {
5673 // Backspace at start of `row+1`: removes the newline, joining the
5674 // two rows. old_end is on `row+1`, new_end on `row`.
5675 ContentEdit {
5676 start_byte: 0,
5677 old_end_byte: 1,
5678 new_end_byte: 0,
5679 start_position: (row, col),
5680 old_end_position: (row + 1, 0),
5681 new_end_position: (row, col),
5682 }
5683 }
5684
5685 #[test]
5686 fn insert_grows_buffer_spans_in_place() {
5687 let mut e = ed_with_spans(4);
5688 // Newline at row 1 → buffer grew by one row.
5689 e.shift_syntax_spans_for_edits(&[edit_insert_newline_at(1, 1)]);
5690 assert_eq!(
5691 e.buffer_spans().len(),
5692 5,
5693 "row-count grew → spans rows must match"
5694 );
5695 // The empty row should be at index 2 (right after the split point).
5696 assert!(e.buffer_spans()[2].is_empty(), "inserted row sits at oer+1");
5697 // Surrounding rows kept their content.
5698 assert!(!e.buffer_spans()[0].is_empty());
5699 assert!(!e.buffer_spans()[1].is_empty());
5700 assert!(!e.buffer_spans()[3].is_empty());
5701 assert!(!e.buffer_spans()[4].is_empty());
5702 }
5703
5704 #[test]
5705 fn delete_shrinks_buffer_spans_in_place() {
5706 let mut e = ed_with_spans(4);
5707 e.shift_syntax_spans_for_edits(&[edit_join_rows(1, 1)]);
5708 assert_eq!(
5709 e.buffer_spans().len(),
5710 3,
5711 "row-count shrank → spans rows must match"
5712 );
5713 }
5714
5715 #[test]
5716 fn same_row_edit_leaves_rows_untouched() {
5717 let mut e = ed_with_spans(3);
5718 let edit = ContentEdit {
5719 start_byte: 0,
5720 old_end_byte: 0,
5721 new_end_byte: 1,
5722 start_position: (1, 0),
5723 old_end_position: (1, 0),
5724 new_end_position: (1, 1),
5725 };
5726 e.shift_syntax_spans_for_edits(&[edit]);
5727 assert_eq!(e.buffer_spans().len(), 3);
5728 for row in 0..3 {
5729 assert!(
5730 !e.buffer_spans()[row].is_empty(),
5731 "row {row} should still hold its span"
5732 );
5733 }
5734 }
5735
5736 #[test]
5737 fn ordered_edits_apply_against_prior_state() {
5738 let mut e = ed_with_spans(3);
5739 // Two consecutive inserts: each adds a row.
5740 e.shift_syntax_spans_for_edits(&[
5741 edit_insert_newline_at(0, 1),
5742 edit_insert_newline_at(1, 1),
5743 ]);
5744 assert_eq!(e.buffer_spans().len(), 5);
5745 }
5746
5747 /// The syntax worker lags the buffer, so a span table can arrive with
5748 /// MORE rows than the buffer currently has (e.g. `dd` landed between the
5749 /// parse and its delivery). Those rows must clamp to length 0 and drop
5750 /// their spans — never panic. Guards the row-length lookup, which reads
5751 /// the rope directly (`ropey::Rope::line` panics past the last line).
5752 #[test]
5753 fn install_tolerates_more_span_rows_than_buffer_rows() {
5754 let text = "aaaa\nbbbb\ncccc";
5755 let mut e = Editor::new(View::from_str(text), DefaultHost::new(), Options::default());
5756 let style = Style::default();
5757 let spans: Vec<Vec<(usize, usize, Style)>> = (0..10).map(|_| vec![(0, 4, style)]).collect();
5758 e.install_syntax_spans(spans);
5759 assert_eq!(e.buffer_spans().len(), 10, "one row per supplied entry");
5760 for row in 0..3 {
5761 assert_eq!(e.buffer_spans()[row].len(), 1, "row {row} keeps its span");
5762 }
5763 for row in 3..10 {
5764 assert!(
5765 e.buffer_spans()[row].is_empty(),
5766 "row {row} is past the buffer — clamps to 0 and drops"
5767 );
5768 }
5769 }
5770
5771 /// Spans are clamped in BYTES, not chars — a row of multi-byte text must
5772 /// keep a span that ends past the char count but inside the byte length.
5773 #[test]
5774 fn clamp_unit_is_bytes_not_chars() {
5775 // 5 chars, 10 bytes.
5776 let text = "ααααα\nx";
5777 let mut e = Editor::new(View::from_str(text), DefaultHost::new(), Options::default());
5778 let style = Style::default();
5779 e.install_syntax_spans(vec![vec![(0usize, 10usize, style)], vec![]]);
5780 assert_eq!(
5781 e.buffer_spans()[0][0].end_byte,
5782 10,
5783 "byte-length clamp must not truncate to the char count"
5784 );
5785 // Exactly one byte past the row survives — that is the marker for a
5786 // multi-row span covering this row's end (a markdown code block),
5787 // which the renderer paints across the whole row.
5788 e.install_syntax_spans(vec![vec![(0usize, 11usize, style)], vec![]]);
5789 assert_eq!(e.buffer_spans()[0][0].end_byte, 11);
5790 // Anything beyond that is still clamped to the byte length, so a
5791 // `usize::MAX`-style "to end of line" end never reads as the marker.
5792 e.install_syntax_spans(vec![vec![(0usize, 12usize, style)], vec![]]);
5793 assert_eq!(e.buffer_spans()[0][0].end_byte, 10);
5794 }
5795
5796 /// Build a buffer with `line_count` rows where row `i` has a span at
5797 /// column `i + 1` so the rows are independently identifiable after a
5798 /// shift (otherwise all spans look identical and can't tell which
5799 /// original row's spans landed at which post-shift index).
5800 fn ed_with_distinguishable_spans(line_count: usize) -> Editor<View, DefaultHost> {
5801 let text = (0..line_count)
5802 .map(|i| format!("rowwwwwwwwww{i}"))
5803 .collect::<Vec<_>>()
5804 .join("\n");
5805 let buf = View::from_str(&text);
5806 let mut e = Editor::new(buf, DefaultHost::new(), Options::default());
5807 let style = Style::default();
5808 let spans: Vec<Vec<(usize, usize, Style)>> = (0..line_count)
5809 .map(|i| vec![(i + 1, i + 2, style)])
5810 .collect();
5811 e.install_syntax_spans(spans);
5812 e
5813 }
5814
5815 /// Regression for off-by-one in `shift_syntax_spans_for_edits`.
5816 ///
5817 /// `P` (paste-before) at column 0 of row 0 inserts new lines BEFORE
5818 /// row 0. The pre-paste rows should shift down by N. The fix inserts
5819 /// empty rows at idx `start.row` (not `oer + 1`) when `start.col == 0`.
5820 ///
5821 /// Symptom before the fix: row 0's spans stayed at idx 0 after a
5822 /// 4-row `ggP`, but the file's row 0 was now the pasted content (no
5823 /// spans available yet). Display: pasted row 0 painted with the
5824 /// pre-paste row 0's spans (LUCKILY identical content in many cases)
5825 /// while the *shifted* pre-paste row 0 (now at file row 4) painted
5826 /// with the pre-paste row 1's spans — visible as the WRONG row
5827 /// showing the wrong-row colours.
5828 #[test]
5829 fn shift_for_paste_at_start_of_row_zero() {
5830 let mut e = ed_with_distinguishable_spans(7);
5831 // Snapshot: row i has a span at col (i+1, i+2).
5832 let pre = e.buffer_spans().to_vec();
5833 // P at (0, 0) inserting 4 lines.
5834 let edit = ContentEdit {
5835 start_byte: 0,
5836 old_end_byte: 0,
5837 new_end_byte: 4,
5838 start_position: (0, 0),
5839 old_end_position: (0, 0),
5840 new_end_position: (4, 0),
5841 };
5842 e.shift_syntax_spans_for_edits(&[edit]);
5843 assert_eq!(e.buffer_spans().len(), 11, "row count grew by 4");
5844 // Rows 0..4 are the new pasted lines — should be EMPTY placeholders.
5845 for row in 0..4 {
5846 assert!(
5847 e.buffer_spans()[row].is_empty(),
5848 "row {row} (new paste) must be empty placeholder, got {:?}",
5849 e.buffer_spans()[row]
5850 );
5851 }
5852 // Rows 4..11 are the original rows 0..7 shifted down by 4.
5853 for (orig_row, orig_spans) in pre.iter().enumerate() {
5854 let new_row = orig_row + 4;
5855 assert_eq!(
5856 &e.buffer_spans()[new_row],
5857 orig_spans,
5858 "original row {orig_row} should be at file row {new_row} after \
5859 paste-before-row-0"
5860 );
5861 }
5862 }
5863
5864 /// Same idea for paste at start of a non-zero row: `2GP` inserts 3
5865 /// lines before row 2.
5866 #[test]
5867 fn shift_for_paste_at_start_of_middle_row() {
5868 let mut e = ed_with_distinguishable_spans(5);
5869 let pre = e.buffer_spans().to_vec();
5870 // Insert 3 lines at (2, 0).
5871 let edit = ContentEdit {
5872 start_byte: 0,
5873 old_end_byte: 0,
5874 new_end_byte: 3,
5875 start_position: (2, 0),
5876 old_end_position: (2, 0),
5877 new_end_position: (5, 0),
5878 };
5879 e.shift_syntax_spans_for_edits(&[edit]);
5880 assert_eq!(e.buffer_spans().len(), 8);
5881 // Rows 0..2 unchanged (before the insertion point).
5882 assert_eq!(e.buffer_spans()[0], pre[0]);
5883 assert_eq!(e.buffer_spans()[1], pre[1]);
5884 // Rows 2..5 are new pasted lines.
5885 for row in 2..5 {
5886 assert!(
5887 e.buffer_spans()[row].is_empty(),
5888 "row {row} must be empty placeholder"
5889 );
5890 }
5891 // Rows 5..8 are originals 2..5 shifted down by 3.
5892 for (orig_row, orig_spans) in pre.iter().enumerate().take(5).skip(2) {
5893 let new_row = orig_row + 3;
5894 assert_eq!(
5895 &e.buffer_spans()[new_row],
5896 orig_spans,
5897 "original row {orig_row} should land at file row {new_row}"
5898 );
5899 }
5900 }
5901
5902 /// Regression: pasting N rows at the beginning of the buffer used to
5903 /// run `Vec::insert(0, ...)` once per row → O(N²) memmove. samply
5904 /// showed this path eating 87 % of paste CPU on a 60 k-row paste.
5905 /// The splice rewrite is O(N).
5906 ///
5907 /// Asserting a hard wall-clock bound is brittle on slow CI, so we
5908 /// pick a budget the old code blows past by >10×: 60 k rows in
5909 /// under 200 ms even on a debug build. Old impl: ~3-5 seconds.
5910 #[test]
5911 fn shift_for_60k_row_paste_at_row_zero_is_under_200ms() {
5912 let mut e = ed_with_distinguishable_spans(8);
5913 let edit = ContentEdit {
5914 start_byte: 0,
5915 old_end_byte: 0,
5916 new_end_byte: 60_000,
5917 start_position: (0, 0),
5918 old_end_position: (0, 0),
5919 new_end_position: (60_000, 0),
5920 };
5921 let t = std::time::Instant::now();
5922 e.shift_syntax_spans_for_edits(&[edit]);
5923 let elapsed = t.elapsed();
5924 assert!(
5925 elapsed.as_millis() < 200,
5926 "60k-row shift took {elapsed:?}; budget is 200 ms (catches \
5927 reintroduction of the O(N²) per-row insert loop)"
5928 );
5929 assert_eq!(e.buffer_spans().len(), 60_008);
5930 }
5931
5932 /// Regression: `push_undo` used to clone every line into a
5933 /// `Vec<String>` (162 k heap allocations on a 162 k-row buffer per
5934 /// snapshot). Now stores an `Arc<String>` shared with
5935 /// `View::content_joined`'s per-dirty_gen cache — a warm snapshot
5936 /// is an `Arc::clone` (one ptr bump).
5937 ///
5938 /// Test: snapshot a 60 k-row buffer 100 times. With the Arc impl
5939 /// this is essentially free (one join then 99 Arc::clones). The
5940 /// old `Vec<String>` impl required 60 k allocations per call =
5941 /// 6 M allocations, easily seconds even on release.
5942 #[test]
5943 fn push_undo_snapshot_arc_clone_is_under_100ms_for_100_snapshots() {
5944 use crate::types::{DefaultHost, Options};
5945 let text = "x\n".repeat(60_000);
5946 let buf = hjkl_buffer::View::from_str(&text);
5947 let mut e = Editor::new(buf, DefaultHost::default(), Options::default());
5948 // Warm the cache: one join, subsequent snapshots Arc::clone it.
5949 e.push_undo();
5950 let t = std::time::Instant::now();
5951 for _ in 0..100 {
5952 e.push_undo();
5953 }
5954 let elapsed = t.elapsed();
5955 assert!(
5956 elapsed.as_millis() < 100,
5957 "100 snapshots of a 60k-row buffer took {elapsed:?}; budget \
5958 100 ms. Likely regressed to per-line cloning."
5959 );
5960 }
5961}
5962
5963#[cfg(test)]
5964mod content_edit_shape_tests {
5965 //! Property tests for [`content_edits_from_buffer_edit`] (audit R2).
5966 //!
5967 //! The ground truth is the BUFFER: for any `hjkl_buffer::Edit`, the
5968 //! emitted `ContentEdit` sequence — applied to the pre-edit text by a
5969 //! naive sequential byte splicer — must reproduce the post-edit buffer
5970 //! text EXACTLY. The same sequence feeds tree-sitter `tree.edit`, LSP
5971 //! incremental didChange, sibling-cursor rebase and fold invalidation,
5972 //! all of which consume each edit against the document as already
5973 //! modified by the preceding edits in the batch.
5974
5975 use super::*;
5976 use hjkl_buffer::{Edit, MotionKind, Position, View};
5977
5978 /// Apply `edit` to a buffer built from `initial`, then replay the
5979 /// emitted `ContentEdit`s through a naive sequential splicer and
5980 /// assert the result equals the post-edit buffer text.
5981 ///
5982 /// Replacement text for edit `i` is sliced from the post-edit document
5983 /// at `[start_byte, new_end_byte)` shifted by the net byte delta of any
5984 /// edit that (a) hasn't been applied to the running splice yet (index
5985 /// `> i`) and (b) sits textually BEFORE edit `i` in the pre-edit
5986 /// document — such an edit is already baked into `post`'s layout at
5987 /// edit `i`'s position but hasn't been reflected in the splice yet.
5988 /// For an ascending-disjoint batch (`build_text_changes`'s own
5989 /// contract) no edit satisfies both conditions — every not-yet-applied
5990 /// edit sits AFTER, not before — so the shift is always 0 and this is
5991 /// exactly the plain `[start_byte, new_end_byte)` slice. For a
5992 /// descending fan-out (block ops, SplitLines — audit-r2 fix 5) EVERY
5993 /// not-yet-applied edit sits before, so this exactly cancels the
5994 /// layout shift their (already-baked-into-`post`) insertions cause.
5995 /// All six coordinates are cross-checked against the evolving
5996 /// document. Returns the edits so callers can additionally pin exact
5997 /// shapes.
5998 fn check_shapes(initial: &str, edit: Edit) -> Vec<crate::types::ContentEdit> {
5999 let mut view = View::from_str(initial);
6000 let edits = content_edits_from_buffer_edit(&view, &edit);
6001 view.apply_edit(edit);
6002 let post = view.as_string();
6003
6004 let mut cur = initial.to_string();
6005 for (i, e) in edits.iter().enumerate() {
6006 assert!(
6007 e.start_byte <= e.old_end_byte,
6008 "edit {i}: start_byte > old_end_byte\n{e:?}"
6009 );
6010 assert!(
6011 e.old_end_byte <= cur.len(),
6012 "edit {i}: old_end_byte {} past evolving doc len {}\n{e:?}",
6013 e.old_end_byte,
6014 cur.len()
6015 );
6016 assert_eq!(
6017 byte_to_row_col(cur.as_bytes(), e.start_byte),
6018 e.start_position,
6019 "edit {i}: start_position disagrees with start_byte\n{e:?}"
6020 );
6021 assert_eq!(
6022 byte_to_row_col(cur.as_bytes(), e.old_end_byte),
6023 e.old_end_position,
6024 "edit {i}: old_end_position disagrees with old_end_byte\n{e:?}"
6025 );
6026 let shift: i64 = edits[i + 1..]
6027 .iter()
6028 .filter(|other| other.start_byte < e.start_byte)
6029 .map(|other| other.new_end_byte as i64 - other.old_end_byte as i64)
6030 .sum();
6031 let post_start = (e.start_byte as i64 + shift) as usize;
6032 let post_new_end = (e.new_end_byte as i64 + shift) as usize;
6033 // A pure delete inserts nothing; its (empty) new range may sit
6034 // past the end of the final document, so short-circuit it the
6035 // way `build_text_changes`' clamping does.
6036 let replacement = if e.new_end_byte == e.start_byte {
6037 ""
6038 } else {
6039 post.get(post_start..post_new_end).unwrap_or_else(|| {
6040 panic!(
6041 "edit {i}: shifted [{post_start}, {post_new_end}) (raw [{}, {})) \
6042 is not a valid slice of the post-edit doc ({} bytes)\n{e:?}",
6043 e.start_byte,
6044 e.new_end_byte,
6045 post.len()
6046 )
6047 })
6048 };
6049 assert!(
6050 cur.is_char_boundary(e.start_byte) && cur.is_char_boundary(e.old_end_byte),
6051 "edit {i}: old range splits a multi-byte char\n{e:?}"
6052 );
6053 cur.replace_range(e.start_byte..e.old_end_byte, replacement);
6054 assert_eq!(
6055 byte_to_row_col(cur.as_bytes(), e.new_end_byte),
6056 e.new_end_position,
6057 "edit {i}: new_end_position disagrees with new_end_byte\n{e:?}"
6058 );
6059 }
6060 assert_eq!(
6061 cur, post,
6062 "sequential splice of the emitted ContentEdits diverged from \
6063 the buffer's actual post-edit text"
6064 );
6065 edits
6066 }
6067
6068 fn join(row: usize, count: usize, with_space: bool) -> Edit {
6069 Edit::JoinLines {
6070 row,
6071 count,
6072 with_space,
6073 }
6074 }
6075
6076 fn del(start: (usize, usize), end: (usize, usize), kind: MotionKind) -> Edit {
6077 Edit::DeleteRange {
6078 start: Position::new(start.0, start.1),
6079 end: Position::new(end.0, end.1),
6080 kind,
6081 }
6082 }
6083
6084 /// `inserted_space` is a UNIFORM convenience for simple single- or
6085 /// mixed-intent test cases — broadcasts to every col. Tests that need
6086 /// genuinely mixed per-col outcomes (some joins inserted a space, some
6087 /// didn't — audit-r2 fix 6) construct `Edit::SplitLines` directly.
6088 fn split(row: usize, cols: Vec<usize>, inserted_space: bool) -> Edit {
6089 let inserted_spaces = vec![inserted_space; cols.len()];
6090 Edit::SplitLines {
6091 row,
6092 cols,
6093 inserted_spaces,
6094 }
6095 }
6096
6097 fn insert_block(at: (usize, usize), chunks: &[&str]) -> Edit {
6098 Edit::InsertBlock {
6099 at: Position::new(at.0, at.1),
6100 chunks: chunks.iter().map(|s| s.to_string()).collect(),
6101 }
6102 }
6103
6104 fn delete_block_chunks(at: (usize, usize), widths: Vec<usize>) -> Edit {
6105 let pads = vec![0; widths.len()];
6106 Edit::DeleteBlockChunks {
6107 at: Position::new(at.0, at.1),
6108 widths,
6109 pads,
6110 }
6111 }
6112
6113 // ── Shape 1: JoinLines ────────────────────────────────────────
6114
6115 /// Insert-mode Backspace at col 0 of "bar": the ONLY byte change is
6116 /// the '\n' at byte 3 being removed — "bar" stays in the buffer.
6117 #[test]
6118 fn join_backspace_at_col0_removes_only_the_newline() {
6119 let edits = check_shapes("foo\nbar\nbaz", join(0, 1, false));
6120 assert_eq!(edits.len(), 1);
6121 let e = &edits[0];
6122 assert_eq!(
6123 (e.start_byte, e.old_end_byte, e.new_end_byte),
6124 (3, 4, 3),
6125 "real change is [3, 4) → \"\"; got {e:?}"
6126 );
6127 assert_eq!(e.start_position, (0, 3));
6128 assert_eq!(e.old_end_position, (1, 0));
6129 assert_eq!(e.new_end_position, (0, 3));
6130 }
6131
6132 #[test]
6133 fn join_gj_style_no_space() {
6134 check_shapes("alpha\nbeta\ngamma", join(0, 1, false));
6135 check_shapes("alpha\nbeta\ngamma", join(1, 1, false));
6136 }
6137
6138 /// count=2 joins twice; each join's edit must be expressed against
6139 /// the document as modified by the previous join.
6140 #[test]
6141 fn join_count_two_emits_one_edit_per_join() {
6142 let edits = check_shapes("a\nb\nc\nd", join(0, 2, false));
6143 assert_eq!(edits.len(), 2, "one ContentEdit per join");
6144 }
6145
6146 #[test]
6147 fn join_with_space_inserts_single_space() {
6148 let edits = check_shapes("foo\nbar", join(0, 1, true));
6149 assert_eq!(edits.len(), 1);
6150 let e = &edits[0];
6151 assert_eq!((e.start_byte, e.old_end_byte, e.new_end_byte), (3, 4, 4));
6152 assert_eq!(e.new_end_position, (0, 4));
6153 }
6154
6155 /// `do_join_lines` skips the space when the incoming line is empty.
6156 #[test]
6157 fn join_with_space_next_line_empty_skips_space() {
6158 let edits = check_shapes("foo\n\nbar", join(0, 1, true));
6159 assert_eq!(edits.len(), 1);
6160 assert_eq!(edits[0].new_end_byte, edits[0].start_byte, "no space");
6161 }
6162
6163 /// count=2 with an empty middle line: join 1 inserts no space
6164 /// (suffix empty), join 2 does (both sides non-empty by then).
6165 #[test]
6166 fn join_with_space_count_two_over_empty_line() {
6167 let edits = check_shapes("foo\n\nbar", join(0, 2, true));
6168 assert_eq!(edits.len(), 2);
6169 assert_eq!(edits[0].new_end_byte, edits[0].start_byte);
6170 assert_eq!(edits[1].new_end_byte, edits[1].start_byte + 1);
6171 }
6172
6173 /// `do_join_lines` skips the space when the accumulated line is empty.
6174 #[test]
6175 fn join_with_space_prefix_empty_skips_space() {
6176 let edits = check_shapes("\nfoo", join(0, 1, true));
6177 assert_eq!(edits.len(), 1);
6178 assert_eq!(
6179 (
6180 edits[0].start_byte,
6181 edits[0].old_end_byte,
6182 edits[0].new_end_byte
6183 ),
6184 (0, 1, 0)
6185 );
6186 }
6187
6188 #[test]
6189 fn join_multibyte_lines() {
6190 // "héllo" = 6 bytes; the '\n' sits at byte 6.
6191 let edits = check_shapes("héllo\nwörld", join(0, 1, true));
6192 assert_eq!(edits.len(), 1);
6193 let e = &edits[0];
6194 assert_eq!((e.start_byte, e.old_end_byte, e.new_end_byte), (6, 7, 7));
6195 assert_eq!(e.start_position, (0, 6));
6196 assert_eq!(e.new_end_position, (0, 7));
6197 check_shapes("日本\n語だ\nよ", join(0, 2, false));
6198 }
6199
6200 /// The buffer stops joining when it runs out of rows; the emitted
6201 /// fan-out must stop with it.
6202 #[test]
6203 fn join_count_exceeding_rows_stops_at_last_join() {
6204 let edits = check_shapes("a\nb", join(0, 5, false));
6205 assert_eq!(edits.len(), 1, "only one join is possible");
6206 }
6207
6208 #[test]
6209 fn join_at_last_row_is_noop() {
6210 let edits = check_shapes("a\nb", join(1, 1, false));
6211 assert!(edits.is_empty(), "nothing to join → no ContentEdits");
6212 }
6213
6214 #[test]
6215 fn join_doc_with_trailing_newline() {
6216 // Lines: "foo", "" — joining consumes the trailing '\n'.
6217 let edits = check_shapes("foo\n", join(0, 1, false));
6218 assert_eq!(edits.len(), 1);
6219 assert_eq!(
6220 (
6221 edits[0].start_byte,
6222 edits[0].old_end_byte,
6223 edits[0].new_end_byte
6224 ),
6225 (3, 4, 3)
6226 );
6227 }
6228
6229 // ── Shape 2: linewise DeleteRange ending at the last row ─────
6230
6231 /// `dd` on the last row also removes the '\n' that ends the row
6232 /// above (matching `do_delete_range`), so the edit must start at
6233 /// EOL of row lo-1 and end at the true end of the document.
6234 #[test]
6235 fn linewise_delete_last_row_starts_at_prev_eol() {
6236 let edits = check_shapes("a\nb\nc", del((2, 0), (2, 0), MotionKind::Line));
6237 assert_eq!(edits.len(), 1);
6238 let e = &edits[0];
6239 assert_eq!(
6240 (e.start_byte, e.old_end_byte, e.new_end_byte),
6241 (3, 5, 3),
6242 "real change is [3, 5) → \"\"; got {e:?}"
6243 );
6244 assert_eq!(e.start_position, (1, 1));
6245 assert_eq!(e.old_end_position, (2, 1));
6246 assert_eq!(e.new_end_position, (1, 1));
6247 }
6248
6249 #[test]
6250 fn linewise_delete_multi_row_to_last() {
6251 let edits = check_shapes("a\nb\nc\nd", del((2, 0), (3, 0), MotionKind::Line));
6252 assert_eq!(edits.len(), 1);
6253 assert_eq!(
6254 (edits[0].start_byte, edits[0].old_end_byte),
6255 (3, 7),
6256 "[3, 7) covers \"\\nc\\nd\""
6257 );
6258 }
6259
6260 #[test]
6261 fn linewise_delete_whole_buffer() {
6262 let edits = check_shapes("a\nb\nc", del((0, 0), (2, 0), MotionKind::Line));
6263 assert_eq!(edits.len(), 1);
6264 let e = &edits[0];
6265 assert_eq!((e.start_byte, e.old_end_byte, e.new_end_byte), (0, 5, 0));
6266 assert_eq!(e.start_position, (0, 0));
6267 assert_eq!(e.old_end_position, (2, 1));
6268 }
6269
6270 #[test]
6271 fn linewise_delete_single_line_buffer() {
6272 check_shapes("abc", del((0, 0), (0, 0), MotionKind::Line));
6273 }
6274
6275 /// Regression guard: the not-at-end case was already correct.
6276 #[test]
6277 fn linewise_delete_interior_rows_unchanged() {
6278 let edits = check_shapes("a\nb\nc", del((0, 0), (1, 0), MotionKind::Line));
6279 assert_eq!(edits.len(), 1);
6280 let e = &edits[0];
6281 assert_eq!((e.start_byte, e.old_end_byte, e.new_end_byte), (0, 4, 0));
6282 assert_eq!(e.old_end_position, (2, 0));
6283 }
6284
6285 #[test]
6286 fn linewise_delete_last_row_multibyte() {
6287 // "aé" = 3 bytes, '\n' at 3, "bü" = 3 bytes → doc is 7 bytes.
6288 let edits = check_shapes("aé\nbü", del((1, 0), (1, 0), MotionKind::Line));
6289 assert_eq!(edits.len(), 1);
6290 let e = &edits[0];
6291 assert_eq!((e.start_byte, e.old_end_byte), (3, 7));
6292 assert_eq!(e.start_position, (0, 3));
6293 assert_eq!(e.old_end_position, (1, 3));
6294 }
6295
6296 /// End row past the last row must clamp like the buffer does.
6297 #[test]
6298 fn linewise_delete_end_row_overshoot_clamps() {
6299 check_shapes("a\nb\nc", del((1, 0), (9, 0), MotionKind::Line));
6300 }
6301
6302 /// Deleting the final empty line of a trailing-newline doc.
6303 #[test]
6304 fn linewise_delete_trailing_empty_last_row() {
6305 let edits = check_shapes("a\nb\n", del((2, 0), (2, 0), MotionKind::Line));
6306 assert_eq!(edits.len(), 1);
6307 assert_eq!((edits[0].start_byte, edits[0].old_end_byte), (3, 4));
6308 }
6309
6310 // ── Shape 3: visual-block delete fan-out ─────────────────────
6311
6312 /// Per-row edits carry pre-edit byte offsets, so they are only
6313 /// valid for a sequential consumer when emitted bottom-up.
6314 #[test]
6315 fn block_delete_emits_rows_descending() {
6316 let edits = check_shapes("abc\ndef\nghi", del((0, 0), (2, 1), MotionKind::Block));
6317 assert_eq!(edits.len(), 3);
6318 let rows: Vec<u32> = edits.iter().map(|e| e.start_position.0).collect();
6319 assert_eq!(
6320 rows,
6321 vec![2, 1, 0],
6322 "bottom-up so pre-edit offsets stay valid"
6323 );
6324 assert_eq!(
6325 (edits[0].start_byte, edits[0].old_end_byte),
6326 (8, 10),
6327 "row 2 cols 0..=1"
6328 );
6329 }
6330
6331 #[test]
6332 fn block_delete_multibyte() {
6333 // "éé" = 4 bytes + '\n' → row 1 starts at byte 5.
6334 let edits = check_shapes("éé\nüü", del((0, 0), (1, 0), MotionKind::Block));
6335 assert_eq!(edits.len(), 2);
6336 assert_eq!((edits[0].start_byte, edits[0].old_end_byte), (5, 7));
6337 assert_eq!((edits[1].start_byte, edits[1].old_end_byte), (0, 2));
6338 }
6339
6340 /// Rows shorter than the rectangle contribute nothing (matches
6341 /// `rope_cut_chars` clamping).
6342 #[test]
6343 fn block_delete_ragged_rows() {
6344 let edits = check_shapes("abcd\nx\nabcd", del((0, 1), (2, 2), MotionKind::Block));
6345 assert_eq!(edits.len(), 2, "middle row too short → skipped");
6346 }
6347
6348 /// End row past the last row: the buffer skips those rows; the
6349 /// fan-out must not emit clamped duplicates for them.
6350 #[test]
6351 fn block_delete_end_row_overshoot_clamps() {
6352 let edits = check_shapes("ab\ncd", del((0, 0), (5, 0), MotionKind::Block));
6353 assert_eq!(edits.len(), 2);
6354 }
6355
6356 // ── Shape 4: SplitLines (JoinLines inverse) ──────────────────
6357
6358 /// A single no-space split: the ONLY byte change is a '\n' inserted
6359 /// at the split col — mirrors `join_backspace_at_col0`'s inverse.
6360 #[test]
6361 fn split_single_col_no_space_inserts_newline() {
6362 let edits = check_shapes("foobar", split(0, vec![3], false));
6363 assert_eq!(edits.len(), 1);
6364 let e = &edits[0];
6365 assert_eq!((e.start_byte, e.old_end_byte, e.new_end_byte), (3, 3, 4));
6366 assert_eq!(e.start_position, (0, 3));
6367 assert_eq!(e.new_end_position, (1, 0));
6368 }
6369
6370 /// `inserted_space` REPLACES the space at the split col with '\n' —
6371 /// NOT a pure "\n " insert. `do_split_lines` removes the space then
6372 /// inserts '\n' at the same index: net 1 byte in, 1 byte out.
6373 #[test]
6374 fn split_with_space_replaces_the_space_not_inserts() {
6375 let edits = check_shapes("foo bar", split(0, vec![3], true));
6376 assert_eq!(edits.len(), 1);
6377 let e = &edits[0];
6378 assert_eq!(
6379 (e.start_byte, e.old_end_byte, e.new_end_byte),
6380 (3, 4, 4),
6381 "space at byte 3 replaced by '\\n' — 1 byte in, 1 byte out"
6382 );
6383 assert_eq!(e.new_end_position, (1, 0));
6384 }
6385
6386 /// Multiple splits (inverse of a count>1 join) apply RIGHT-TO-LEFT
6387 /// in the real buffer (`do_split_lines` iterates `cols.iter().rev()`)
6388 /// — same-row ascending pre-edit offsets would be wrong for a
6389 /// sequential consumer.
6390 #[test]
6391 fn split_multi_col_emits_descending() {
6392 // Inverse of joining "a", "b", "c" into "abc": cols = [1, 2].
6393 let edits = check_shapes("abc", split(0, vec![1, 2], false));
6394 assert_eq!(edits.len(), 2);
6395 let cols: Vec<u32> = edits.iter().map(|e| e.start_position.1).collect();
6396 assert_eq!(
6397 cols,
6398 vec![2, 1],
6399 "rightmost split first, matching do_split_lines"
6400 );
6401 }
6402
6403 /// Real round-trip: join then split the SAME buffer via the actual
6404 /// `do_join_lines`-produced inverse, count > 1 with an empty middle
6405 /// line — one join inserts no space (suffix empty), the other does.
6406 /// `check_shapes` cross-validates the SplitLines shape byte-exactly
6407 /// against this exact inverse, not a hand-picked one.
6408 #[test]
6409 fn split_round_trips_real_join_inverse_with_mixed_spaces() {
6410 let mut probe = View::from_str("foo\n\nbar");
6411 let inverse = probe.apply_edit(join(0, 2, true));
6412 let Edit::SplitLines {
6413 row: _,
6414 ref cols,
6415 ref inserted_spaces,
6416 } = inverse
6417 else {
6418 panic!("join's inverse must be SplitLines, got {inverse:?}");
6419 };
6420 assert_eq!(cols.len(), 2, "one recorded col per join");
6421 // First join (empty middle line as suffix) skips the space;
6422 // second join (now both sides non-empty) inserts one — per-col,
6423 // NOT the uniform with_space=true intent (audit-r2 fix 6).
6424 assert_eq!(
6425 inserted_spaces,
6426 &vec![false, true],
6427 "per-join outcome must reflect prefix/suffix emptiness, not just intent"
6428 );
6429 // The join's own inverse, replayed through content_edits_from_buffer_edit
6430 // against the joined ("foo bar") buffer, must byte-exactly reproduce
6431 // splitting it back apart.
6432 check_shapes("foo bar", inverse);
6433 }
6434
6435 /// A col at (or past) the split row's live end after a prior split
6436 /// truncated it: `do_split_lines` skips the space check (guard is
6437 /// `col < lc`) and falls through to a bare '\n' insert.
6438 #[test]
6439 fn split_duplicate_col_past_truncated_row_is_plain_insert() {
6440 let edits = check_shapes("foo bar", split(0, vec![3, 3], true));
6441 assert_eq!(edits.len(), 2);
6442 // First-processed (reverse order) col=3: space replaced by '\n'.
6443 assert_eq!(
6444 (
6445 edits[0].start_byte,
6446 edits[0].old_end_byte,
6447 edits[0].new_end_byte
6448 ),
6449 (3, 4, 4)
6450 );
6451 // Second-processed (also col=3, but now `3 < current_lc(=3)` is
6452 // false): plain '\n' insert, no deletion.
6453 assert_eq!(
6454 (
6455 edits[1].start_byte,
6456 edits[1].old_end_byte,
6457 edits[1].new_end_byte
6458 ),
6459 (3, 3, 4)
6460 );
6461 }
6462
6463 // ── Shape 5: InsertBlock fan-out ──────────────────────────────
6464
6465 /// Per-row edits carry pre-edit byte offsets, so — like block-delete
6466 /// — they are only valid for a sequential consumer when emitted
6467 /// bottom-up.
6468 #[test]
6469 fn insert_block_emits_rows_descending() {
6470 let edits = check_shapes("abc\ndef\nghi", insert_block((0, 1), &["X", "Y", "Z"]));
6471 assert_eq!(edits.len(), 3);
6472 let rows: Vec<u32> = edits.iter().map(|e| e.start_position.0).collect();
6473 assert_eq!(
6474 rows,
6475 vec![2, 1, 0],
6476 "bottom-up so pre-edit offsets stay valid"
6477 );
6478 }
6479
6480 #[test]
6481 fn insert_block_multibyte() {
6482 // "éé" = 4 bytes + '\n' → row 1 starts at byte 5.
6483 let edits = check_shapes("éé\nüü", insert_block((0, 1), &["x", "y"]));
6484 assert_eq!(edits.len(), 2);
6485 }
6486
6487 // ── Shape 6: DeleteBlockChunks fan-out ────────────────────────
6488
6489 #[test]
6490 fn delete_block_chunks_emits_rows_descending() {
6491 let edits = check_shapes("abc\ndef\nghi", delete_block_chunks((0, 0), vec![1, 1, 1]));
6492 assert_eq!(edits.len(), 3);
6493 let rows: Vec<u32> = edits.iter().map(|e| e.start_position.0).collect();
6494 assert_eq!(rows, vec![2, 1, 0]);
6495 }
6496
6497 /// A row too short for the block's column contributes nothing —
6498 /// matches `do_delete_block_chunks`'s per-row clamp.
6499 #[test]
6500 fn delete_block_chunks_ragged_rows_skip_empty() {
6501 let edits = check_shapes("abcd\nx\nabcd", delete_block_chunks((0, 2), vec![1, 1, 1]));
6502 assert_eq!(edits.len(), 2, "middle row too short → skipped");
6503 }
6504
6505 // ── Sanity: shapes that were already correct stay correct ────
6506
6507 #[test]
6508 fn charwise_and_insert_shapes_still_hold() {
6509 check_shapes("héllo wörld", del((0, 2), (0, 7), MotionKind::Char));
6510 check_shapes("a\nb\nc", del((0, 1), (2, 0), MotionKind::Char));
6511 check_shapes(
6512 "abc",
6513 Edit::InsertStr {
6514 at: Position::new(0, 1),
6515 text: "x\ny".to_string(),
6516 },
6517 );
6518 check_shapes(
6519 "abc\ndef",
6520 Edit::Replace {
6521 start: Position::new(0, 1),
6522 end: Position::new(1, 1),
6523 with: "Z\nQ".to_string(),
6524 },
6525 );
6526 }
6527}
6528
6529#[cfg(test)]
6530mod earlier_later_tests {
6531 use super::*;
6532 use crate::types::{DefaultHost, Options};
6533 use hjkl_buffer::View;
6534 use std::time::{Duration, SystemTime};
6535
6536 fn make_ed(content: &str) -> Editor<View, DefaultHost> {
6537 let buf = View::from_str(content);
6538 Editor::new(buf, DefaultHost::default(), Options::default())
6539 }
6540
6541 // ── step-based ───────────────────────────────────────────────────────────
6542
6543 #[test]
6544 fn earlier_by_steps_n_undoes_n_changes() {
6545 let mut ed = make_ed("hello");
6546 ed.push_undo(); // snap 1
6547 ed.push_undo(); // snap 2
6548 ed.push_undo(); // snap 3
6549 assert_eq!(ed.undo_stack_len(), 3);
6550 let applied = ed.earlier_by_steps(2);
6551 assert_eq!(applied, 2);
6552 assert_eq!(ed.undo_stack_len(), 1);
6553 }
6554
6555 #[test]
6556 fn earlier_by_steps_caps_at_stack_size() {
6557 let mut ed = make_ed("hello");
6558 ed.push_undo(); // snap 1
6559 // Ask for 10 but only 1 available.
6560 let applied = ed.earlier_by_steps(10);
6561 assert_eq!(applied, 1);
6562 assert_eq!(ed.undo_stack_len(), 0);
6563 }
6564
6565 #[test]
6566 fn later_by_steps_n_redoes_n_changes() {
6567 let mut ed = make_ed("hello");
6568 ed.push_undo(); // snap 1
6569 ed.push_undo(); // snap 2
6570 ed.push_undo(); // snap 3
6571 // Undo all 3 so they're on redo stack.
6572 ed.earlier_by_steps(3);
6573 assert_eq!(ed.undo_stack_len(), 0);
6574 let applied = ed.later_by_steps(2);
6575 assert_eq!(applied, 2);
6576 assert_eq!(ed.undo_stack_len(), 2);
6577 }
6578
6579 #[test]
6580 fn later_by_steps_caps_at_redo_stack_size() {
6581 let mut ed = make_ed("hello");
6582 ed.push_undo(); // snap 1
6583 ed.earlier_by_steps(1); // moves to redo
6584 let applied = ed.later_by_steps(99);
6585 assert_eq!(applied, 1);
6586 }
6587
6588 // ── time-based ───────────────────────────────────────────────────────────
6589
6590 fn epoch_plus(secs: u64) -> SystemTime {
6591 SystemTime::UNIX_EPOCH + Duration::from_secs(secs)
6592 }
6593
6594 #[test]
6595 fn earlier_by_time_stops_at_target_boundary() {
6596 let mut ed = make_ed("hello");
6597 // Push 3 entries at t-30s, t-20s, t-10s (relative to epoch).
6598 ed.push_undo_at(epoch_plus(30));
6599 ed.push_undo_at(epoch_plus(40));
6600 ed.push_undo_at(epoch_plus(50));
6601 // Redo stack is empty; undo has 3 entries.
6602 // target = epoch+35 → should undo entries at t=50 and t=40, stop at t=30
6603 let target = epoch_plus(35);
6604 let applied = ed.earlier_by_time(target);
6605 assert_eq!(applied, 2, "should undo t=50 and t=40; stop at t=30");
6606 assert_eq!(ed.undo_stack_len(), 1, "t=30 entry remains");
6607 }
6608
6609 #[test]
6610 fn earlier_by_time_empty_stack_returns_zero() {
6611 let mut ed = make_ed("hello");
6612 let applied = ed.earlier_by_time(epoch_plus(999));
6613 assert_eq!(applied, 0);
6614 assert_eq!(ed.undo_stack_len(), 0);
6615 }
6616
6617 #[test]
6618 fn later_by_time_target_in_future_redoes_all() {
6619 let mut ed = make_ed("hello");
6620 ed.push_undo_at(epoch_plus(10));
6621 ed.push_undo_at(epoch_plus(20));
6622 // Undo both → they move to redo stack with their timestamps preserved.
6623 ed.earlier_by_steps(2);
6624 // target far in future: should redo all.
6625 let applied = ed.later_by_time(epoch_plus(9999));
6626 assert_eq!(applied, 2);
6627 assert_eq!(ed.undo_stack_len(), 2);
6628 }
6629}
6630
6631// ─── modifiable / readonly semantics tests ────────────────────────────────────
6632
6633#[cfg(test)]
6634mod shared_registers_tests {
6635 use super::*;
6636 use crate::types::{DefaultHost, Options};
6637 use hjkl_buffer::View;
6638
6639 #[test]
6640 fn shared_register_bank_visible_across_editors() {
6641 let shared =
6642 std::sync::Arc::new(std::sync::Mutex::new(crate::registers::Registers::default()));
6643 let mut a = Editor::new(View::new(), DefaultHost::default(), Options::default());
6644 a.set_registers_arc(shared.clone());
6645 let mut b = Editor::new(View::new(), DefaultHost::default(), Options::default());
6646 b.set_registers_arc(shared.clone());
6647 // Write to editor A's unnamed register
6648 a.with_registers_mut(|r| {
6649 r.unnamed = crate::registers::Slot {
6650 text: "hello".to_string(),
6651 linewise: false,
6652 ..Default::default()
6653 };
6654 });
6655 // Read from editor B — same bank, no copy needed
6656 assert_eq!(b.with_registers(|r| r.unnamed.text.clone()), "hello");
6657 }
6658
6659 /// #279 slice 4: the `linewise` flag on a `Slot` must travel with the
6660 /// shared register bank, not just the text — `do_paste`
6661 /// (hjkl-vim/src/vim/command.rs) sources its linewise decision from the
6662 /// selected register slot precisely so a whole-line yank in one window
6663 /// pastes linewise in a sibling window. This proves the shared `Arc`
6664 /// carries that bit, independent of the per-editor `yank_linewise` bool
6665 /// (which is deliberately NOT shared — see its doc comment).
6666 #[test]
6667 fn shared_register_bank_linewise_visible_across_editors() {
6668 let shared =
6669 std::sync::Arc::new(std::sync::Mutex::new(crate::registers::Registers::default()));
6670 let mut a = Editor::new(View::new(), DefaultHost::default(), Options::default());
6671 a.set_registers_arc(shared.clone());
6672 let mut b = Editor::new(View::new(), DefaultHost::default(), Options::default());
6673 b.set_registers_arc(shared.clone());
6674 // Write a LINEWISE yank to editor A's unnamed register.
6675 a.with_registers_mut(|r| {
6676 r.unnamed = crate::registers::Slot {
6677 text: "hello\n".to_string(),
6678 linewise: true,
6679 ..Default::default()
6680 };
6681 });
6682 // Read from editor B — same bank, so the linewise bit must be
6683 // visible too, not just the text.
6684 assert!(
6685 b.with_registers(|r| r.unnamed.linewise),
6686 "editor B should see editor A's linewise flag through the \
6687 shared register Arc"
6688 );
6689 }
6690
6691 /// `with_registers` / `with_registers_mut` are the only sanctioned way
6692 /// to touch the register bank from outside `editor.rs` (audit item
6693 /// B4) — the lock must stay scoped to the closure, and the closure's
6694 /// return value must plumb through untouched so callers can extract
6695 /// owned data without holding a guard.
6696 #[test]
6697 fn with_registers_round_trip_and_return_value_plumbs_through() {
6698 let ed = Editor::new(View::new(), DefaultHost::default(), Options::default());
6699
6700 // Write path: with_registers_mut mutates in place and returns a
6701 // value derived from the mutation.
6702 let wrote = ed.with_registers_mut(|r| {
6703 r.unnamed = crate::registers::Slot {
6704 text: "round-trip".to_string(),
6705 linewise: false,
6706 ..Default::default()
6707 };
6708 r.unnamed.text.len()
6709 });
6710 assert_eq!(wrote, "round-trip".len());
6711
6712 // Read path: with_registers sees the write and its return value
6713 // is the owned data extracted inside the closure.
6714 let read = ed.with_registers(|r| r.unnamed.text.clone());
6715 assert_eq!(read, "round-trip");
6716 }
6717}
6718
6719// ─── shared global-marks bank tests (#279 slice 1) ────────────────────────────
6720
6721#[cfg(test)]
6722mod shared_global_marks_tests {
6723 use super::*;
6724 use crate::types::{DefaultHost, Options};
6725 use hjkl_buffer::View;
6726
6727 #[test]
6728 fn shared_global_marks_bank_visible_across_editors() {
6729 let shared = std::sync::Arc::new(std::sync::Mutex::new(std::collections::BTreeMap::new()));
6730 let mut a = Editor::new(View::new(), DefaultHost::default(), Options::default());
6731 a.set_global_marks_arc(shared.clone());
6732 let mut b = Editor::new(View::new(), DefaultHost::default(), Options::default());
6733 b.set_global_marks_arc(shared.clone());
6734 // Set a global mark on editor A.
6735 a.set_global_mark('A', 7, (3, 5));
6736 // Read from editor B — same bank, no copy needed.
6737 assert_eq!(b.global_mark('A'), Some((7, 3, 5)));
6738 }
6739
6740 #[test]
6741 fn unshared_global_marks_stay_isolated() {
6742 let mut a = Editor::new(View::new(), DefaultHost::default(), Options::default());
6743 let b = Editor::new(View::new(), DefaultHost::default(), Options::default());
6744 a.set_global_mark('A', 1, (0, 0));
6745 // No shared Arc wired — B must not see A's mark.
6746 assert_eq!(b.global_mark('A'), None);
6747 }
6748}
6749
6750// ─── shared last-substitute bank tests (#279 slice 2) ─────────────────────
6751
6752#[cfg(test)]
6753mod shared_last_substitute_tests {
6754 use super::*;
6755 use crate::types::{DefaultHost, Options};
6756 use hjkl_buffer::View;
6757
6758 fn dummy_cmd(replacement: &str) -> crate::substitute::SubstituteCmd {
6759 crate::substitute::SubstituteCmd {
6760 pattern: Some("foo".to_string()),
6761 replacement: replacement.to_string(),
6762 flags: crate::substitute::SubstFlags::default(),
6763 count: None,
6764 }
6765 }
6766
6767 #[test]
6768 fn shared_last_substitute_bank_visible_across_editors() {
6769 let shared = std::sync::Arc::new(std::sync::Mutex::new(None));
6770 let mut a = Editor::new(View::new(), DefaultHost::default(), Options::default());
6771 a.set_last_substitute_arc(shared.clone());
6772 let mut b = Editor::new(View::new(), DefaultHost::default(), Options::default());
6773 b.set_last_substitute_arc(shared.clone());
6774 // Run `:s` (set the last substitute) on editor A.
6775 a.set_last_substitute(dummy_cmd("bar"));
6776 // Read from editor B — same bank, no copy needed.
6777 assert_eq!(b.last_substitute(), Some(dummy_cmd("bar")));
6778 }
6779
6780 #[test]
6781 fn unshared_last_substitute_stays_isolated() {
6782 let mut a = Editor::new(View::new(), DefaultHost::default(), Options::default());
6783 let b = Editor::new(View::new(), DefaultHost::default(), Options::default());
6784 a.set_last_substitute(dummy_cmd("bar"));
6785 // No shared Arc wired — B must not see A's last substitute.
6786 assert_eq!(b.last_substitute(), None);
6787 }
6788}
6789
6790// ─── shared abbreviations bank tests (#279 slice 3) ───────────────────────
6791
6792#[cfg(test)]
6793mod shared_abbrevs_tests {
6794 use super::*;
6795 use crate::types::{DefaultHost, Options};
6796 use hjkl_buffer::View;
6797
6798 #[test]
6799 fn shared_abbrevs_bank_visible_across_editors() {
6800 let shared = std::sync::Arc::new(std::sync::Mutex::new(Vec::new()));
6801 let mut a = Editor::new(View::new(), DefaultHost::default(), Options::default());
6802 a.set_abbrevs_arc(shared.clone());
6803 let mut b = Editor::new(View::new(), DefaultHost::default(), Options::default());
6804 b.set_abbrevs_arc(shared.clone());
6805 // Define an abbreviation on editor A.
6806 a.add_abbrev("foo", "bar", true, true, false);
6807 // Read from editor B — same bank, no copy needed.
6808 let b_abbrevs = b.abbrevs();
6809 assert_eq!(b_abbrevs.len(), 1);
6810 assert_eq!(b_abbrevs[0].lhs, "foo");
6811 assert_eq!(b_abbrevs[0].rhs, "bar");
6812 }
6813
6814 #[test]
6815 fn unshared_abbrevs_stay_isolated() {
6816 let mut a = Editor::new(View::new(), DefaultHost::default(), Options::default());
6817 let b = Editor::new(View::new(), DefaultHost::default(), Options::default());
6818 a.add_abbrev("foo", "bar", true, true, false);
6819 // No shared Arc wired — B must not see A's abbrev.
6820 assert!(b.abbrevs().is_empty());
6821 }
6822}
6823
6824// ─── shared search bank tests (audit B2) ──────────────────────────────────
6825
6826#[cfg(test)]
6827mod shared_search_tests {
6828 use super::*;
6829 use crate::types::{DefaultHost, Options};
6830 use hjkl_buffer::View;
6831
6832 #[test]
6833 fn shared_search_bank_visible_across_editors() {
6834 let shared = std::sync::Arc::new(std::sync::Mutex::new(SearchBank::default()));
6835 let mut a = Editor::new(View::new(), DefaultHost::default(), Options::default());
6836 a.set_search_arc(shared.clone());
6837 let mut b = Editor::new(View::new(), DefaultHost::default(), Options::default());
6838 b.set_search_arc(shared.clone());
6839 // Commit a search on editor A.
6840 a.set_last_search(Some("foo".to_string()), true);
6841 // Read from editor B — same bank, no copy needed.
6842 assert_eq!(b.last_search(), Some("foo".to_string()));
6843 assert!(b.last_search_forward());
6844 }
6845
6846 #[test]
6847 fn unshared_search_stays_isolated() {
6848 let mut a = Editor::new(View::new(), DefaultHost::default(), Options::default());
6849 let b = Editor::new(View::new(), DefaultHost::default(), Options::default());
6850 a.set_last_search(Some("foo".to_string()), true);
6851 // No shared Arc wired — B must not see A's search.
6852 assert_eq!(b.last_search(), None);
6853 }
6854}
6855
6856// ─── shared change-bank tests (audit B3) ──────────────────────────────────
6857//
6858// Unlike the banks above (one Arc shared by every editor in the app), the
6859// change bank is PER-BUFFER: the app keys one Arc per `buffer_id` and hands
6860// each editor the Arc for its CURRENT buffer. These tests model that at the
6861// `Editor` level — the "keyed by buffer_id" bookkeeping itself lives on the
6862// app (`App::change_bank_for`), which has no unit-test seam here.
6863
6864#[cfg(test)]
6865mod shared_change_bank_tests {
6866 use super::*;
6867 use crate::types::{DefaultHost, Options};
6868 use hjkl_buffer::{Edit, Position, View};
6869
6870 fn editor_with(content: &str) -> Editor<View, DefaultHost> {
6871 let mut e = Editor::new(View::new(), DefaultHost::default(), Options::default());
6872 e.set_content(content);
6873 e
6874 }
6875
6876 /// Move the cursor to `(row, col)` then insert `text` there via the
6877 /// core edit funnel. `mutate_edit` records the dot mark / changelist
6878 /// entry from the LIVE cursor position (matching real FSM edits, which
6879 /// always type at the cursor) — not from the `Edit`'s `at` field — so
6880 /// the cursor must be positioned first.
6881 fn record_insert(e: &mut Editor<View, DefaultHost>, row: usize, col: usize, text: &str) {
6882 e.jump_cursor(row, col);
6883 e.mutate_edit(Edit::InsertStr {
6884 at: Position::new(row, col),
6885 text: text.to_string(),
6886 });
6887 }
6888
6889 /// (1) Two editors wired to the same buffer's bank share a changelist —
6890 /// an edit recorded via A is visible to B's `last_edit_pos` / `change_list`.
6891 #[test]
6892 fn shared_change_bank_visible_across_editors_on_same_buffer() {
6893 let shared = std::sync::Arc::new(std::sync::Mutex::new(ChangeBank::default()));
6894 let mut a = editor_with("alpha\nbeta\ngamma\n");
6895 a.set_change_bank_arc(shared.clone());
6896 let mut b = editor_with("alpha\nbeta\ngamma\n");
6897 b.set_change_bank_arc(shared.clone());
6898
6899 // Edit via editor A (e.g. window A on a `:split`).
6900 record_insert(&mut a, 1, 0, "X");
6901
6902 // Editor B (a sibling window on the SAME buffer) must see A's edit
6903 // in both the dot mark and the changelist ring. Both record the
6904 // PRE-edit cursor position — (1, 0), where `record_insert` placed
6905 // the cursor before inserting "X" — matching vim's `g;` landing on
6906 // the start of a change, not one past it (verified against real
6907 // nvim; see the `mutate_edit` comment at the changelist push site).
6908 assert_eq!(b.last_edit_pos(), Some((1, 0)));
6909 let (list, _) = b.change_list();
6910 assert_eq!(list, vec![(1, 0)]);
6911 }
6912
6913 /// (2) NEGATIVE — two editors on DIFFERENT buffers (independent banks,
6914 /// as if on different buffer_ids) must stay isolated.
6915 #[test]
6916 fn unshared_change_banks_on_different_buffers_stay_isolated() {
6917 let mut a = editor_with("alpha\nbeta\ngamma\n");
6918 let b = editor_with("alpha\nbeta\ngamma\n");
6919 // No Arc shared — each editor keeps its own default bank, exactly
6920 // as if `a` and `b` were windows on two different buffer_ids.
6921 record_insert(&mut a, 1, 0, "X");
6922
6923 assert_eq!(a.last_edit_pos(), Some((1, 0)));
6924 assert_eq!(
6925 b.last_edit_pos(),
6926 None,
6927 "different buffer must not see A's edit"
6928 );
6929 let (b_list, _) = b.change_list();
6930 assert!(b_list.is_empty());
6931 }
6932
6933 /// (3) An editor switched from buffer X's bank to buffer Y's bank picks
6934 /// up Y's changelist — and X's bank is left untouched by the switch.
6935 #[test]
6936 fn switching_buffers_swaps_to_the_new_buffers_bank() {
6937 let bank_x = std::sync::Arc::new(std::sync::Mutex::new(ChangeBank::default()));
6938 let bank_y = std::sync::Arc::new(std::sync::Mutex::new(ChangeBank::default()));
6939
6940 let mut ed = editor_with("alpha\nbeta\ngamma\n");
6941 ed.set_change_bank_arc(bank_x.clone());
6942 record_insert(&mut ed, 0, 0, "X");
6943 assert_eq!(ed.last_edit_pos(), Some((0, 0)));
6944
6945 // Simulate the app retargeting this window's editor onto a
6946 // different buffer (e.g. `:e other.txt` in that window).
6947 ed.set_change_bank_arc(bank_y.clone());
6948
6949 // The editor now sees Y's (empty) bank, not X's edit.
6950 assert_eq!(
6951 ed.last_edit_pos(),
6952 None,
6953 "after switching buffers the editor must see the NEW buffer's bank"
6954 );
6955 let (list, _) = ed.change_list();
6956 assert!(list.is_empty());
6957
6958 // X's bank is untouched by the switch — a sibling window still on
6959 // buffer X (if any) would still see the edit.
6960 assert_eq!(bank_x.lock().unwrap().last_edit, Some((0, 0)));
6961 }
6962}
6963
6964#[cfg(test)]
6965mod scroll_anim_tests {
6966 use super::*;
6967 use crate::types::{DefaultHost, Host, Options};
6968 use hjkl_buffer::View;
6969
6970 fn make_editor_with_content(content: &str) -> Editor<View, DefaultHost> {
6971 let mut buf = View::new();
6972 crate::types::BufferEdit::replace_all(&mut buf, content);
6973 let host = DefaultHost::new();
6974 Editor::new(buf, host, Options::default())
6975 }
6976
6977 #[test]
6978 fn scroll_duration_default_is_zero() {
6979 let buf = View::new();
6980 let host = DefaultHost::new();
6981 let ed = Editor::new(buf, host, Options::default());
6982 assert_eq!(ed.settings().scroll_duration_ms, 0);
6983 }
6984
6985 #[test]
6986 fn take_scroll_anim_hint_false_initially() {
6987 let buf = View::new();
6988 let host = DefaultHost::new();
6989 let mut ed = Editor::new(buf, host, Options::default());
6990 assert!(!ed.take_scroll_anim_hint());
6991 }
6992
6993 #[test]
6994 fn take_scroll_anim_hint_one_shot() {
6995 // Half-page scroll sets the hint; second drain clears it.
6996 let content: String = (0..50).map(|i| format!("line {i}\n")).collect();
6997 let mut ed = make_editor_with_content(&content);
6998 // Set viewport height so scroll actually moves
6999 ed.host_mut().viewport_mut().height = 20;
7000 ed.host_mut().viewport_mut().width = 80;
7001 ed.host_mut().viewport_mut().text_width = 80;
7002 ed.scroll_half_page(crate::types::ScrollDir::Down, 1);
7003 assert!(
7004 ed.take_scroll_anim_hint(),
7005 "hint should be set after half-page"
7006 );
7007 assert!(
7008 !ed.take_scroll_anim_hint(),
7009 "hint should be cleared on second drain"
7010 );
7011 }
7012
7013 #[test]
7014 fn line_scroll_does_not_set_hint() {
7015 let content: String = (0..50).map(|i| format!("line {i}\n")).collect();
7016 let mut ed = make_editor_with_content(&content);
7017 ed.host_mut().viewport_mut().height = 20;
7018 ed.host_mut().viewport_mut().width = 80;
7019 ed.host_mut().viewport_mut().text_width = 80;
7020 ed.scroll_line(crate::types::ScrollDir::Down, 1);
7021 assert!(
7022 !ed.take_scroll_anim_hint(),
7023 "hint must NOT be set for C-e/C-y"
7024 );
7025 }
7026}
7027
7028// ── UndoGranularity unit tests ───────────────────────────────────────────────
7029//
7030// These tests prove the critical invariant: vim (InsertSession) is byte-
7031// identical before and after this feature; Word granularity splits undo at
7032// word boundaries.
7033
7034#[cfg(test)]
7035mod undo_group_tests {
7036 use super::*;
7037 use crate::types::{DefaultHost, Options};
7038 use hjkl_buffer::{Edit, Position, View};
7039
7040 fn make_ed(content: &str) -> Editor<View, DefaultHost> {
7041 let buf = View::from_str(content);
7042 Editor::new(buf, DefaultHost::default(), Options::default())
7043 }
7044
7045 fn insert_x(ed: &mut Editor<View, DefaultHost>, row: usize) {
7046 ed.mutate_edit(Edit::InsertStr {
7047 at: Position::new(row, 0),
7048 text: "X".to_string(),
7049 });
7050 }
7051
7052 fn line0(ed: &Editor<View, DefaultHost>) -> String {
7053 hjkl_buffer::rope_line_str(&ed.buffer().rope(), 0)
7054 }
7055
7056 /// depth == 0: `push_undo` behaves exactly as before — every call snapshots
7057 /// (no coalescing), even with no intervening mutation.
7058 #[test]
7059 fn depth_zero_push_undo_is_unchanged() {
7060 let mut ed = make_ed("hello");
7061 ed.push_undo();
7062 ed.push_undo();
7063 ed.push_undo();
7064 assert_eq!(ed.undo_stack_len(), 3, "no coalescing outside a group");
7065 }
7066
7067 /// A group with one real mutation records exactly ONE entry, and a single
7068 /// undo reverts it.
7069 #[test]
7070 fn group_single_edit_is_one_entry() {
7071 let mut ed = make_ed("hello");
7072 {
7073 let _g = ed.undo_group();
7074 ed.push_undo();
7075 insert_x(&mut ed, 0);
7076 }
7077 assert_eq!(ed.undo_stack_len(), 1);
7078 assert_eq!(line0(&ed), "Xhello");
7079 ed.undo();
7080 assert_eq!(line0(&ed), "hello");
7081 assert_eq!(ed.undo_stack_len(), 0);
7082 }
7083
7084 /// Many `push_undo` + many edits inside one group still collapse to ONE
7085 /// entry, and one undo reverts the whole batch.
7086 #[test]
7087 fn group_coalesces_many_edits_into_one() {
7088 let mut ed = make_ed("hello");
7089 {
7090 let _g = ed.undo_group();
7091 for _ in 0..5 {
7092 ed.push_undo();
7093 insert_x(&mut ed, 0);
7094 }
7095 }
7096 assert_eq!(ed.undo_stack_len(), 1);
7097 assert_eq!(line0(&ed), "XXXXXhello");
7098 ed.undo();
7099 assert_eq!(line0(&ed), "hello", "one undo reverts every grouped edit");
7100 }
7101
7102 /// A group that pushes an undo but mutates nothing leaves ZERO entries.
7103 #[test]
7104 fn no_op_group_leaves_zero_entries() {
7105 let mut ed = make_ed("hello");
7106 {
7107 let _g = ed.undo_group();
7108 ed.push_undo();
7109 // no mutation
7110 }
7111 assert_eq!(
7112 ed.undo_stack_len(),
7113 0,
7114 "an unmutated group must discard its armed snapshot"
7115 );
7116 }
7117
7118 /// A completely empty group (no push_undo at all) leaves ZERO entries.
7119 #[test]
7120 fn empty_group_leaves_zero_entries() {
7121 let mut ed = make_ed("hello");
7122 {
7123 let _g = ed.undo_group();
7124 }
7125 assert_eq!(ed.undo_stack_len(), 0);
7126 }
7127
7128 /// Nested groups: only the OUTERMOST close commits; the inner guard drop
7129 /// does not, so the whole thing is one entry.
7130 #[test]
7131 fn nested_groups_commit_only_at_outermost() {
7132 let mut ed = make_ed("hello");
7133 {
7134 let _outer = ed.undo_group();
7135 ed.push_undo();
7136 insert_x(&mut ed, 0);
7137 {
7138 let _inner = ed.undo_group();
7139 ed.push_undo();
7140 insert_x(&mut ed, 0);
7141 // inner drops here: depth 2 -> 1, NOT committed yet.
7142 }
7143 assert_eq!(
7144 ed.undo_stack_len(),
7145 1,
7146 "inner close must not commit while the outer group is open"
7147 );
7148 insert_x(&mut ed, 0);
7149 }
7150 assert_eq!(
7151 ed.undo_stack_len(),
7152 1,
7153 "outer close commits the single entry"
7154 );
7155 assert_eq!(line0(&ed), "XXXhello");
7156 ed.undo();
7157 assert_eq!(line0(&ed), "hello");
7158 }
7159
7160 /// A group commits ONE entry that does not clobber a pre-existing entry:
7161 /// after a prior depth-0 change, a grouped change adds exactly one more.
7162 #[test]
7163 fn group_adds_single_entry_over_prior_history() {
7164 let mut ed = make_ed("hello");
7165 // Prior standalone change (depth 0).
7166 ed.push_undo();
7167 insert_x(&mut ed, 0);
7168 assert_eq!(ed.undo_stack_len(), 1);
7169 // Grouped change.
7170 {
7171 let _g = ed.undo_group();
7172 ed.push_undo();
7173 insert_x(&mut ed, 0);
7174 ed.push_undo();
7175 insert_x(&mut ed, 0);
7176 }
7177 assert_eq!(ed.undo_stack_len(), 2, "group adds exactly one entry");
7178 assert_eq!(line0(&ed), "XXXhello");
7179 ed.undo();
7180 assert_eq!(
7181 line0(&ed),
7182 "Xhello",
7183 "one undo reverts only the grouped edits"
7184 );
7185 ed.undo();
7186 assert_eq!(line0(&ed), "hello");
7187 }
7188}
7189
7190// ---- Settings ↔ Options conversion tests ----------------------------------
7191//
7192// `Settings::to_options` used to map ~20 fields and backfill the rest with
7193// `..Options::default()`, while `Settings::apply_options` wrote (nearly) all of
7194// them. Read-modify-apply callers (`Editor::current_options()` → tweak one
7195// field → `Editor::apply_options()`, e.g. the nvim-API `set_lines` modeline
7196// overlay) therefore silently reset every unmapped option to its SPEC default.
7197// These tests pin the seam shut.
7198
7199#[cfg(test)]
7200mod options_conversion_tests {
7201 use super::*;
7202 use crate::types::{
7203 DefaultHost, DiagInlineMode, FoldMethod, ListChars, Options, SignColumnMode, WrapMode,
7204 };
7205 use hjkl_buffer::View;
7206
7207 /// An `Options` value in which EVERY field differs from
7208 /// `Options::default()`, so a lossy conversion cannot hide behind a
7209 /// coincidentally-matching default.
7210 fn all_non_default_options() -> Options {
7211 let o = Options {
7212 tabstop: 7,
7213 shiftwidth: 3,
7214 expandtab: false,
7215 softtabstop: 2,
7216 iskeyword: "@,_,45".to_string(),
7217 ignorecase: false,
7218 smartcase: false,
7219 hlsearch: false,
7220 incsearch: false,
7221 wrapscan: false,
7222 autoindent: false,
7223 smartindent: false,
7224 timeout_len: core::time::Duration::from_millis(250),
7225 undo_levels: 42,
7226 undo_break_on_motion: false,
7227 readonly: true,
7228 modifiable: false,
7229 wrap: WrapMode::Word,
7230 textwidth: 100,
7231 number: false,
7232 relativenumber: true,
7233 numberwidth: 9,
7234 cursorline: true,
7235 cursorcolumn: false,
7236 signcolumn: SignColumnMode::Yes,
7237 foldcolumn: 3,
7238 foldmethod: FoldMethod::Marker,
7239 foldenable: false,
7240 foldlevelstart: 0,
7241 foldmarker: "<<<,>>>".to_string(),
7242 colorcolumn: "80,120".to_string(),
7243 formatoptions: "r".to_string(),
7244 filetype: "rust".to_string(),
7245 scrolloff: 11,
7246 sidescrolloff: 13,
7247 modeline: false,
7248 modelines: 8,
7249 autoreload: false,
7250 motion_sneak: false,
7251 list: true,
7252 listchars: ListChars {
7253 tab_lead: '»',
7254 tab_fill: None,
7255 space: Some('␣'),
7256 trail: Some('·'),
7257 eol: Some('¬'),
7258 nbsp: Some('⍽'),
7259 extends: Some('>'),
7260 precedes: Some('<'),
7261 },
7262 indent_guides: false,
7263 indent_guide_char: '|',
7264 colorizer: false,
7265 colorizer_filetypes: vec!["zig".to_string()],
7266 format_on_save: false,
7267 trim_trailing_whitespace: true,
7268 rainbow_brackets: false,
7269 updatetime: 250,
7270 matchparen: false,
7271 fixendofline: false,
7272 };
7273 // Guard the guard: if a future field lands with a value that happens to
7274 // equal the default, this literal stops proving anything for it.
7275 let d = Options::default();
7276 assert_ne!(o, d, "fixture must differ from Options::default()");
7277 o
7278 }
7279
7280 /// `apply_options` then `current_options` must be the IDENTITY on every
7281 /// field the engine stores. Fails today for `number`, `cursorline`,
7282 /// `signcolumn`, the fold options, `listchars`, `colorizer*`, … — the
7283 /// whole set `to_options` used to backfill from the default.
7284 #[test]
7285 fn settings_options_round_trip_is_identity() {
7286 let mut ed = Editor::new(View::new(), DefaultHost::new(), Options::default());
7287 let want = all_non_default_options();
7288 ed.apply_options(&want);
7289
7290 let got = ed.current_options();
7291 assert_eq!(
7292 got, want,
7293 "current_options() must echo apply_options() field-for-field"
7294 );
7295 }
7296
7297 /// A second pass must not drift: `apply(current())` is a fixed point.
7298 #[test]
7299 fn round_trip_is_idempotent() {
7300 let mut ed = Editor::new(View::new(), DefaultHost::new(), Options::default());
7301 ed.apply_options(&all_non_default_options());
7302 let first = ed.current_options();
7303 ed.apply_options(&first);
7304 assert_eq!(ed.current_options(), first);
7305 }
7306
7307 /// `hlsearch`, `incsearch`, `modeline` and `modelines` used to have no
7308 /// `Settings` storage, so `to_options` echoed the SPEC default and a
7309 /// caller could not move them. They are real fields now — this pins the
7310 /// direction of that change, so a regression that drops the storage again
7311 /// shows up as "echoed the default" rather than silently ignoring `:set`.
7312 #[test]
7313 fn search_and_modeline_options_round_trip_through_settings() {
7314 let mut ed = Editor::new(View::new(), DefaultHost::new(), Options::default());
7315 let want = all_non_default_options();
7316 ed.apply_options(&want);
7317 let got = ed.current_options();
7318 assert_eq!(got.hlsearch, want.hlsearch);
7319 assert_eq!(got.incsearch, want.incsearch);
7320 assert_eq!(got.modeline, want.modeline);
7321 assert_eq!(got.modelines, want.modelines);
7322 // …and they must differ from the SPEC default, or the assertions
7323 // above would pass on a `to_options` that still echoed it.
7324 let d = Options::default();
7325 assert_ne!(want.hlsearch, d.hlsearch);
7326 assert_ne!(want.incsearch, d.incsearch);
7327 assert_ne!(want.modeline, d.modeline);
7328 assert_ne!(want.modelines, d.modelines);
7329 }
7330
7331 /// `Settings::default()` and `Options::default()` must agree on every
7332 /// shared field. They used to disagree on `cursorline` (`Settings` said
7333 /// `false`, `Options` said `true`), so which default a session saw
7334 /// depended on whether it was built via `Editor::new(.., Options)` or via
7335 /// `Settings::default()` + `apply_options`.
7336 #[test]
7337 fn settings_default_matches_options_default() {
7338 let from_settings = Settings::default().to_options();
7339 let spec = Options::default();
7340 assert_eq!(
7341 from_settings, spec,
7342 "Settings::default() and Options::default() must not diverge"
7343 );
7344 }
7345
7346 /// The cursor-highlight pair is a deliberate hjkl divergence from vim:
7347 /// `cursorline` on, `cursorcolumn` off. What this test really guards is
7348 /// that the two sides agree — they disagreed once and the `Options` side
7349 /// silently won in a fresh session, so a fresh buffer showed a setting
7350 /// `:set cursorline?` denied.
7351 #[test]
7352 fn cursor_highlight_defaults_agree_on_both_sides() {
7353 assert!(Settings::default().cursorline);
7354 assert!(Options::default().cursorline);
7355 assert!(!Settings::default().cursorcolumn);
7356 assert!(!Options::default().cursorcolumn);
7357 }
7358
7359 /// `settings_from_options` (the `Editor::new` path) must agree with
7360 /// `apply_options` (the overlay path) for every field they share — the
7361 /// third hand-written conversion of the same shape.
7362 #[test]
7363 fn settings_from_options_agrees_with_apply_options() {
7364 let opts = all_non_default_options();
7365 let ctor = settings_from_options(&opts);
7366 let mut overlay = Settings::default();
7367 overlay.apply_options(&opts);
7368 assert_eq!(ctor.to_options(), overlay.to_options());
7369 }
7370
7371 /// The `WrapMode` ↔ `hjkl_buffer::Wrap` helpers are mutual inverses.
7372 #[test]
7373 fn wrap_helpers_round_trip() {
7374 for m in [WrapMode::None, WrapMode::Char, WrapMode::Word] {
7375 assert_eq!(wrap_to_mode(wrap_from_mode(m)), m);
7376 }
7377 for w in [
7378 hjkl_buffer::Wrap::None,
7379 hjkl_buffer::Wrap::Char,
7380 hjkl_buffer::Wrap::Word,
7381 ] {
7382 assert_eq!(wrap_from_mode(wrap_to_mode(w)), w);
7383 }
7384 }
7385
7386 /// Regression for the nvim-API seam (`nvim_api.rs` `set_lines`): a
7387 /// read-modify-apply cycle that touches ONE option must leave every other
7388 /// live option alone. Reproduced against the engine directly — the
7389 /// nvim-API path has no in-process harness.
7390 #[test]
7391 fn read_modify_apply_preserves_unrelated_options() {
7392 let mut ed = Editor::new(View::new(), DefaultHost::new(), Options::default());
7393 // A session that has diverged from the defaults (`:set` writes
7394 // `Settings` directly, so mirror that).
7395 ed.settings_mut().cursorline = true;
7396 ed.settings_mut().number = false;
7397 ed.settings_mut().filetype = "rust".to_string();
7398 ed.settings_mut().foldenable = false;
7399 ed.settings_mut().signcolumn = SignColumnMode::No;
7400 ed.settings_mut().diagnostics_inline = DiagInlineMode::Off;
7401
7402 // The seam: read, change one field, write back.
7403 let mut opts = ed.current_options();
7404 opts.tabstop = 2;
7405 ed.apply_options(&opts);
7406
7407 assert_eq!(ed.settings().tabstop, 2, "the edited field must land");
7408 assert!(ed.settings().cursorline, "cursorline must survive");
7409 assert!(!ed.settings().number, "number must survive");
7410 assert_eq!(ed.settings().filetype, "rust", "filetype must survive");
7411 assert!(!ed.settings().foldenable, "foldenable must survive");
7412 assert_eq!(ed.settings().signcolumn, SignColumnMode::No);
7413 // `Settings`-only field: not in `Options` at all, so untouched.
7414 assert_eq!(ed.settings().diagnostics_inline, DiagInlineMode::Off);
7415 }
7416}
7417
7418// ---- Wrapped-scrolloff tests (incremental screen-row walk) --------------
7419//
7420// `ensure_scrolloff_vertical` computes the cursor's screen row ONCE and
7421// adjusts it per dropped/added visible row instead of re-running
7422// `cursor_screen_row_from` (itself O(distance)) per candidate `top_row`.
7423// These tests pin the behavior the incremental walk must preserve — they
7424// pass on the old O(n²) loop and must keep passing on the rewrite.
7425
7426#[cfg(test)]
7427mod scrolloff_wrap_tests {
7428 use super::*;
7429 use crate::types::{DefaultHost, Host, Options};
7430 use hjkl_buffer::{Position, View, Wrap};
7431 use std::sync::Arc;
7432
7433 /// Editor over a wrapped buffer with the viewport + scrolloff set up so
7434 /// `ensure_cursor_in_scrolloff` dispatches to the screen-row walk
7435 /// (`wrap != Wrap::None`, `viewport_height > 0`).
7436 fn wrapped_editor(
7437 content: &str,
7438 height: u16,
7439 width: u16,
7440 scrolloff: usize,
7441 ) -> Editor<View, DefaultHost> {
7442 let mut ed = Editor::new(
7443 View::from_str(content),
7444 DefaultHost::default(),
7445 Options::default(),
7446 );
7447 ed.set_viewport_height(height);
7448 let vp = ed.host_mut().viewport_mut();
7449 vp.width = width;
7450 vp.height = height;
7451 vp.text_width = width;
7452 vp.wrap = Wrap::Char;
7453 ed.settings_mut().scrolloff = scrolloff;
7454 ed
7455 }
7456
7457 /// Cursor's screen row from the current `top_row`, through the same
7458 /// fold provider the scrolloff walk uses.
7459 fn csr(ed: &Editor<View, DefaultHost>) -> usize {
7460 let folds = crate::buffer_impl::BufferFoldProvider::new(ed.buffer());
7461 crate::viewport_math::cursor_screen_row_from(
7462 ed.buffer(),
7463 &folds,
7464 ed.host().viewport(),
7465 ed.host().viewport().top_row,
7466 )
7467 .unwrap_or(0)
7468 }
7469
7470 /// `n` doc rows × 30 chars — at text_width 10 each row wraps to exactly
7471 /// 3 screen rows.
7472 fn wrapped_rows(n: usize) -> String {
7473 let mut content = String::new();
7474 for _ in 0..n {
7475 content.push_str(&"x".repeat(30));
7476 content.push('\n');
7477 }
7478 content.pop();
7479 content
7480 }
7481
7482 /// Step 2 regression: a big wrapped jump (`G`) must push `top_row`
7483 /// forward one visible doc row at a time until the cursor's screen row
7484 /// enters the bottom margin. The old loop recomputed the screen row per
7485 /// candidate top; the incremental walk must land on the same `top_row`.
7486 /// 30 rows × 3 screen rows = 90; height 9 with scrolloff 2 keeps the
7487 /// cursor's screen row in [2, 6], i.e. `top_row` 17 for row 19. The
7488 /// cursor is NOT on the last row, so `max_top_for_height` (27) cannot
7489 /// mask a walk that overshoots: a broken subtraction lands above 17 and
7490 /// stays there.
7491 #[test]
7492 fn big_wrapped_jump_lands_in_bottom_margin() {
7493 let content = wrapped_rows(30);
7494 let mut ed = wrapped_editor(&content, 9, 10, 2);
7495 ed.jump_cursor(19, 0);
7496 ed.ensure_cursor_in_scrolloff();
7497 assert_eq!(ed.host().viewport().top_row, 17);
7498 assert!(
7499 (2..=6).contains(&csr(&ed)),
7500 "cursor screen row {} outside [2, 6]",
7501 csr(&ed)
7502 );
7503 }
7504
7505 /// Step 3 regression: with the cursor at the very top of the window
7506 /// (screen row 0 < margin), the backward walk must pull `top_row` up
7507 /// one visible row at a time — each row added to the top of the window
7508 /// adds its own wrap height back to the cursor's screen row. Cursor on
7509 /// row 8 of a 30-row buffer with top 8: one pull-back lands on 7
7510 /// (screen row 3), far below `max_top_for_height` (27) so the bottom
7511 /// clamp cannot mask a broken walk.
7512 #[test]
7513 fn cursor_at_top_of_window_pulls_top_back_to_margin() {
7514 let content = wrapped_rows(30);
7515 let mut ed = wrapped_editor(&content, 9, 10, 2);
7516 ed.jump_cursor(8, 0);
7517 ed.host_mut().viewport_mut().top_row = 8; // cursor at screen row 0
7518 ed.ensure_cursor_in_scrolloff();
7519 assert_eq!(ed.host().viewport().top_row, 7);
7520 assert!(
7521 (2..=6).contains(&csr(&ed)),
7522 "cursor screen row {} outside [2, 6]",
7523 csr(&ed)
7524 );
7525 }
7526
7527 /// Fold handling: a closed fold hides its body rows from the walk —
7528 /// `next_visible_row` jumps over them, and dropped rows only contribute
7529 /// their wrap height when visible. 12 rows × 30 chars, fold hiding
7530 /// rows 5..=6; cursor on row 10 (not the last row, so the bottom clamp
7531 /// at `max_top_for_height` = 9 does not mask the walk). Step 2 drops
7532 /// rows 0..3, then jumps 4 → 7 over the fold body (only row 4's 3
7533 /// screen rows subtracted), then 7 → 8: top 8, screen row 6.
7534 #[test]
7535 fn wrapped_scrolloff_skips_closed_fold_body() {
7536 let content = wrapped_rows(12);
7537 let mut ed = wrapped_editor(&content, 9, 10, 2);
7538 ed.buffer_mut().add_fold(4, 6, true);
7539 ed.jump_cursor(10, 0);
7540 ed.ensure_cursor_in_scrolloff();
7541 assert_eq!(ed.host().viewport().top_row, 8);
7542 }
7543
7544 /// A stale per-window cursor past EOF (another view shrank the shared
7545 /// content) makes `cursor_screen_row_from` return None. The walk must
7546 /// treat that as screen row 0 — step 2 no-ops, step 3 pulls `top_row`
7547 /// back until the cursor's screen row reaches the top margin — and must
7548 /// not panic.
7549 #[test]
7550 fn stale_cursor_past_eof_does_not_advance_or_panic() {
7551 let seed = View::from_str("a\nb\nc\nd\ne\nf\ng");
7552 let arc = seed.content_arc();
7553 let mut view_b = View::new_view(Arc::clone(&arc));
7554 view_b.set_cursor(Position::new(6, 0));
7555 // A sibling view shrinks the shared document; view_b's cursor row 6
7556 // is now past EOF.
7557 let mut view_a = View::new_view(Arc::clone(&arc));
7558 view_a.replace_all("a\nb\nc");
7559 let mut ed = Editor::new(view_b, DefaultHost::default(), Options::default());
7560 ed.set_viewport_height(5);
7561 let vp = ed.host_mut().viewport_mut();
7562 vp.width = 10;
7563 vp.height = 5;
7564 vp.text_width = 10;
7565 vp.wrap = Wrap::Char;
7566 vp.top_row = 50;
7567 ed.settings_mut().scrolloff = 2;
7568 ed.ensure_cursor_in_scrolloff(); // must not panic
7569 assert_eq!(ed.host().viewport().top_row, 0);
7570 assert_eq!(csr(&ed), 2);
7571 }
7572}