1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
//! Editor — the public sqeel-vim type, layered over `hjkl_buffer::Buffer`.
//!
//! This file owns the public Editor API — construction, content access,
//! mouse and goto helpers, the (buffer-level) undo stack, and insert-mode
//! session bookkeeping. All vim-specific keyboard handling lives in
//! [`vim`] and communicates with Editor through a small internal API
//! exposed via `pub(super)` fields and helper methods.
use crate::input::{Input, Key};
use crate::vim::{self, VimState};
use crate::{KeybindingMode, VimMode};
use crossterm::event::{KeyCode, KeyEvent, KeyModifiers};
use ratatui::layout::Rect;
use std::sync::atomic::{AtomicU16, Ordering};
/// Convert a SPEC [`crate::types::Style`] to a [`ratatui::style::Style`].
///
/// Lossless within the styles each library represents. Lives in the
/// engine because hjkl-engine pulls ratatui as a mandatory dep today;
/// once trait extraction lands, this becomes a trivial pass-through
/// once the field types flip.
pub(crate) fn engine_style_to_ratatui(s: crate::types::Style) -> ratatui::style::Style {
use crate::types::Attrs;
use ratatui::style::{Color as RColor, Modifier as RMod, Style as RStyle};
let mut out = RStyle::default();
if let Some(c) = s.fg {
out = out.fg(RColor::Rgb(c.0, c.1, c.2));
}
if let Some(c) = s.bg {
out = out.bg(RColor::Rgb(c.0, c.1, c.2));
}
let mut m = RMod::empty();
if s.attrs.contains(Attrs::BOLD) {
m |= RMod::BOLD;
}
if s.attrs.contains(Attrs::ITALIC) {
m |= RMod::ITALIC;
}
if s.attrs.contains(Attrs::UNDERLINE) {
m |= RMod::UNDERLINED;
}
if s.attrs.contains(Attrs::REVERSE) {
m |= RMod::REVERSED;
}
if s.attrs.contains(Attrs::DIM) {
m |= RMod::DIM;
}
if s.attrs.contains(Attrs::STRIKE) {
m |= RMod::CROSSED_OUT;
}
out.add_modifier(m)
}
/// Inverse of [`engine_style_to_ratatui`]. Lossy for ratatui colors
/// the engine doesn't model (Indexed, named ANSI) — flattens to
/// nearest RGB.
pub(crate) fn ratatui_style_to_engine(s: ratatui::style::Style) -> crate::types::Style {
use crate::types::{Attrs, Color, Style};
use ratatui::style::{Color as RColor, Modifier as RMod};
fn c(rc: RColor) -> Color {
match rc {
RColor::Rgb(r, g, b) => Color(r, g, b),
RColor::Black => Color(0, 0, 0),
RColor::Red => Color(205, 49, 49),
RColor::Green => Color(13, 188, 121),
RColor::Yellow => Color(229, 229, 16),
RColor::Blue => Color(36, 114, 200),
RColor::Magenta => Color(188, 63, 188),
RColor::Cyan => Color(17, 168, 205),
RColor::Gray => Color(229, 229, 229),
RColor::DarkGray => Color(102, 102, 102),
RColor::LightRed => Color(241, 76, 76),
RColor::LightGreen => Color(35, 209, 139),
RColor::LightYellow => Color(245, 245, 67),
RColor::LightBlue => Color(59, 142, 234),
RColor::LightMagenta => Color(214, 112, 214),
RColor::LightCyan => Color(41, 184, 219),
RColor::White => Color(255, 255, 255),
_ => Color(0, 0, 0),
}
}
let mut attrs = Attrs::empty();
if s.add_modifier.contains(RMod::BOLD) {
attrs |= Attrs::BOLD;
}
if s.add_modifier.contains(RMod::ITALIC) {
attrs |= Attrs::ITALIC;
}
if s.add_modifier.contains(RMod::UNDERLINED) {
attrs |= Attrs::UNDERLINE;
}
if s.add_modifier.contains(RMod::REVERSED) {
attrs |= Attrs::REVERSE;
}
if s.add_modifier.contains(RMod::DIM) {
attrs |= Attrs::DIM;
}
if s.add_modifier.contains(RMod::CROSSED_OUT) {
attrs |= Attrs::STRIKE;
}
Style {
fg: s.fg.map(c),
bg: s.bg.map(c),
attrs,
}
}
/// Map a [`hjkl_buffer::Edit`] to the SPEC [`crate::types::Edit`]
/// (`EditOp`). Returns `None` when the buffer edit isn't representable
/// as a single SPEC EditOp; today every variant maps so this is
/// always `Some`, but the option keeps room for future no-log
/// signals.
fn edit_to_editop(edit: &hjkl_buffer::Edit) -> Option<crate::types::Edit> {
use crate::types::{Edit as Op, Pos};
use hjkl_buffer::Edit as B;
let to_pos = |p: hjkl_buffer::Position| Pos {
line: p.row as u32,
col: p.col as u32,
};
Some(match edit {
B::InsertChar { at, ch } => Op {
range: to_pos(*at)..to_pos(*at),
replacement: ch.to_string(),
},
B::InsertStr { at, text } => Op {
range: to_pos(*at)..to_pos(*at),
replacement: text.clone(),
},
B::DeleteRange { start, end, .. } => Op {
range: to_pos(*start)..to_pos(*end),
replacement: String::new(),
},
B::Replace { start, end, with } => Op {
range: to_pos(*start)..to_pos(*end),
replacement: with.clone(),
},
B::JoinLines { row, count, .. } => {
let start = Pos {
line: *row as u32,
col: 0,
};
let end = Pos {
line: (*row + *count) as u32,
col: 0,
};
Op {
range: start..end,
replacement: String::new(),
}
}
B::SplitLines { row, .. } => {
let p = Pos {
line: *row as u32,
col: 0,
};
Op {
range: p..p,
replacement: String::new(),
}
}
B::InsertBlock { at, .. } => {
let p = to_pos(*at);
Op {
range: p..p,
replacement: String::new(),
}
}
B::DeleteBlockChunks { at, .. } => {
let p = to_pos(*at);
Op {
range: p..p,
replacement: String::new(),
}
}
})
}
/// Where the cursor should land in the viewport after a `z`-family
/// scroll (`zz` / `zt` / `zb`).
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(super) enum CursorScrollTarget {
Center,
Top,
Bottom,
}
pub struct Editor<'a> {
pub keybinding_mode: KeybindingMode,
/// Reserved for the lifetime parameter — Editor used to wrap a
/// `TextArea<'a>` whose lifetime came from this slot. Phase 7f
/// ripped the field but the lifetime stays so downstream
/// `Editor<'a>` consumers don't have to churn.
_marker: std::marker::PhantomData<&'a ()>,
/// Set when the user yanks/cuts; caller drains this to write to OS clipboard.
pub last_yank: Option<String>,
/// All vim-specific state (mode, pending operator, count, dot-repeat, ...).
#[doc(hidden)]
pub vim: VimState,
/// Undo history: each entry is (lines, cursor) before the edit.
#[doc(hidden)]
pub undo_stack: Vec<(Vec<String>, (usize, usize))>,
/// Redo history: entries pushed when undoing.
pub(super) redo_stack: Vec<(Vec<String>, (usize, usize))>,
/// Set whenever the buffer content changes; cleared by `take_dirty`.
pub(super) content_dirty: bool,
/// Cached snapshot of `lines().join("\n") + "\n"` wrapped in an Arc
/// so repeated `content_arc()` calls within the same un-mutated
/// window are free (ref-count bump instead of a full-buffer join).
/// Invalidated by every [`mark_content_dirty`] call.
pub(super) cached_content: Option<std::sync::Arc<String>>,
/// Last rendered viewport height (text rows only, no chrome). Written
/// by the draw path via [`set_viewport_height`] so the scroll helpers
/// can clamp the cursor to stay visible without plumbing the height
/// through every call.
pub(super) viewport_height: AtomicU16,
/// Pending LSP intent set by a normal-mode chord (e.g. `gd` for
/// goto-definition). The host app drains this each step and fires
/// the matching request against its own LSP client.
pub(super) pending_lsp: Option<LspIntent>,
/// Mirror buffer for the in-flight migration off tui-textarea.
/// Phase 7a: content syncs on every `set_content` so the rest of
/// the engine can start reading from / writing to it in
/// follow-up commits without behaviour changing today.
pub(super) buffer: hjkl_buffer::Buffer,
/// Style intern table for the migration buffer's opaque
/// `Span::style` ids. Phase 7d-ii-a wiring — `apply_window_spans`
/// produces `(start, end, Style)` tuples for the textarea; we
/// translate those to `hjkl_buffer::Span` by interning the
/// `Style` here and storing the table index. The render path's
/// `StyleResolver` looks the style back up by id.
pub(super) style_table: Vec<ratatui::style::Style>,
/// Vim-style register bank — `"`, `"0`–`"9`, `"a`–`"z`. Sources
/// every `p` / `P` via the active selector (default unnamed).
#[doc(hidden)]
pub registers: crate::registers::Registers,
/// Per-row syntax styling, kept here so the host can do
/// incremental window updates (see `apply_window_spans` in
/// the host). Same `(start_byte, end_byte, Style)` tuple shape
/// the textarea used to host. The Buffer-side opaque-id spans are
/// derived from this on every install.
pub styled_spans: Vec<Vec<(usize, usize, ratatui::style::Style)>>,
/// Per-editor settings tweakable via `:set`. Exposed by reference
/// so handlers (indent, search) read the live value rather than a
/// snapshot taken at startup.
#[doc(hidden)]
pub settings: Settings,
/// Vim's uppercase / "file" marks. Survive `set_content` calls so
/// they persist across tab swaps within the same Editor — the
/// closest sqeel can get to vim's per-file marks without
/// host-side persistence. Lowercase marks stay buffer-local on
/// `vim.marks`.
#[doc(hidden)]
pub file_marks: std::collections::HashMap<char, (usize, usize)>,
/// Block ranges (`(start_row, end_row)` inclusive) the host has
/// extracted from a syntax tree. `:foldsyntax` reads these to
/// populate folds. The host (the host) refreshes them on every
/// re-parse via [`Editor::set_syntax_fold_ranges`].
#[doc(hidden)]
pub syntax_fold_ranges: Vec<(usize, usize)>,
/// Pending edit log drained by [`Editor::take_changes`]. Each entry
/// is a SPEC [`crate::types::Edit`] mapped from the underlying
/// `hjkl_buffer::Edit` operation. Compound ops (JoinLines,
/// SplitLines, InsertBlock, DeleteBlockChunks) emit a single
/// best-effort EditOp covering the touched range; hosts wanting
/// per-cell deltas should diff their own snapshot of `lines()`.
/// Sealed at 0.1.0 trait extraction.
#[doc(hidden)]
pub change_log: Vec<crate::types::Edit>,
}
/// Vim-style options surfaced by `:set`. New fields land here as
/// individual ex commands gain `:set` plumbing.
#[derive(Debug, Clone)]
pub struct Settings {
/// Spaces per shift step for `>>` / `<<` / `Ctrl-T` / `Ctrl-D`.
pub shiftwidth: usize,
/// Visual width of a `\t` character. Stored for future render
/// hookup; not yet consumed by the buffer renderer.
pub tabstop: usize,
/// When true, `/` / `?` patterns and `:s/.../.../` ignore case
/// without an explicit `i` flag.
pub ignore_case: bool,
/// Wrap column for `gq{motion}` text reflow. Vim's default is 79.
pub textwidth: usize,
/// Soft-wrap mode the renderer + scroll math + `gj` / `gk` use.
/// Default is [`hjkl_buffer::Wrap::None`] — long lines extend
/// past the right edge and `top_col` clips the left side.
/// `:set wrap` flips to char-break wrap; `:set linebreak` flips
/// to word-break wrap; `:set nowrap` resets.
pub wrap: hjkl_buffer::Wrap,
}
impl Default for Settings {
fn default() -> Self {
Self {
shiftwidth: 2,
tabstop: 8,
ignore_case: false,
textwidth: 79,
wrap: hjkl_buffer::Wrap::None,
}
}
}
/// Host-observable LSP requests triggered by editor bindings. The
/// hjkl-engine crate doesn't talk to an LSP itself — it just raises an
/// intent that the TUI layer picks up and routes to `sqls`.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum LspIntent {
/// `gd` — textDocument/definition at the cursor.
GotoDefinition,
}
impl<'a> Editor<'a> {
pub fn new(keybinding_mode: KeybindingMode) -> Self {
Self {
_marker: std::marker::PhantomData,
keybinding_mode,
last_yank: None,
vim: VimState::default(),
undo_stack: Vec::new(),
redo_stack: Vec::new(),
content_dirty: false,
cached_content: None,
viewport_height: AtomicU16::new(0),
pending_lsp: None,
buffer: hjkl_buffer::Buffer::new(),
style_table: Vec::new(),
registers: crate::registers::Registers::default(),
styled_spans: Vec::new(),
settings: Settings::default(),
file_marks: std::collections::HashMap::new(),
syntax_fold_ranges: Vec::new(),
change_log: Vec::new(),
}
}
/// Host hook: replace the cached syntax-derived block ranges that
/// `:foldsyntax` consumes. the host calls this on every re-parse;
/// the cost is just a `Vec` swap.
pub fn set_syntax_fold_ranges(&mut self, ranges: Vec<(usize, usize)>) {
self.syntax_fold_ranges = ranges;
}
/// Live settings (read-only). `:set` mutates these via
/// [`Editor::settings_mut`].
pub fn settings(&self) -> &Settings {
&self.settings
}
#[doc(hidden)]
pub fn settings_mut(&mut self) -> &mut Settings {
&mut self.settings
}
/// Install styled syntax spans into both the host-visible cache
/// (`styled_spans`) and the buffer's opaque-id span table. Drops
/// zero-width runs and clamps `end` to the line's char length so
/// the buffer cache doesn't see runaway ranges. Replaces the
/// previous `set_syntax_spans` + `sync_buffer_spans_from_textarea`
/// round-trip.
pub fn install_syntax_spans(&mut self, spans: Vec<Vec<(usize, usize, ratatui::style::Style)>>) {
let line_byte_lens: Vec<usize> = self.buffer.lines().iter().map(|l| l.len()).collect();
let mut by_row: Vec<Vec<hjkl_buffer::Span>> = Vec::with_capacity(spans.len());
for (row, row_spans) in spans.iter().enumerate() {
let line_len = line_byte_lens.get(row).copied().unwrap_or(0);
let mut translated = Vec::with_capacity(row_spans.len());
for (start, end, style) in row_spans {
let end_clamped = (*end).min(line_len);
if end_clamped <= *start {
continue;
}
let id = self.intern_style(*style);
translated.push(hjkl_buffer::Span::new(*start, end_clamped, id));
}
by_row.push(translated);
}
self.buffer.set_spans(by_row);
self.styled_spans = spans;
}
/// Snapshot of the unnamed register (the default `p` / `P` source).
pub fn yank(&self) -> &str {
&self.registers.unnamed.text
}
/// Borrow the full register bank — `"`, `"0`–`"9`, `"a`–`"z`.
pub fn registers(&self) -> &crate::registers::Registers {
&self.registers
}
/// Host hook: load the OS clipboard's contents into the `"+` / `"*`
/// register slot. the host calls this before letting vim consume a
/// paste so `"*p` / `"+p` reflect the live clipboard rather than a
/// stale snapshot from the last yank.
pub fn sync_clipboard_register(&mut self, text: String, linewise: bool) {
self.registers.set_clipboard(text, linewise);
}
/// True when the user's pending register selector is `+` or `*`.
/// the host peeks this so it can refresh `sync_clipboard_register`
/// only when a clipboard read is actually about to happen.
pub fn pending_register_is_clipboard(&self) -> bool {
matches!(self.vim.pending_register, Some('+') | Some('*'))
}
/// Replace the unnamed register without touching any other slot.
/// For host-driven imports (e.g. system clipboard); operator
/// code uses [`record_yank`] / [`record_delete`].
pub fn set_yank(&mut self, text: impl Into<String>) {
let text = text.into();
let linewise = self.vim.yank_linewise;
self.registers.unnamed = crate::registers::Slot { text, linewise };
}
/// Record a yank into `"` and `"0`, plus the named target if the
/// user prefixed `"reg`. Updates `vim.yank_linewise` for the
/// paste path.
pub(crate) fn record_yank(&mut self, text: String, linewise: bool) {
self.vim.yank_linewise = linewise;
let target = self.vim.pending_register.take();
self.registers.record_yank(text, linewise, target);
}
/// Direct write to a named register slot — bypasses the unnamed
/// `"` and `"0` updates that `record_yank` does. Used by the
/// macro recorder so finishing a `q{reg}` recording doesn't
/// pollute the user's last yank.
pub(crate) fn set_named_register_text(&mut self, reg: char, text: String) {
if let Some(slot) = match reg {
'a'..='z' => Some(&mut self.registers.named[(reg as u8 - b'a') as usize]),
'A'..='Z' => {
Some(&mut self.registers.named[(reg.to_ascii_lowercase() as u8 - b'a') as usize])
}
_ => None,
} {
slot.text = text;
slot.linewise = false;
}
}
/// Record a delete / change into `"` and the `"1`–`"9` ring.
/// Honours the active named-register prefix.
pub(crate) fn record_delete(&mut self, text: String, linewise: bool) {
self.vim.yank_linewise = linewise;
let target = self.vim.pending_register.take();
self.registers.record_delete(text, linewise, target);
}
/// Intern a `ratatui::style::Style` and return the opaque id used
/// in `hjkl_buffer::Span::style`. The render-side `StyleResolver`
/// closure (built by [`Editor::style_resolver`]) uses the id to
/// look up the style back. Linear-scan dedup — the table grows
/// only as new tree-sitter token kinds appear, so it stays tiny.
pub fn intern_style(&mut self, style: ratatui::style::Style) -> u32 {
if let Some(idx) = self.style_table.iter().position(|s| *s == style) {
return idx as u32;
}
self.style_table.push(style);
(self.style_table.len() - 1) as u32
}
/// Read-only view of the style table — id `i` → `style_table[i]`.
/// The render path passes a closure backed by this slice as the
/// `StyleResolver` for `BufferView`.
pub fn style_table(&self) -> &[ratatui::style::Style] {
&self.style_table
}
/// Intern a SPEC [`crate::types::Style`] and return its opaque id.
/// The id matches the one [`intern_style`] would return for the
/// equivalent `ratatui::Style` — both methods share the underlying
/// table.
///
/// Hosts that don't depend on ratatui (buffr, future GUI shells)
/// reach this method to populate the table during syntax span
/// installation. Internally converts to ratatui::Style today; the
/// trait extraction will flip the storage to engine-native.
pub fn intern_engine_style(&mut self, style: crate::types::Style) -> u32 {
let r = engine_style_to_ratatui(style);
self.intern_style(r)
}
/// Look up an interned style by id and return it as a SPEC
/// [`crate::types::Style`]. Returns `None` for ids past the end
/// of the table.
pub fn engine_style_at(&self, id: u32) -> Option<crate::types::Style> {
let r = self.style_table.get(id as usize).copied()?;
Some(ratatui_style_to_engine(r))
}
/// Borrow the migration buffer. Host renders through this via
/// `hjkl_buffer::BufferView`.
pub fn buffer(&self) -> &hjkl_buffer::Buffer {
&self.buffer
}
pub fn buffer_mut(&mut self) -> &mut hjkl_buffer::Buffer {
&mut self.buffer
}
/// Historical reverse-sync hook from when the textarea mirrored
/// the buffer. Now that Buffer is the cursor authority this is a
/// no-op; call sites can remain in place during the migration.
pub(crate) fn push_buffer_cursor_to_textarea(&mut self) {}
/// Force the buffer viewport's top row without touching the
/// cursor. Used by tests that simulate a scroll without the
/// SCROLLOFF cursor adjustment that `scroll_down` / `scroll_up`
/// apply. Note: does not touch the textarea — the migration
/// buffer's viewport is what `BufferView` renders from, and the
/// textarea's own scroll path would clamp the cursor into its
/// (often-zero) visible window.
pub fn set_viewport_top(&mut self, row: usize) {
let last = self.buffer.row_count().saturating_sub(1);
let target = row.min(last);
self.buffer.viewport_mut().top_row = target;
}
/// Set the cursor to `(row, col)`, clamped to the buffer's
/// content. Replaces the scattered
/// `ed.textarea.move_cursor(CursorMove::Jump(r, c))` pattern that
/// existed before Phase 7f.
#[doc(hidden)]
pub fn jump_cursor(&mut self, row: usize, col: usize) {
self.buffer.set_cursor(hjkl_buffer::Position::new(row, col));
}
/// `(row, col)` cursor read sourced from the migration buffer.
/// Equivalent to `self.textarea.cursor()` when the two are in
/// sync — which is the steady state during Phase 7f because
/// every step opens with `sync_buffer_content_from_textarea` and
/// every ported motion pushes the result back. Prefer this over
/// `self.textarea.cursor()` so call sites keep working unchanged
/// once the textarea field is ripped.
pub fn cursor(&self) -> (usize, usize) {
let pos = self.buffer.cursor();
(pos.row, pos.col)
}
/// Drain any pending LSP intent raised by the last key. Returns
/// `None` when no intent is armed.
pub fn take_lsp_intent(&mut self) -> Option<LspIntent> {
self.pending_lsp.take()
}
/// Refresh the buffer's host-side state — sticky col + viewport
/// height. Called from the per-step boilerplate; was the textarea
/// → buffer mirror before Phase 7f put Buffer in charge.
pub(crate) fn sync_buffer_from_textarea(&mut self) {
self.buffer.set_sticky_col(self.vim.sticky_col);
let height = self.viewport_height_value();
self.buffer.viewport_mut().height = height;
}
/// Was the full textarea → buffer content sync. Buffer is the
/// content authority now; this remains as a no-op so the per-step
/// call sites don't have to be ripped in the same patch.
pub(crate) fn sync_buffer_content_from_textarea(&mut self) {
self.sync_buffer_from_textarea();
}
/// Push a `(row, col)` onto the back-jumplist so `Ctrl-o` returns
/// to it later. Used by host-driven jumps (e.g. `gd`) that move
/// the cursor without going through the vim engine's motion
/// machinery, where push_jump fires automatically.
pub fn record_jump(&mut self, pos: (usize, usize)) {
const JUMPLIST_MAX: usize = 100;
self.vim.jump_back.push(pos);
if self.vim.jump_back.len() > JUMPLIST_MAX {
self.vim.jump_back.remove(0);
}
self.vim.jump_fwd.clear();
}
/// Host apps call this each draw with the current text area height so
/// scroll helpers can clamp the cursor without recomputing layout.
pub fn set_viewport_height(&self, height: u16) {
self.viewport_height.store(height, Ordering::Relaxed);
}
/// Last height published by `set_viewport_height` (in rows).
pub fn viewport_height_value(&self) -> u16 {
self.viewport_height.load(Ordering::Relaxed)
}
/// Phase 7f edit funnel: apply `edit` to the migration buffer
/// (the eventual edit authority), mirror the result back into
/// the textarea so the still-textarea-driven paths (insert mode,
/// yank pipe) keep observing the same content. Returns the
/// inverse for the host's undo stack.
#[doc(hidden)]
pub fn mutate_edit(&mut self, edit: hjkl_buffer::Edit) -> hjkl_buffer::Edit {
let pre_row = self.buffer.cursor().row;
let pre_rows = self.buffer.row_count();
// Map the underlying buffer edit to a SPEC EditOp for
// change-log emission before consuming it. Coarse — see
// change_log field doc on the struct.
if let Some(op) = edit_to_editop(&edit) {
self.change_log.push(op);
}
let inverse = self.buffer.apply_edit(edit);
let pos = self.buffer.cursor();
// Drop any folds the edit's range overlapped — vim opens the
// surrounding fold automatically when you edit inside it. The
// approximation here invalidates folds covering either the
// pre-edit cursor row or the post-edit cursor row, which
// catches the common single-line / multi-line edit shapes.
let lo = pre_row.min(pos.row);
let hi = pre_row.max(pos.row);
self.buffer.invalidate_folds_in_range(lo, hi);
self.vim.last_edit_pos = Some((pos.row, pos.col));
// Append to the change-list ring (skip when the cursor sits on
// the same cell as the last entry — back-to-back keystrokes on
// one column shouldn't pollute the ring). A new edit while
// walking the ring trims the forward half, vim style.
let entry = (pos.row, pos.col);
if self.vim.change_list.last() != Some(&entry) {
if let Some(idx) = self.vim.change_list_cursor.take() {
self.vim.change_list.truncate(idx + 1);
}
self.vim.change_list.push(entry);
let len = self.vim.change_list.len();
if len > crate::vim::CHANGE_LIST_MAX {
self.vim
.change_list
.drain(0..len - crate::vim::CHANGE_LIST_MAX);
}
}
self.vim.change_list_cursor = None;
// Shift / drop marks + jump-list entries to track the row
// delta the edit produced. Without this, every line-changing
// edit silently invalidates `'a`-style positions.
let post_rows = self.buffer.row_count();
let delta = post_rows as isize - pre_rows as isize;
if delta != 0 {
self.shift_marks_after_edit(pre_row, delta);
}
self.push_buffer_content_to_textarea();
self.mark_content_dirty();
inverse
}
/// Migrate user marks + jumplist entries when an edit at row
/// `edit_start` changes the buffer's row count by `delta` (positive
/// for inserts, negative for deletes). Marks tied to a deleted row
/// are dropped; marks past the affected band shift by `delta`.
fn shift_marks_after_edit(&mut self, edit_start: usize, delta: isize) {
if delta == 0 {
return;
}
// Deleted-row band (only meaningful for delta < 0). Inclusive
// start, exclusive end.
let drop_end = if delta < 0 {
edit_start.saturating_add((-delta) as usize)
} else {
edit_start
};
let shift_threshold = drop_end.max(edit_start.saturating_add(1));
let mut to_drop: Vec<char> = Vec::new();
for (c, (row, _col)) in self.vim.marks.iter_mut() {
if (edit_start..drop_end).contains(row) {
to_drop.push(*c);
} else if *row >= shift_threshold {
*row = ((*row as isize) + delta).max(0) as usize;
}
}
for c in to_drop {
self.vim.marks.remove(&c);
}
// File marks migrate the same way — only the storage differs.
let mut to_drop: Vec<char> = Vec::new();
for (c, (row, _col)) in self.file_marks.iter_mut() {
if (edit_start..drop_end).contains(row) {
to_drop.push(*c);
} else if *row >= shift_threshold {
*row = ((*row as isize) + delta).max(0) as usize;
}
}
for c in to_drop {
self.file_marks.remove(&c);
}
let shift_jumps = |entries: &mut Vec<(usize, usize)>| {
entries.retain(|(row, _)| !(edit_start..drop_end).contains(row));
for (row, _) in entries.iter_mut() {
if *row >= shift_threshold {
*row = ((*row as isize) + delta).max(0) as usize;
}
}
};
shift_jumps(&mut self.vim.jump_back);
shift_jumps(&mut self.vim.jump_fwd);
}
/// Reverse-sync helper paired with [`Editor::mutate_edit`]: rebuild
/// the textarea from the buffer's lines + cursor, preserving yank
/// text. Heavy (allocates a fresh `TextArea`) but correct; the
/// textarea field disappears at the end of Phase 7f anyway.
/// No-op since Buffer is the content authority. Retained as a
/// shim so call sites in `mutate_edit` and friends don't have to
/// be ripped in lockstep with the field removal.
pub(crate) fn push_buffer_content_to_textarea(&mut self) {}
/// Single choke-point for "the buffer just changed". Sets the
/// dirty flag and drops the cached `content_arc` snapshot so
/// subsequent reads rebuild from the live textarea. Callers
/// mutating `textarea` directly (e.g. the TUI's bracketed-paste
/// path) must invoke this to keep the cache honest.
pub fn mark_content_dirty(&mut self) {
self.content_dirty = true;
self.cached_content = None;
}
/// Returns true if content changed since the last call, then clears the flag.
pub fn take_dirty(&mut self) -> bool {
let dirty = self.content_dirty;
self.content_dirty = false;
dirty
}
/// Pull-model coarse change observation. If content changed since
/// the last call, returns `Some(Arc<String>)` with the new content
/// and clears the dirty flag; otherwise returns `None`.
///
/// Hosts that need fine-grained edit deltas (e.g., DOM patching at
/// the character level) should diff against their own previous
/// snapshot. The SPEC `take_changes() -> Vec<EditOp>` API lands
/// once every edit path inside the engine is instrumented; this
/// coarse form covers the pull-model use case in the meantime.
pub fn take_content_change(&mut self) -> Option<std::sync::Arc<String>> {
if !self.content_dirty {
return None;
}
let arc = self.content_arc();
self.content_dirty = false;
Some(arc)
}
/// Returns the cursor's row within the visible textarea (0-based), updating
/// the stored viewport top so subsequent calls remain accurate.
pub fn cursor_screen_row(&mut self, height: u16) -> u16 {
let cursor = self.buffer.cursor().row;
let top = self.buffer.viewport().top_row;
cursor.saturating_sub(top).min(height as usize - 1) as u16
}
/// Returns the cursor's screen position `(x, y)` for `area` (the textarea
/// rect). Accounts for line-number gutter and viewport scroll. Returns
/// `None` if the cursor is outside the visible viewport.
pub fn cursor_screen_pos(&self, area: Rect) -> Option<(u16, u16)> {
let pos = self.buffer.cursor();
let v = self.buffer.viewport();
if pos.row < v.top_row || pos.col < v.top_col {
return None;
}
let lnum_width = self.buffer.row_count().to_string().len() as u16 + 2;
let dy = (pos.row - v.top_row) as u16;
let dx = (pos.col - v.top_col) as u16;
if dy >= area.height || dx + lnum_width >= area.width {
return None;
}
Some((area.x + lnum_width + dx, area.y + dy))
}
pub fn vim_mode(&self) -> VimMode {
self.vim.public_mode()
}
/// Bounds of the active visual-block rectangle as
/// `(top_row, bot_row, left_col, right_col)` — all inclusive.
/// `None` when we're not in VisualBlock mode.
/// Read-only view of the live `/` or `?` prompt. `None` outside
/// search-prompt mode.
pub fn search_prompt(&self) -> Option<&crate::vim::SearchPrompt> {
self.vim.search_prompt.as_ref()
}
/// Most recent committed search pattern (persists across `n` / `N`
/// and across prompt exits). `None` before the first search.
pub fn last_search(&self) -> Option<&str> {
self.vim.last_search.as_deref()
}
/// Start/end `(row, col)` of the active char-wise Visual selection
/// (inclusive on both ends, positionally ordered). `None` when not
/// in Visual mode.
pub fn char_highlight(&self) -> Option<((usize, usize), (usize, usize))> {
if self.vim_mode() != VimMode::Visual {
return None;
}
let anchor = self.vim.visual_anchor;
let cursor = self.cursor();
let (start, end) = if anchor <= cursor {
(anchor, cursor)
} else {
(cursor, anchor)
};
Some((start, end))
}
/// Top/bottom rows of the active VisualLine selection (inclusive).
/// `None` when we're not in VisualLine mode.
pub fn line_highlight(&self) -> Option<(usize, usize)> {
if self.vim_mode() != VimMode::VisualLine {
return None;
}
let anchor = self.vim.visual_line_anchor;
let cursor = self.buffer.cursor().row;
Some((anchor.min(cursor), anchor.max(cursor)))
}
pub fn block_highlight(&self) -> Option<(usize, usize, usize, usize)> {
if self.vim_mode() != VimMode::VisualBlock {
return None;
}
let (ar, ac) = self.vim.block_anchor;
let cr = self.buffer.cursor().row;
let cc = self.vim.block_vcol;
let top = ar.min(cr);
let bot = ar.max(cr);
let left = ac.min(cc);
let right = ac.max(cc);
Some((top, bot, left, right))
}
/// Active selection in `hjkl_buffer::Selection` shape. `None` when
/// not in a Visual mode. Phase 7d-i wiring — the host hands this
/// straight to `BufferView` once render flips off textarea
/// (Phase 7d-ii drops the `paint_*_overlay` calls on the same
/// switch).
pub fn buffer_selection(&self) -> Option<hjkl_buffer::Selection> {
use hjkl_buffer::{Position, Selection};
match self.vim_mode() {
VimMode::Visual => {
let (ar, ac) = self.vim.visual_anchor;
let head = self.buffer.cursor();
Some(Selection::Char {
anchor: Position::new(ar, ac),
head,
})
}
VimMode::VisualLine => {
let anchor_row = self.vim.visual_line_anchor;
let head_row = self.buffer.cursor().row;
Some(Selection::Line {
anchor_row,
head_row,
})
}
VimMode::VisualBlock => {
let (ar, ac) = self.vim.block_anchor;
let cr = self.buffer.cursor().row;
let cc = self.vim.block_vcol;
Some(Selection::Block {
anchor: Position::new(ar, ac),
head: Position::new(cr, cc),
})
}
_ => None,
}
}
/// Force back to normal mode (used when dismissing completions etc.)
pub fn force_normal(&mut self) {
self.vim.force_normal();
}
pub fn content(&self) -> String {
let mut s = self.buffer.lines().join("\n");
s.push('\n');
s
}
/// Same logical output as [`content`], but returns a cached
/// `Arc<String>` so back-to-back reads within an un-mutated window
/// are ref-count bumps instead of multi-MB joins. The cache is
/// invalidated by every [`mark_content_dirty`] call.
pub fn content_arc(&mut self) -> std::sync::Arc<String> {
if let Some(arc) = &self.cached_content {
return std::sync::Arc::clone(arc);
}
let arc = std::sync::Arc::new(self.content());
self.cached_content = Some(std::sync::Arc::clone(&arc));
arc
}
pub fn set_content(&mut self, text: &str) {
let mut lines: Vec<String> = text.lines().map(|l| l.to_string()).collect();
while lines.last().map(|l| l.is_empty()).unwrap_or(false) {
lines.pop();
}
if lines.is_empty() {
lines.push(String::new());
}
let _ = lines;
self.buffer = hjkl_buffer::Buffer::from_str(text);
self.undo_stack.clear();
self.redo_stack.clear();
self.mark_content_dirty();
}
/// Drain the pending change log produced by buffer mutations.
///
/// Returns a `Vec<EditOp>` covering edits applied since the last
/// call. Empty when no edits ran. Pull-model, complementary to
/// [`Editor::take_content_change`] which gives back the new full
/// content.
///
/// Mapping coverage:
/// - InsertChar / InsertStr → exact `EditOp` with empty range +
/// replacement.
/// - DeleteRange (`Char` kind) → exact range + empty replacement.
/// - Replace → exact range + new replacement.
/// - DeleteRange (`Line`/`Block`), JoinLines, SplitLines,
/// InsertBlock, DeleteBlockChunks → best-effort placeholder
/// covering the touched range. Hosts wanting per-cell deltas
/// should diff their own `lines()` snapshot.
pub fn take_changes(&mut self) -> Vec<crate::types::Edit> {
std::mem::take(&mut self.change_log)
}
/// Read the engine's current settings as a SPEC
/// [`crate::types::Options`].
///
/// Bridges between the legacy [`Settings`] (which carries fewer
/// fields than SPEC) and the planned 0.1.0 trait surface. Fields
/// not present in `Settings` fall back to vim defaults (e.g.,
/// `expandtab=false`, `wrapscan=true`, `timeout_len=1000ms`).
/// Once trait extraction lands, this becomes the canonical config
/// reader and `Settings` retires.
pub fn current_options(&self) -> crate::types::Options {
let mut o = crate::types::Options::default();
o.shiftwidth = self.settings.shiftwidth as u32;
o.tabstop = self.settings.tabstop as u32;
o.ignorecase = self.settings.ignore_case;
o
}
/// Apply a SPEC [`crate::types::Options`] to the engine's settings.
/// Only the fields backed by today's [`Settings`] take effect;
/// remaining options become live once trait extraction wires them
/// through.
pub fn apply_options(&mut self, opts: &crate::types::Options) {
self.settings.shiftwidth = opts.shiftwidth as usize;
self.settings.tabstop = opts.tabstop as usize;
self.settings.ignore_case = opts.ignorecase;
}
/// Active visual selection as a SPEC [`crate::types::Highlight`]
/// with [`crate::types::HighlightKind::Selection`].
///
/// Returns `None` when the editor isn't in a Visual mode.
/// Visual-line and visual-block selections collapse to the
/// bounding char range of the selection — the SPEC `Selection`
/// kind doesn't carry sub-line info today; hosts that need full
/// line / block geometry continue to read [`buffer_selection`]
/// (the legacy [`hjkl_buffer::Selection`] shape).
pub fn selection_highlight(&self) -> Option<crate::types::Highlight> {
use crate::types::{Highlight, HighlightKind, Pos};
let sel = self.buffer_selection()?;
let (start, end) = match sel {
hjkl_buffer::Selection::Char { anchor, head } => {
let a = (anchor.row, anchor.col);
let h = (head.row, head.col);
if a <= h { (a, h) } else { (h, a) }
}
hjkl_buffer::Selection::Line {
anchor_row,
head_row,
} => {
let (top, bot) = if anchor_row <= head_row {
(anchor_row, head_row)
} else {
(head_row, anchor_row)
};
let last_col = self.buffer.line(bot).map(|l| l.len()).unwrap_or(0);
((top, 0), (bot, last_col))
}
hjkl_buffer::Selection::Block { anchor, head } => {
let (top, bot) = if anchor.row <= head.row {
(anchor.row, head.row)
} else {
(head.row, anchor.row)
};
let (left, right) = if anchor.col <= head.col {
(anchor.col, head.col)
} else {
(head.col, anchor.col)
};
((top, left), (bot, right))
}
};
Some(Highlight {
range: Pos {
line: start.0 as u32,
col: start.1 as u32,
}..Pos {
line: end.0 as u32,
col: end.1 as u32,
},
kind: HighlightKind::Selection,
})
}
/// SPEC-typed highlights for `line`.
///
/// Today's emission is search-match-only: when the buffer has an
/// armed search pattern, every regex hit on that line surfaces as
/// a [`crate::types::Highlight`] with kind
/// [`crate::types::HighlightKind::SearchMatch`]. Selection,
/// IncSearch, MatchParen, and Syntax variants land once the trait
/// extraction routes the FSM's selection set + the host's syntax
/// pipeline through the [`crate::types::Host`] trait.
///
/// Returns an empty vec when the buffer has no search pattern
/// or `line` is out of bounds.
pub fn highlights_for_line(&mut self, line: u32) -> Vec<crate::types::Highlight> {
use crate::types::{Highlight, HighlightKind, Pos};
let row = line as usize;
if row >= self.buffer.lines().len() {
return Vec::new();
}
if self.buffer.search_pattern().is_none() {
return Vec::new();
}
self.buffer
.search_matches(row)
.into_iter()
.map(|(start, end)| Highlight {
range: Pos {
line,
col: start as u32,
}..Pos {
line,
col: end as u32,
},
kind: HighlightKind::SearchMatch,
})
.collect()
}
/// Build the engine's [`crate::types::RenderFrame`] for the
/// current state. Hosts call this once per redraw and diff
/// across frames.
///
/// Coarse today — covers mode + cursor + cursor shape + viewport
/// top + line count. SPEC-target fields (selections, highlights,
/// command line, search prompt, status line) land once trait
/// extraction routes them through `SelectionSet` and the
/// `Highlight` pipeline.
pub fn render_frame(&self) -> crate::types::RenderFrame {
use crate::types::{CursorShape, RenderFrame, SnapshotMode};
let (cursor_row, cursor_col) = self.cursor();
let (mode, shape) = match self.vim_mode() {
crate::VimMode::Normal => (SnapshotMode::Normal, CursorShape::Block),
crate::VimMode::Insert => (SnapshotMode::Insert, CursorShape::Bar),
crate::VimMode::Visual => (SnapshotMode::Visual, CursorShape::Block),
crate::VimMode::VisualLine => (SnapshotMode::VisualLine, CursorShape::Block),
crate::VimMode::VisualBlock => (SnapshotMode::VisualBlock, CursorShape::Block),
};
RenderFrame {
mode,
cursor_row: cursor_row as u32,
cursor_col: cursor_col as u32,
cursor_shape: shape,
viewport_top: self.buffer.viewport().top_row as u32,
line_count: self.buffer.lines().len() as u32,
}
}
/// Capture the editor's coarse state into a serde-friendly
/// [`crate::types::EditorSnapshot`].
///
/// Today's snapshot covers mode, cursor, lines, viewport top.
/// Registers, marks, jump list, undo tree, and full options arrive
/// once phase 5 trait extraction lands the generic
/// `Editor<B: Buffer, H: Host>` constructor — this method's surface
/// stays stable; only the snapshot's internal fields grow.
///
/// Distinct from the internal `snapshot` used by undo (which
/// returns `(Vec<String>, (usize, usize))`); host-facing
/// persistence goes through this one.
pub fn take_snapshot(&self) -> crate::types::EditorSnapshot {
use crate::types::{EditorSnapshot, SnapshotMode};
let mode = match self.vim_mode() {
crate::VimMode::Normal => SnapshotMode::Normal,
crate::VimMode::Insert => SnapshotMode::Insert,
crate::VimMode::Visual => SnapshotMode::Visual,
crate::VimMode::VisualLine => SnapshotMode::VisualLine,
crate::VimMode::VisualBlock => SnapshotMode::VisualBlock,
};
let cursor = self.cursor();
let cursor = (cursor.0 as u32, cursor.1 as u32);
let lines: Vec<String> = self.buffer.lines().to_vec();
let viewport_top = self.buffer.viewport().top_row as u32;
let file_marks = self
.file_marks
.iter()
.map(|(c, (r, col))| (*c, (*r as u32, *col as u32)))
.collect();
EditorSnapshot {
version: EditorSnapshot::VERSION,
mode,
cursor,
lines,
viewport_top,
registers: self.registers.clone(),
file_marks,
}
}
/// Restore editor state from an [`EditorSnapshot`]. Returns
/// [`crate::EngineError::SnapshotVersion`] if the snapshot's
/// `version` doesn't match [`EditorSnapshot::VERSION`].
///
/// Mode is best-effort: `SnapshotMode` only round-trips the
/// status-line summary, not the full FSM state. Visual / Insert
/// mode entry happens through synthetic key dispatch when needed.
pub fn restore_snapshot(
&mut self,
snap: crate::types::EditorSnapshot,
) -> Result<(), crate::EngineError> {
use crate::types::EditorSnapshot;
if snap.version != EditorSnapshot::VERSION {
return Err(crate::EngineError::SnapshotVersion(
snap.version,
EditorSnapshot::VERSION,
));
}
let text = snap.lines.join("\n");
self.set_content(&text);
self.jump_cursor(snap.cursor.0 as usize, snap.cursor.1 as usize);
let mut vp = self.buffer.viewport();
vp.top_row = snap.viewport_top as usize;
*self.buffer.viewport_mut() = vp;
self.registers = snap.registers;
self.file_marks = snap
.file_marks
.into_iter()
.map(|(c, (r, col))| (c, (r as usize, col as usize)))
.collect();
Ok(())
}
/// Install `text` as the pending yank buffer so the next `p`/`P` pastes
/// it. Linewise is inferred from a trailing newline, matching how `yy`/`dd`
/// shape their payload.
pub fn seed_yank(&mut self, text: String) {
let linewise = text.ends_with('\n');
self.vim.yank_linewise = linewise;
self.registers.unnamed = crate::registers::Slot { text, linewise };
}
/// Scroll the viewport down by `rows`. The cursor stays on its
/// absolute line (vim convention) unless the scroll would take it
/// off-screen — in that case it's clamped to the first row still
/// visible.
pub fn scroll_down(&mut self, rows: i16) {
self.scroll_viewport(rows);
}
/// Scroll the viewport up by `rows`. Cursor stays unless it would
/// fall off the bottom of the new viewport, then clamp to the
/// bottom-most visible row.
pub fn scroll_up(&mut self, rows: i16) {
self.scroll_viewport(-rows);
}
/// Vim's `scrolloff` default — keep the cursor at least this many
/// rows away from the top / bottom edge of the viewport while
/// scrolling. Collapses to `height / 2` for tiny viewports.
const SCROLLOFF: usize = 5;
/// Scroll the viewport so the cursor stays at least `SCROLLOFF`
/// rows from each edge. Replaces the bare
/// `Buffer::ensure_cursor_visible` call at end-of-step so motions
/// don't park the cursor on the very last visible row.
pub(crate) fn ensure_cursor_in_scrolloff(&mut self) {
let height = self.viewport_height.load(Ordering::Relaxed) as usize;
if height == 0 {
self.buffer.ensure_cursor_visible();
return;
}
// Cap margin at (height - 1) / 2 so the upper + lower bands
// can't overlap on tiny windows (margin=5 + height=10 would
// otherwise produce contradictory clamp ranges).
let margin = Self::SCROLLOFF.min(height.saturating_sub(1) / 2);
// Soft-wrap path: scrolloff math runs in *screen rows*, not
// doc rows, since a wrapped doc row spans many visual lines.
if !matches!(self.buffer.viewport().wrap, hjkl_buffer::Wrap::None) {
self.ensure_scrolloff_wrap(height, margin);
return;
}
let cursor_row = self.buffer.cursor().row;
let last_row = self.buffer.row_count().saturating_sub(1);
let v = self.buffer.viewport_mut();
// Top edge: cursor_row should sit at >= top_row + margin.
if cursor_row < v.top_row + margin {
v.top_row = cursor_row.saturating_sub(margin);
}
// Bottom edge: cursor_row should sit at <= top_row + height - 1 - margin.
let max_bottom = height.saturating_sub(1).saturating_sub(margin);
if cursor_row > v.top_row + max_bottom {
v.top_row = cursor_row.saturating_sub(max_bottom);
}
// Clamp top_row so we never scroll past the buffer's bottom.
let max_top = last_row.saturating_sub(height.saturating_sub(1));
if v.top_row > max_top {
v.top_row = max_top;
}
// Defer to Buffer for column-side scroll (no scrolloff for
// horizontal scrolling — vim default `sidescrolloff = 0`).
let cursor = self.buffer.cursor();
self.buffer.viewport_mut().ensure_visible(cursor);
}
/// Soft-wrap-aware scrolloff. Walks `top_row` one visible doc row
/// at a time so the cursor's *screen* row stays inside
/// `[margin, height - 1 - margin]`, then clamps `top_row` so the
/// buffer's bottom never leaves blank rows below it.
fn ensure_scrolloff_wrap(&mut self, height: usize, margin: usize) {
let cursor_row = self.buffer.cursor().row;
// Step 1 — cursor above viewport: snap top to cursor row,
// then we'll fix up the margin below.
if cursor_row < self.buffer.viewport().top_row {
self.buffer.viewport_mut().top_row = cursor_row;
self.buffer.viewport_mut().top_col = 0;
}
// Step 2 — push top forward until cursor's screen row is
// within the bottom margin (`csr <= height - 1 - margin`).
let max_csr = height.saturating_sub(1).saturating_sub(margin);
loop {
let csr = self.buffer.cursor_screen_row().unwrap_or(0);
if csr <= max_csr {
break;
}
let top = self.buffer.viewport().top_row;
let Some(next) = self.buffer.next_visible_row(top) else {
break;
};
// Don't walk past the cursor's row.
if next > cursor_row {
self.buffer.viewport_mut().top_row = cursor_row;
break;
}
self.buffer.viewport_mut().top_row = next;
}
// Step 3 — pull top backward until cursor's screen row is
// past the top margin (`csr >= margin`).
loop {
let csr = self.buffer.cursor_screen_row().unwrap_or(0);
if csr >= margin {
break;
}
let top = self.buffer.viewport().top_row;
let Some(prev) = self.buffer.prev_visible_row(top) else {
break;
};
self.buffer.viewport_mut().top_row = prev;
}
// Step 4 — clamp top so the buffer's bottom doesn't leave
// blank rows below it. `max_top_for_height` walks segments
// backward from the last row until it accumulates `height`
// screen rows.
let max_top = self.buffer.max_top_for_height(height);
if self.buffer.viewport().top_row > max_top {
self.buffer.viewport_mut().top_row = max_top;
}
self.buffer.viewport_mut().top_col = 0;
}
fn scroll_viewport(&mut self, delta: i16) {
if delta == 0 {
return;
}
// Bump the buffer's viewport top within bounds.
let total_rows = self.buffer.row_count() as isize;
let height = self.viewport_height.load(Ordering::Relaxed) as usize;
let cur_top = self.buffer.viewport().top_row as isize;
let new_top = (cur_top + delta as isize)
.max(0)
.min((total_rows - 1).max(0)) as usize;
self.buffer.viewport_mut().top_row = new_top;
// Mirror to textarea so its viewport reads (still consumed by
// a couple of helpers) stay accurate.
let _ = cur_top;
if height == 0 {
return;
}
// Apply scrolloff: keep the cursor at least SCROLLOFF rows
// from the visible viewport edges.
let cursor = self.buffer.cursor();
let margin = Self::SCROLLOFF.min(height / 2);
let min_row = new_top + margin;
let max_row = new_top + height.saturating_sub(1).saturating_sub(margin);
let target_row = cursor.row.clamp(min_row, max_row.max(min_row));
if target_row != cursor.row {
let line_len = self
.buffer
.line(target_row)
.map(|l| l.chars().count())
.unwrap_or(0);
let target_col = cursor.col.min(line_len.saturating_sub(1));
self.buffer
.set_cursor(hjkl_buffer::Position::new(target_row, target_col));
}
}
pub fn goto_line(&mut self, line: usize) {
let row = line.saturating_sub(1);
let max = self.buffer.row_count().saturating_sub(1);
let target = row.min(max);
self.buffer
.set_cursor(hjkl_buffer::Position::new(target, 0));
}
/// Scroll so the cursor row lands at the given viewport position:
/// `Center` → middle row, `Top` → first row, `Bottom` → last row.
/// Cursor stays on its absolute line; only the viewport moves.
pub(super) fn scroll_cursor_to(&mut self, pos: CursorScrollTarget) {
let height = self.viewport_height.load(Ordering::Relaxed) as usize;
if height == 0 {
return;
}
let cur_row = self.buffer.cursor().row;
let cur_top = self.buffer.viewport().top_row;
// Scrolloff awareness: `zt` lands the cursor at the top edge
// of the viable area (top + margin), `zb` at the bottom edge
// (top + height - 1 - margin). Match the cap used by
// `ensure_cursor_in_scrolloff` so contradictory bounds are
// impossible on tiny viewports.
let margin = Self::SCROLLOFF.min(height.saturating_sub(1) / 2);
let new_top = match pos {
CursorScrollTarget::Center => cur_row.saturating_sub(height / 2),
CursorScrollTarget::Top => cur_row.saturating_sub(margin),
CursorScrollTarget::Bottom => {
cur_row.saturating_sub(height.saturating_sub(1).saturating_sub(margin))
}
};
if new_top == cur_top {
return;
}
self.buffer.viewport_mut().top_row = new_top;
}
/// Translate a terminal mouse position into a (row, col) inside the document.
/// `area` is the outer editor rect: 1-row tab bar at top (flush), then the
/// textarea with 1 cell of horizontal pane padding on each side. Clicks
/// past the line's last character clamp to the last char (Normal-mode
/// invariant) — never past it. Char-counted, not byte-counted, so
/// multibyte runs land where the user expects.
fn mouse_to_doc_pos(&self, area: Rect, col: u16, row: u16) -> (usize, usize) {
let lines = self.buffer.lines();
let inner_top = area.y.saturating_add(1); // tab bar row
let lnum_width = lines.len().to_string().len() as u16 + 2;
let content_x = area.x.saturating_add(1).saturating_add(lnum_width);
let rel_row = row.saturating_sub(inner_top) as usize;
let top = self.buffer.viewport().top_row;
let doc_row = (top + rel_row).min(lines.len().saturating_sub(1));
let rel_col = col.saturating_sub(content_x) as usize;
let line_chars = lines.get(doc_row).map(|l| l.chars().count()).unwrap_or(0);
let last_col = line_chars.saturating_sub(1);
(doc_row, rel_col.min(last_col))
}
/// Jump the cursor to the given 1-based line/column, clamped to the document.
pub fn jump_to(&mut self, line: usize, col: usize) {
let r = line.saturating_sub(1);
let max_row = self.buffer.row_count().saturating_sub(1);
let r = r.min(max_row);
let line_len = self.buffer.line(r).map(|l| l.chars().count()).unwrap_or(0);
let c = col.saturating_sub(1).min(line_len);
self.buffer.set_cursor(hjkl_buffer::Position::new(r, c));
}
/// Jump cursor to the terminal-space mouse position; exits Visual modes if active.
pub fn mouse_click(&mut self, area: Rect, col: u16, row: u16) {
if self.vim.is_visual() {
self.vim.force_normal();
}
let (r, c) = self.mouse_to_doc_pos(area, col, row);
self.buffer.set_cursor(hjkl_buffer::Position::new(r, c));
}
/// Begin a mouse-drag selection: anchor at current cursor and enter Visual mode.
pub fn mouse_begin_drag(&mut self) {
if !self.vim.is_visual_char() {
let cursor = self.cursor();
self.vim.enter_visual(cursor);
}
}
/// Extend an in-progress mouse drag to the given terminal-space position.
pub fn mouse_extend_drag(&mut self, area: Rect, col: u16, row: u16) {
let (r, c) = self.mouse_to_doc_pos(area, col, row);
self.buffer.set_cursor(hjkl_buffer::Position::new(r, c));
}
pub fn insert_str(&mut self, text: &str) {
let pos = self.buffer.cursor();
self.buffer.apply_edit(hjkl_buffer::Edit::InsertStr {
at: pos,
text: text.to_string(),
});
self.push_buffer_content_to_textarea();
self.mark_content_dirty();
}
pub fn accept_completion(&mut self, completion: &str) {
use hjkl_buffer::{Edit, MotionKind, Position};
let cursor = self.buffer.cursor();
let line = self.buffer.line(cursor.row).unwrap_or("").to_string();
let chars: Vec<char> = line.chars().collect();
let prefix_len = chars[..cursor.col.min(chars.len())]
.iter()
.rev()
.take_while(|c| c.is_alphanumeric() || **c == '_')
.count();
if prefix_len > 0 {
let start = Position::new(cursor.row, cursor.col - prefix_len);
self.buffer.apply_edit(Edit::DeleteRange {
start,
end: cursor,
kind: MotionKind::Char,
});
}
let cursor = self.buffer.cursor();
self.buffer.apply_edit(Edit::InsertStr {
at: cursor,
text: completion.to_string(),
});
self.push_buffer_content_to_textarea();
self.mark_content_dirty();
}
pub(super) fn snapshot(&self) -> (Vec<String>, (usize, usize)) {
let pos = self.buffer.cursor();
(self.buffer.lines().to_vec(), (pos.row, pos.col))
}
#[doc(hidden)]
pub fn push_undo(&mut self) {
let snap = self.snapshot();
if self.undo_stack.len() >= 200 {
self.undo_stack.remove(0);
}
self.undo_stack.push(snap);
self.redo_stack.clear();
}
#[doc(hidden)]
pub fn restore(&mut self, lines: Vec<String>, cursor: (usize, usize)) {
let text = lines.join("\n");
self.buffer.replace_all(&text);
self.buffer
.set_cursor(hjkl_buffer::Position::new(cursor.0, cursor.1));
self.mark_content_dirty();
}
/// Returns true if the key was consumed by the editor.
pub fn handle_key(&mut self, key: KeyEvent) -> bool {
let input = crossterm_to_input(key);
if input.key == Key::Null {
return false;
}
vim::step(self, input)
}
}
pub(super) fn crossterm_to_input(key: KeyEvent) -> Input {
let ctrl = key.modifiers.contains(KeyModifiers::CONTROL);
let alt = key.modifiers.contains(KeyModifiers::ALT);
let shift = key.modifiers.contains(KeyModifiers::SHIFT);
let k = match key.code {
KeyCode::Char(c) => Key::Char(c),
KeyCode::Backspace => Key::Backspace,
KeyCode::Delete => Key::Delete,
KeyCode::Enter => Key::Enter,
KeyCode::Left => Key::Left,
KeyCode::Right => Key::Right,
KeyCode::Up => Key::Up,
KeyCode::Down => Key::Down,
KeyCode::Home => Key::Home,
KeyCode::End => Key::End,
KeyCode::Tab => Key::Tab,
KeyCode::Esc => Key::Esc,
_ => Key::Null,
};
Input {
key: k,
ctrl,
alt,
shift,
}
}
#[cfg(test)]
mod tests {
use super::*;
use crossterm::event::KeyEvent;
fn key(code: KeyCode) -> KeyEvent {
KeyEvent::new(code, KeyModifiers::NONE)
}
fn shift_key(code: KeyCode) -> KeyEvent {
KeyEvent::new(code, KeyModifiers::SHIFT)
}
fn ctrl_key(code: KeyCode) -> KeyEvent {
KeyEvent::new(code, KeyModifiers::CONTROL)
}
#[test]
fn vim_normal_to_insert() {
let mut e = Editor::new(KeybindingMode::Vim);
e.handle_key(key(KeyCode::Char('i')));
assert_eq!(e.vim_mode(), VimMode::Insert);
}
#[test]
fn intern_engine_style_dedups_with_intern_style() {
use crate::types::{Attrs, Color, Style};
let mut e = Editor::new(KeybindingMode::Vim);
let s = Style {
fg: Some(Color(255, 0, 0)),
bg: None,
attrs: Attrs::BOLD,
};
let id_a = e.intern_engine_style(s);
// Re-interning the same engine style returns the same id.
let id_b = e.intern_engine_style(s);
assert_eq!(id_a, id_b);
// Engine accessor returns the same style back.
let back = e.engine_style_at(id_a).expect("interned");
assert_eq!(back, s);
}
#[test]
fn engine_style_at_out_of_range_returns_none() {
let e = Editor::new(KeybindingMode::Vim);
assert!(e.engine_style_at(99).is_none());
}
#[test]
fn take_changes_drains_after_insert() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("abc");
// Empty initially.
assert!(e.take_changes().is_empty());
// Type a char in insert mode.
e.handle_key(key(KeyCode::Char('i')));
e.handle_key(key(KeyCode::Char('X')));
let changes = e.take_changes();
assert!(
!changes.is_empty(),
"insert mode keystroke should produce a change"
);
// Drained — second call empty.
assert!(e.take_changes().is_empty());
}
#[test]
fn options_bridge_roundtrip() {
let mut e = Editor::new(KeybindingMode::Vim);
let opts = e.current_options();
assert_eq!(opts.shiftwidth, 2); // legacy Settings default
assert_eq!(opts.tabstop, 8);
let mut new_opts = crate::types::Options::default();
new_opts.shiftwidth = 4;
new_opts.tabstop = 2;
new_opts.ignorecase = true;
e.apply_options(&new_opts);
let after = e.current_options();
assert_eq!(after.shiftwidth, 4);
assert_eq!(after.tabstop, 2);
assert!(after.ignorecase);
}
#[test]
fn selection_highlight_none_in_normal() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("hello");
assert!(e.selection_highlight().is_none());
}
#[test]
fn selection_highlight_some_in_visual() {
use crate::types::HighlightKind;
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("hello world");
e.handle_key(key(KeyCode::Char('v')));
e.handle_key(key(KeyCode::Char('l')));
e.handle_key(key(KeyCode::Char('l')));
let h = e
.selection_highlight()
.expect("visual mode should produce a highlight");
assert_eq!(h.kind, HighlightKind::Selection);
assert_eq!(h.range.start.line, 0);
assert_eq!(h.range.end.line, 0);
}
#[test]
fn highlights_emit_search_matches() {
use crate::types::HighlightKind;
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("foo bar foo\nbaz qux\n");
// Arm a search via buffer's pattern setter.
e.buffer_mut()
.set_search_pattern(Some(regex::Regex::new("foo").unwrap()));
let hs = e.highlights_for_line(0);
assert_eq!(hs.len(), 2);
for h in &hs {
assert_eq!(h.kind, HighlightKind::SearchMatch);
assert_eq!(h.range.start.line, 0);
assert_eq!(h.range.end.line, 0);
}
}
#[test]
fn highlights_empty_without_pattern() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("foo bar");
assert!(e.highlights_for_line(0).is_empty());
}
#[test]
fn highlights_empty_for_out_of_range_line() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("foo");
e.buffer_mut()
.set_search_pattern(Some(regex::Regex::new("foo").unwrap()));
assert!(e.highlights_for_line(99).is_empty());
}
#[test]
fn render_frame_reflects_mode_and_cursor() {
use crate::types::{CursorShape, SnapshotMode};
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("alpha\nbeta");
let f = e.render_frame();
assert_eq!(f.mode, SnapshotMode::Normal);
assert_eq!(f.cursor_shape, CursorShape::Block);
assert_eq!(f.line_count, 2);
e.handle_key(key(KeyCode::Char('i')));
let f = e.render_frame();
assert_eq!(f.mode, SnapshotMode::Insert);
assert_eq!(f.cursor_shape, CursorShape::Bar);
}
#[test]
fn snapshot_roundtrips_through_restore() {
use crate::types::SnapshotMode;
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("alpha\nbeta\ngamma");
e.jump_cursor(2, 3);
let snap = e.take_snapshot();
assert_eq!(snap.mode, SnapshotMode::Normal);
assert_eq!(snap.cursor, (2, 3));
assert_eq!(snap.lines.len(), 3);
let mut other = Editor::new(KeybindingMode::Vim);
other.restore_snapshot(snap).expect("restore");
assert_eq!(other.cursor(), (2, 3));
assert_eq!(other.buffer().lines().len(), 3);
}
#[test]
fn restore_snapshot_rejects_version_mismatch() {
let mut e = Editor::new(KeybindingMode::Vim);
let mut snap = e.take_snapshot();
snap.version = 9999;
match e.restore_snapshot(snap) {
Err(crate::EngineError::SnapshotVersion(got, want)) => {
assert_eq!(got, 9999);
assert_eq!(want, crate::types::EditorSnapshot::VERSION);
}
other => panic!("expected SnapshotVersion err, got {other:?}"),
}
}
#[test]
fn take_content_change_returns_some_on_first_dirty() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("hello");
let first = e.take_content_change();
assert!(first.is_some());
let second = e.take_content_change();
assert!(second.is_none());
}
#[test]
fn take_content_change_none_until_mutation() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("hello");
// drain
e.take_content_change();
assert!(e.take_content_change().is_none());
// mutate via insert mode
e.handle_key(key(KeyCode::Char('i')));
e.handle_key(key(KeyCode::Char('x')));
let after = e.take_content_change();
assert!(after.is_some());
assert!(after.unwrap().contains('x'));
}
#[test]
fn vim_insert_to_normal() {
let mut e = Editor::new(KeybindingMode::Vim);
e.handle_key(key(KeyCode::Char('i')));
e.handle_key(key(KeyCode::Esc));
assert_eq!(e.vim_mode(), VimMode::Normal);
}
#[test]
fn vim_normal_to_visual() {
let mut e = Editor::new(KeybindingMode::Vim);
e.handle_key(key(KeyCode::Char('v')));
assert_eq!(e.vim_mode(), VimMode::Visual);
}
#[test]
fn vim_visual_to_normal() {
let mut e = Editor::new(KeybindingMode::Vim);
e.handle_key(key(KeyCode::Char('v')));
e.handle_key(key(KeyCode::Esc));
assert_eq!(e.vim_mode(), VimMode::Normal);
}
#[test]
fn vim_shift_i_moves_to_first_non_whitespace() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content(" hello");
e.jump_cursor(0, 8);
e.handle_key(shift_key(KeyCode::Char('I')));
assert_eq!(e.vim_mode(), VimMode::Insert);
assert_eq!(e.cursor(), (0, 3));
}
#[test]
fn vim_shift_a_moves_to_end_and_insert() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("hello");
e.handle_key(shift_key(KeyCode::Char('A')));
assert_eq!(e.vim_mode(), VimMode::Insert);
assert_eq!(e.cursor().1, 5);
}
#[test]
fn count_10j_moves_down_10() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content(
(0..20)
.map(|i| format!("line{i}"))
.collect::<Vec<_>>()
.join("\n")
.as_str(),
);
for d in "10".chars() {
e.handle_key(key(KeyCode::Char(d)));
}
e.handle_key(key(KeyCode::Char('j')));
assert_eq!(e.cursor().0, 10);
}
#[test]
fn count_o_repeats_insert_on_esc() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("hello");
for d in "3".chars() {
e.handle_key(key(KeyCode::Char(d)));
}
e.handle_key(key(KeyCode::Char('o')));
assert_eq!(e.vim_mode(), VimMode::Insert);
for c in "world".chars() {
e.handle_key(key(KeyCode::Char(c)));
}
e.handle_key(key(KeyCode::Esc));
assert_eq!(e.vim_mode(), VimMode::Normal);
assert_eq!(e.buffer().lines().len(), 4);
assert!(e.buffer().lines().iter().skip(1).all(|l| l == "world"));
}
#[test]
fn count_i_repeats_text_on_esc() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("");
for d in "3".chars() {
e.handle_key(key(KeyCode::Char(d)));
}
e.handle_key(key(KeyCode::Char('i')));
for c in "ab".chars() {
e.handle_key(key(KeyCode::Char(c)));
}
e.handle_key(key(KeyCode::Esc));
assert_eq!(e.vim_mode(), VimMode::Normal);
assert_eq!(e.buffer().lines()[0], "ababab");
}
#[test]
fn vim_shift_o_opens_line_above() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("hello");
e.handle_key(shift_key(KeyCode::Char('O')));
assert_eq!(e.vim_mode(), VimMode::Insert);
assert_eq!(e.cursor(), (0, 0));
assert_eq!(e.buffer().lines().len(), 2);
}
#[test]
fn vim_gg_goes_to_top() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("a\nb\nc");
e.jump_cursor(2, 0);
e.handle_key(key(KeyCode::Char('g')));
e.handle_key(key(KeyCode::Char('g')));
assert_eq!(e.cursor().0, 0);
}
#[test]
fn vim_shift_g_goes_to_bottom() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("a\nb\nc");
e.handle_key(shift_key(KeyCode::Char('G')));
assert_eq!(e.cursor().0, 2);
}
#[test]
fn vim_dd_deletes_line() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("first\nsecond");
e.handle_key(key(KeyCode::Char('d')));
e.handle_key(key(KeyCode::Char('d')));
assert_eq!(e.buffer().lines().len(), 1);
assert_eq!(e.buffer().lines()[0], "second");
}
#[test]
fn vim_dw_deletes_word() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("hello world");
e.handle_key(key(KeyCode::Char('d')));
e.handle_key(key(KeyCode::Char('w')));
assert_eq!(e.vim_mode(), VimMode::Normal);
assert!(!e.buffer().lines()[0].starts_with("hello"));
}
#[test]
fn vim_yy_yanks_line() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("hello\nworld");
e.handle_key(key(KeyCode::Char('y')));
e.handle_key(key(KeyCode::Char('y')));
assert!(e.last_yank.as_deref().unwrap_or("").starts_with("hello"));
}
#[test]
fn vim_yy_does_not_move_cursor() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("first\nsecond\nthird");
e.jump_cursor(1, 0);
let before = e.cursor();
e.handle_key(key(KeyCode::Char('y')));
e.handle_key(key(KeyCode::Char('y')));
assert_eq!(e.cursor(), before);
assert_eq!(e.vim_mode(), VimMode::Normal);
}
#[test]
fn vim_yw_yanks_word() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("hello world");
e.handle_key(key(KeyCode::Char('y')));
e.handle_key(key(KeyCode::Char('w')));
assert_eq!(e.vim_mode(), VimMode::Normal);
assert!(e.last_yank.is_some());
}
#[test]
fn vim_cc_changes_line() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("hello\nworld");
e.handle_key(key(KeyCode::Char('c')));
e.handle_key(key(KeyCode::Char('c')));
assert_eq!(e.vim_mode(), VimMode::Insert);
}
#[test]
fn vim_u_undoes_insert_session_as_chunk() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("hello");
e.handle_key(key(KeyCode::Char('i')));
e.handle_key(key(KeyCode::Enter));
e.handle_key(key(KeyCode::Enter));
e.handle_key(key(KeyCode::Esc));
assert_eq!(e.buffer().lines().len(), 3);
e.handle_key(key(KeyCode::Char('u')));
assert_eq!(e.buffer().lines().len(), 1);
assert_eq!(e.buffer().lines()[0], "hello");
}
#[test]
fn vim_undo_redo_roundtrip() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("hello");
e.handle_key(key(KeyCode::Char('i')));
for c in "world".chars() {
e.handle_key(key(KeyCode::Char(c)));
}
e.handle_key(key(KeyCode::Esc));
let after = e.buffer().lines()[0].clone();
e.handle_key(key(KeyCode::Char('u')));
assert_eq!(e.buffer().lines()[0], "hello");
e.handle_key(ctrl_key(KeyCode::Char('r')));
assert_eq!(e.buffer().lines()[0], after);
}
#[test]
fn vim_u_undoes_dd() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("first\nsecond");
e.handle_key(key(KeyCode::Char('d')));
e.handle_key(key(KeyCode::Char('d')));
assert_eq!(e.buffer().lines().len(), 1);
e.handle_key(key(KeyCode::Char('u')));
assert_eq!(e.buffer().lines().len(), 2);
assert_eq!(e.buffer().lines()[0], "first");
}
#[test]
fn vim_ctrl_r_redoes() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("hello");
e.handle_key(ctrl_key(KeyCode::Char('r')));
}
#[test]
fn vim_r_replaces_char() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("hello");
e.handle_key(key(KeyCode::Char('r')));
e.handle_key(key(KeyCode::Char('x')));
assert_eq!(e.buffer().lines()[0].chars().next(), Some('x'));
}
#[test]
fn vim_tilde_toggles_case() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("hello");
e.handle_key(key(KeyCode::Char('~')));
assert_eq!(e.buffer().lines()[0].chars().next(), Some('H'));
}
#[test]
fn vim_visual_d_cuts() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("hello");
e.handle_key(key(KeyCode::Char('v')));
e.handle_key(key(KeyCode::Char('l')));
e.handle_key(key(KeyCode::Char('l')));
e.handle_key(key(KeyCode::Char('d')));
assert_eq!(e.vim_mode(), VimMode::Normal);
assert!(e.last_yank.is_some());
}
#[test]
fn vim_visual_c_enters_insert() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("hello");
e.handle_key(key(KeyCode::Char('v')));
e.handle_key(key(KeyCode::Char('l')));
e.handle_key(key(KeyCode::Char('c')));
assert_eq!(e.vim_mode(), VimMode::Insert);
}
#[test]
fn vim_normal_unknown_key_consumed() {
let mut e = Editor::new(KeybindingMode::Vim);
// Unknown keys are consumed (swallowed) rather than returning false.
let consumed = e.handle_key(key(KeyCode::Char('z')));
assert!(consumed);
}
#[test]
fn force_normal_clears_operator() {
let mut e = Editor::new(KeybindingMode::Vim);
e.handle_key(key(KeyCode::Char('d')));
e.force_normal();
assert_eq!(e.vim_mode(), VimMode::Normal);
}
fn many_lines(n: usize) -> String {
(0..n)
.map(|i| format!("line{i}"))
.collect::<Vec<_>>()
.join("\n")
}
fn prime_viewport(e: &mut Editor<'_>, height: u16) {
e.set_viewport_height(height);
}
#[test]
fn zz_centers_cursor_in_viewport() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content(&many_lines(100));
prime_viewport(&mut e, 20);
e.jump_cursor(50, 0);
e.handle_key(key(KeyCode::Char('z')));
e.handle_key(key(KeyCode::Char('z')));
assert_eq!(e.buffer().viewport().top_row, 40);
assert_eq!(e.cursor().0, 50);
}
#[test]
fn zt_puts_cursor_at_viewport_top_with_scrolloff() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content(&many_lines(100));
prime_viewport(&mut e, 20);
e.jump_cursor(50, 0);
e.handle_key(key(KeyCode::Char('z')));
e.handle_key(key(KeyCode::Char('t')));
// Cursor lands at top of viable area = top + SCROLLOFF (5).
// Viewport top therefore sits at cursor - 5.
assert_eq!(e.buffer().viewport().top_row, 45);
assert_eq!(e.cursor().0, 50);
}
#[test]
fn ctrl_a_increments_number_at_cursor() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("x = 41");
e.handle_key(ctrl_key(KeyCode::Char('a')));
assert_eq!(e.buffer().lines()[0], "x = 42");
assert_eq!(e.cursor(), (0, 5));
}
#[test]
fn ctrl_a_finds_number_to_right_of_cursor() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("foo 99 bar");
e.handle_key(ctrl_key(KeyCode::Char('a')));
assert_eq!(e.buffer().lines()[0], "foo 100 bar");
assert_eq!(e.cursor(), (0, 6));
}
#[test]
fn ctrl_a_with_count_adds_count() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("x = 10");
for d in "5".chars() {
e.handle_key(key(KeyCode::Char(d)));
}
e.handle_key(ctrl_key(KeyCode::Char('a')));
assert_eq!(e.buffer().lines()[0], "x = 15");
}
#[test]
fn ctrl_x_decrements_number() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("n=5");
e.handle_key(ctrl_key(KeyCode::Char('x')));
assert_eq!(e.buffer().lines()[0], "n=4");
}
#[test]
fn ctrl_x_crosses_zero_into_negative() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("v=0");
e.handle_key(ctrl_key(KeyCode::Char('x')));
assert_eq!(e.buffer().lines()[0], "v=-1");
}
#[test]
fn ctrl_a_on_negative_number_increments_toward_zero() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("a = -5");
e.handle_key(ctrl_key(KeyCode::Char('a')));
assert_eq!(e.buffer().lines()[0], "a = -4");
}
#[test]
fn ctrl_a_noop_when_no_digit_on_line() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("no digits here");
e.handle_key(ctrl_key(KeyCode::Char('a')));
assert_eq!(e.buffer().lines()[0], "no digits here");
}
#[test]
fn zb_puts_cursor_at_viewport_bottom_with_scrolloff() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content(&many_lines(100));
prime_viewport(&mut e, 20);
e.jump_cursor(50, 0);
e.handle_key(key(KeyCode::Char('z')));
e.handle_key(key(KeyCode::Char('b')));
// Cursor lands at bottom of viable area = top + height - 1 -
// SCROLLOFF. For height 20, scrolloff 5: cursor at top + 14,
// so top = cursor - 14 = 36.
assert_eq!(e.buffer().viewport().top_row, 36);
assert_eq!(e.cursor().0, 50);
}
/// Contract that the TUI drain relies on: `set_content` flags the
/// editor dirty (so the next `take_dirty` call reports the change),
/// and a second `take_dirty` returns `false` after consumption. The
/// TUI drains this flag after every programmatic content load so
/// opening a tab doesn't get mistaken for a user edit and mark the
/// tab dirty (which would then trigger the quit-prompt on `:q`).
#[test]
fn set_content_dirties_then_take_dirty_clears() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("hello");
assert!(
e.take_dirty(),
"set_content should leave content_dirty=true"
);
assert!(!e.take_dirty(), "take_dirty should clear the flag");
}
#[test]
fn content_arc_returns_same_arc_until_mutation() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("hello");
let a = e.content_arc();
let b = e.content_arc();
assert!(
std::sync::Arc::ptr_eq(&a, &b),
"repeated content_arc() should hit the cache"
);
// Any mutation must invalidate the cache.
e.handle_key(key(KeyCode::Char('i')));
e.handle_key(key(KeyCode::Char('!')));
let c = e.content_arc();
assert!(
!std::sync::Arc::ptr_eq(&a, &c),
"mutation should invalidate content_arc() cache"
);
assert!(c.contains('!'));
}
#[test]
fn content_arc_cache_invalidated_by_set_content() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("one");
let a = e.content_arc();
e.set_content("two");
let b = e.content_arc();
assert!(!std::sync::Arc::ptr_eq(&a, &b));
assert!(b.starts_with("two"));
}
/// Click past the last char of a line should land the cursor on
/// the line's last char (Normal mode), not one past it. The
/// previous bug clamped to the line's BYTE length and used `>=`
/// past-end, so clicking deep into the trailing space parked the
/// cursor at `chars().count()` — past where Normal mode lives.
#[test]
fn mouse_click_past_eol_lands_on_last_char() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("hello");
// Outer editor area: x=0, y=0, width=80. mouse_to_doc_pos
// reserves row 0 for the tab bar and adds gutter padding,
// so click row 1, way past the line end.
let area = ratatui::layout::Rect::new(0, 0, 80, 10);
e.mouse_click(area, 78, 1);
assert_eq!(e.cursor(), (0, 4));
}
#[test]
fn mouse_click_past_eol_handles_multibyte_line() {
let mut e = Editor::new(KeybindingMode::Vim);
// 5 chars, 6 bytes — old code's `String::len()` clamp was
// wrong here.
e.set_content("héllo");
let area = ratatui::layout::Rect::new(0, 0, 80, 10);
e.mouse_click(area, 78, 1);
assert_eq!(e.cursor(), (0, 4));
}
#[test]
fn mouse_click_inside_line_lands_on_clicked_char() {
let mut e = Editor::new(KeybindingMode::Vim);
e.set_content("hello world");
// Gutter is `lnum_width + 1` = (1-digit row count + 2) + 1
// pane padding = 4 cells; click col 4 is the first char.
let area = ratatui::layout::Rect::new(0, 0, 80, 10);
e.mouse_click(area, 4, 1);
assert_eq!(e.cursor(), (0, 0));
e.mouse_click(area, 6, 1);
assert_eq!(e.cursor(), (0, 2));
}
}