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
//! `SearchList`: the one module behind every query-input-over-an-async-loaded
//! list surface in the TUI. See CONTEXT.md.
#[cfg(test)]
mod adapters;
mod host;
mod load;
mod seams;
pub use seams::{
Emit, Filter, Loaded, RowSource, SearchRow, SuggestionItem, SuggestionSource, VaultSuggestions,
};
use crate::components::autocomplete::{
AutocompleteController, AutocompleteMode, HandleKeyOutcome, TriggerOptions,
};
use crate::components::single_line_input::{InputOutcome, SingleLineInput};
use crate::keys::key_combo::KeyCombo;
use crate::settings::icons::Icons;
use crate::settings::themes::Theme;
use load::LoadEngine;
use ratatui::crossterm::event::KeyEvent;
use ratatui::{
Frame,
layout::Rect,
style::Style,
widgets::{List, ListItem, ListState},
};
use seams::Loaded as LoadedInner;
use std::sync::Arc;
fn fuzzy_indices<R: SearchRow>(rows: &[R], query: &str) -> Vec<usize> {
use nucleo::pattern::{CaseMatching, Normalization, Pattern};
use nucleo::{Matcher, Utf32Str};
let mut matcher = Matcher::new(nucleo::Config::DEFAULT);
let pat = Pattern::parse(query, CaseMatching::Ignore, Normalization::Smart);
let mut scored: Vec<(usize, u32)> = rows
.iter()
.enumerate()
.filter_map(|(i, r)| {
let hay = r.match_text()?;
let mut buf = Vec::new();
let h = Utf32Str::new(hay, &mut buf);
pat.score(h, &mut matcher).map(|s| (i, s))
})
.collect();
scored.sort_by_key(|&(_, s)| std::cmp::Reverse(s));
scored.into_iter().map(|(i, _)| i).collect()
}
/// Verdict returned by [`SearchList::handle_key`].
#[derive(Debug, PartialEq, Eq)]
pub enum KeyReaction {
Consumed,
Submit,
Cancel,
Intercepted(crate::keys::key_combo::KeyCombo),
Unhandled,
}
pub struct SearchList<R: SearchRow> {
source: Arc<dyn RowSource<R>>,
rows: Vec<R>,
/// Indices into `rows` in display order (after filtering/ranking).
display: Vec<usize>,
/// A synthetic, query-fresh, filter-exempt row pinned at visible position 0
/// (the "Create: <q>" affordance / saved-searches virtual entry). Held
/// separately from `rows` so it works regardless of delivery (one-shot
/// `Replace` or streamed `Push`) and refreshes on every query change. See
/// [`RowSource::leading_row`].
leading: Option<R>,
/// Index into the VISIBLE sequence `[leading?] ++ display` of the selected
/// item.
selected: Option<usize>,
/// Viewport offset: visible position of the first row on screen. Owned
/// here (not by a per-frame `ListState`) so mouse-wheel scrolling can move
/// the viewport directly; `render` writes it back after ratatui clamps it
/// to keep the selection visible.
offset: usize,
filter: Filter<R>,
query: String,
loader: LoadEngine<R>,
input: SingleLineInput,
autocomplete: Option<AutocompleteController>,
/// Key combos the caller wants to intercept before the engine acts.
intercept: Vec<KeyCombo>,
icons: Icons,
list_rect: Rect,
/// The host panel's full bounds, for wheel hit-testing: scroll events
/// anywhere within it scroll the list — header, query box, preview —
/// while clicks still hit-test against `list_rect` only. Empty (the
/// default) falls back to `list_rect`, so hosts that never record it
/// keep scroll-over-the-list-only behavior.
panel_rect: Rect,
/// A host-owned scrollable sub-region within the panel (e.g. an expanded
/// note preview). Wheel events inside it are routed back to the host as
/// [`SearchMouse::ContentScrollUp`]/[`ContentScrollDown`] instead of
/// scrolling the list — the sub-region wins over `panel_rect`. Empty (the
/// default) means no sub-region; hosts re-record it every render so it is
/// never stale.
///
/// [`ContentScrollDown`]: SearchMouse::ContentScrollDown
content_rect: Rect,
/// Load generation whose rows are currently held. When a newer generation
/// (a requery / reload) delivers its first event, `poll` clears the stale
/// rows before applying it — required for streamed (`Push`) sources, which
/// would otherwise append onto a superseded load's rows.
applied_generation: u64,
/// Set when a SavedSearch suggestion was just accepted: the search's name,
/// for the host to pin as the saved-search breadcrumb. Read once via
/// [`take_accepted_saved_search`](Self::take_accepted_saved_search).
accepted_saved_search: Option<String>,
}
/// Mouse interaction result from [`SearchList::handle_mouse`].
#[derive(Debug, PartialEq, Eq)]
pub enum SearchMouse {
Selected(usize),
Activated(usize),
Scrolled,
/// The wheel landed inside the host's content sub-region (see
/// [`SearchList::set_content_rect`]); the host owns that view's scroll,
/// so the engine routed the event instead of moving the list.
ContentScrollUp,
ContentScrollDown,
None,
}
pub struct SearchListBuilder<R: SearchRow> {
source: Arc<dyn RowSource<R>>,
redraw: Arc<dyn Fn() + Send + Sync>,
initial_query: String,
filter: Filter<R>,
autocomplete: Option<(Arc<dyn SuggestionSource>, AutocompleteMode)>,
intercept: Vec<KeyCombo>,
icons: Icons,
debounce: Option<std::time::Duration>,
}
impl<R: SearchRow> SearchList<R> {
pub fn builder(
source: impl RowSource<R>,
redraw: Arc<dyn Fn() + Send + Sync>,
) -> SearchListBuilder<R> {
SearchListBuilder {
source: Arc::new(source),
redraw,
initial_query: String::new(),
filter: Filter::SourceOrder,
autocomplete: None,
intercept: Vec::new(),
icons: Icons::new(false),
debounce: None,
}
}
fn new(b: SearchListBuilder<R>) -> Self {
let mut loader = LoadEngine::new(b.redraw.clone());
loader.start(b.source.clone(), b.initial_query.clone());
let input = SingleLineInput::with_value(&b.initial_query);
let debounce = b.debounce;
let autocomplete = b.autocomplete.map(|(suggestions, mode)| {
let mut ac =
AutocompleteController::new(suggestions, mode).with_trigger_opts(TriggerOptions {
disambiguate_header: false,
apply_exclusion_zone: false,
// The controller derives `allow_saved_search` from its mode
// at detect time, so this seed value is not load-bearing.
..TriggerOptions::default()
});
if let Some(d) = debounce {
ac = ac.with_debounce(d);
}
ac.set_redraw_callback(b.redraw.clone());
ac
});
Self {
source: b.source,
rows: Vec::new(),
display: Vec::new(),
leading: None,
selected: None,
offset: 0,
filter: b.filter,
query: b.initial_query,
loader,
input,
autocomplete,
intercept: b.intercept,
icons: b.icons,
list_rect: Rect::default(),
panel_rect: Rect::default(),
content_rect: Rect::default(),
applied_generation: 0,
accepted_saved_search: None,
}
}
pub fn poll(&mut self) {
let drained = self.loader.drain();
if !drained.is_empty() {
// A newer load delivered its first event(s): drop the prior load's
// rows so a streamed source starts from a clean slate (one-shot
// `Replace` overwrites anyway, but `Push` would otherwise append).
let current_gen = self.loader.generation();
if current_gen != self.applied_generation {
self.rows.clear();
self.selected = None;
self.offset = 0;
self.applied_generation = current_gen;
}
}
for ev in drained {
match ev {
LoadedInner::Replace(rows) => {
self.rows = rows;
}
LoadedInner::Push(row) => {
self.rows.push(row);
}
LoadedInner::Done => {}
}
}
self.recompute_display();
if self.selected.is_none() && self.visible_len() > 0 {
self.selected = Some(0);
}
if let Some(ac) = &mut self.autocomplete {
ac.poll_results();
}
}
/// Build a host snapshot from the current input state.
/// Only reads `self.input` so the result can be stored in a local
/// before taking `&mut self.autocomplete`, resolving the borrow conflict.
fn autocomplete_snapshot(&self) -> host::SearchBoxHostSnapshot {
let value = self.input.value().to_string();
let cursor_byte = self.input.cursor_byte();
let col = value[..cursor_byte.min(value.len())].chars().count();
host::SearchBoxHostSnapshot {
lines: vec![value],
cursor: (0, col),
caret_pos: self.input.last_caret_pos(),
}
}
fn clamp_selection(&mut self) {
let len = self.visible_len();
self.selected = if len == 0 {
None
} else {
Some(self.selected.unwrap_or(0).min(len - 1))
};
}
/// `1` when a leading row is pinned at visible position 0, else `0`.
fn leading_offset(&self) -> usize {
self.leading.is_some() as usize
}
/// Length of the visible sequence `[leading?] ++ display`.
pub fn visible_len(&self) -> usize {
self.leading_offset() + self.display.len()
}
/// Row at visible position `pos` in `[leading?] ++ display`.
fn visible_row(&self, pos: usize) -> Option<&R> {
if self.leading.is_some() && pos == 0 {
self.leading.as_ref()
} else {
self.rows
.get(*self.display.get(pos - self.leading_offset())?)
}
}
/// The source-delivered rows only (NOT the leading row). Prefer
/// [`visible_len`](Self::visible_len)/[`visible_rows`](Self::visible_rows)
/// for visible counts.
pub fn rows(&self) -> &[R] {
&self.rows
}
pub fn selected_row(&self) -> Option<&R> {
self.selected.and_then(|p| self.visible_row(p))
}
pub fn visible_rows(&self) -> Vec<&R> {
(0..self.visible_len())
.filter_map(|p| self.visible_row(p))
.collect()
}
pub fn query(&self) -> &str {
&self.query
}
/// Take the name of a just-accepted saved search, if any. The host calls
/// this after a `Consumed` key to learn whether to pin (or refresh) the
/// saved-search breadcrumb. Returns `None` once read.
pub fn take_accepted_saved_search(&mut self) -> Option<String> {
self.accepted_saved_search.take()
}
/// The visible text in the query input widget. Test-only: lets callers
/// assert the input bar reflects a programmatic query change.
#[cfg(test)]
pub(crate) fn input_value(&self) -> &str {
self.input.value()
}
pub fn is_loading(&self) -> bool {
self.loader.loading
}
/// Set the query programmatically: updates the visible input widget (cursor
/// to end) AND the query string, then starts a load (for `reload_on_query`
/// sources) or recomputes the display. This is the setter every external
/// caller wants — a saved search applied, a sort directive rewritten — so
/// the input bar always reflects the query. The interactive keystroke path
/// uses [`sync_query_from_input`](Self::sync_query_from_input) instead,
/// because the input widget already holds the typed text (and its cursor
/// must not jump back to the end on every keystroke).
pub fn set_query(&mut self, q: impl Into<String>) {
let q = q.into();
self.input.set_value(q.clone());
self.query = q;
self.requery();
}
/// Pull the query string FROM the input widget without touching the widget
/// (so the cursor stays put), then reload/recompute. The keystroke and
/// autocomplete-accept paths use this after they have already mutated the
/// input in place.
fn sync_query_from_input(&mut self) {
self.query = self.input.value().to_string();
self.requery();
}
/// Start a fresh load for `reload_on_query` sources, else recompute the
/// local display. The generation guard in `LoadEngine` drops stale results.
fn requery(&mut self) {
if self.source.reload_on_query() {
self.loader.start(self.source.clone(), self.query.clone());
} else {
self.recompute_display();
}
}
/// Re-run the source load for the current query (e.g. after a mutation).
pub fn reload(&mut self) {
self.loader.start(self.source.clone(), self.query.clone());
}
pub fn select_next(&mut self) {
let n = self.visible_len();
if n == 0 {
return;
}
self.selected = Some(self.selected.map_or(0, |i| (i + 1).min(n - 1)));
}
pub fn select_prev(&mut self) {
if self.visible_len() == 0 {
return;
}
self.selected = Some(self.selected.map_or(0, |i| i.saturating_sub(1)));
}
/// Largest useful viewport offset: the first visible position from which
/// the rows through the end still fill the recorded list rect. Scrolling
/// past it would leave blank space below the last row, so
/// [`scroll_down`](Self::scroll_down) clamps to it.
fn max_scroll_offset(&self) -> usize {
let viewport = self.list_rect.height as usize;
let n = self.visible_len();
if viewport == 0 || n == 0 {
return 0;
}
let mut budget = viewport;
let mut first = n;
while first > 0 {
let h = self
.visible_row(first - 1)
.map(|r| r.visual_height() as usize)
.unwrap_or(1);
if h > budget {
break;
}
budget -= h;
first -= 1;
}
first.min(n - 1)
}
/// Scroll the viewport one row down, carrying the selection along so the
/// selected row keeps its on-screen position. No-op once the last row is
/// in view — the shared mouse-wheel behavior for every list surface.
pub fn scroll_down(&mut self) {
let n = self.visible_len();
if n == 0 || self.offset >= self.max_scroll_offset() {
return;
}
self.offset += 1;
self.selected = self.selected.map(|i| (i + 1).min(n - 1));
}
/// Scroll the viewport one row up, carrying the selection along so the
/// selected row keeps its on-screen position. No-op at the top.
pub fn scroll_up(&mut self) {
if self.offset == 0 {
return;
}
self.offset -= 1;
self.selected = self.selected.map(|i| i.saturating_sub(1));
}
/// The current viewport offset. Test-only: lets scroll tests assert the
/// viewport moved while the selection kept its screen position.
#[cfg(test)]
pub(crate) fn scroll_offset(&self) -> usize {
self.offset
}
pub fn handle_key(&mut self, key: &KeyEvent) -> KeyReaction {
use ratatui::crossterm::event::{KeyCode, KeyModifiers};
// Caller-registered intercepts get first crack — before autocomplete or
// any built-in binding.
if let Some(combo) = crate::keys::key_event_to_combo(key)
&& self.intercept.contains(&combo)
{
return KeyReaction::Intercepted(combo);
}
// Autocomplete popup gets first crack when open. Build snapshot before
// taking &mut self.autocomplete to avoid borrow-checker conflict
// (snapshot only reads self.input).
if self.autocomplete.as_ref().is_some_and(|ac| ac.is_open()) {
let snap = self.autocomplete_snapshot();
if let Some(ac) = &mut self.autocomplete {
match ac.handle_key(*key, &snap) {
HandleKeyOutcome::Accepted(action) => {
self.input.replace_range_bytes(
action.range.clone(),
&action.new_text,
action.new_cursor_byte,
);
// Stash any accepted SavedSearch name for the host's
// breadcrumb (`None` for every other kind). The host
// reads it on this same `Consumed`, so a plain assign
// never clobbers an unread value.
self.accepted_saved_search = action.saved_search_name;
self.sync_query_from_input();
return KeyReaction::Consumed;
}
HandleKeyOutcome::Dismissed | HandleKeyOutcome::Consumed => {
return KeyReaction::Consumed;
}
HandleKeyOutcome::NotHandled => {}
}
}
}
match key.code {
KeyCode::Up => {
self.select_prev();
return KeyReaction::Consumed;
}
KeyCode::Down => {
self.select_next();
return KeyReaction::Consumed;
}
KeyCode::Enter => return KeyReaction::Submit,
KeyCode::Esc => return KeyReaction::Cancel,
_ => {}
}
// Drop Ctrl/Alt-modified chars so combos don't leak as text.
if let KeyCode::Char(_) = key.code {
let non_shift = key.modifiers - KeyModifiers::SHIFT;
if !non_shift.is_empty() {
return KeyReaction::Unhandled;
}
}
let outcome = self.input.handle_key(key);
// Sync/refresh/close the autocomplete popup based on the input outcome.
// Build snapshot before taking &mut self.autocomplete (same borrow trick).
let snap = self.autocomplete_snapshot();
match outcome {
InputOutcome::Changed => {
if let Some(ac) = &mut self.autocomplete {
ac.sync(&snap);
}
}
InputOutcome::Consumed => {
if let Some(ac) = &mut self.autocomplete {
ac.refresh_if_open(&snap);
}
}
InputOutcome::Cancel | InputOutcome::Submit => {
if let Some(ac) = &mut self.autocomplete {
ac.close();
}
}
InputOutcome::NotConsumed => {}
}
match outcome {
InputOutcome::Changed => {
self.sync_query_from_input();
KeyReaction::Consumed
}
InputOutcome::Consumed => KeyReaction::Consumed,
InputOutcome::Submit => KeyReaction::Submit,
InputOutcome::Cancel => KeyReaction::Cancel,
InputOutcome::NotConsumed => KeyReaction::Unhandled,
}
}
pub fn render_query(&mut self, f: &mut Frame, area: Rect, theme: &Theme, focused: bool) {
self.input.render(
f,
area,
Style::default()
.fg(theme.fg.to_ratatui())
.bg(theme.bg_panel.to_ratatui()),
0,
focused,
);
}
pub fn render(&mut self, f: &mut Frame, area: Rect, theme: &Theme, focused: bool) {
self.poll();
let sel = self.selected;
let items: Vec<ListItem> = (0..self.visible_len())
.filter_map(|pos| {
self.visible_row(pos)
.map(|r| r.to_list_item(theme, &self.icons, sel == Some(pos)))
})
.collect();
let mut state = ListState::default().with_offset(self.offset);
state.select(self.selected);
let list =
List::new(items).highlight_style(Style::default().bg(theme.bg_selected.to_ratatui()));
f.render_stateful_widget(list, area, &mut state);
// Read the offset back: ratatui clamps it and keeps the selection in
// view (keyboard moves included), so the stored offset always matches
// what is actually on screen.
self.offset = state.offset();
self.list_rect = area;
let _ = focused;
}
/// Override the rect used for mouse hit-testing. The recorded rect must be
/// the area where list ITEMS actually render — row 0 is the first item, NOT
/// a block border. Hosts that draw the list inside a bordered block pass the
/// block's INNER rect; borderless hosts pass the list area directly. The
/// recorded rect and the rendered-items rect MUST be identical, so
/// [`handle_mouse`] maps a click at `row` to visual offset `row - rect.y`.
///
/// [`handle_mouse`]: Self::handle_mouse
pub fn set_list_rect(&mut self, rect: Rect) {
self.list_rect = rect;
}
/// Record the host panel's full bounds so the wheel scrolls the list from
/// anywhere within the panel — header, query box, preview — not just over
/// the list items. Hosts call this each render with the same rect they
/// were drawn into. Never set = wheel hit-tests `list_rect` only.
pub fn set_panel_rect(&mut self, rect: Rect) {
self.panel_rect = rect;
}
/// Record a host-owned scrollable sub-region (e.g. an expanded preview):
/// wheel events inside it are routed back to the host as
/// [`SearchMouse::ContentScrollUp`]/[`ContentScrollDown`] instead of
/// scrolling the list. Hosts re-record it every render (empty when the
/// sub-region is not drawn) so the hit-test never sees a stale rect.
///
/// [`ContentScrollDown`]: SearchMouse::ContentScrollDown
pub fn set_content_rect(&mut self, rect: Rect) {
self.content_rect = rect;
}
/// Test-only: the recorded content sub-region (empty when none is on
/// screen), so host tests can hit-test against where the preview was
/// drawn.
#[cfg(test)]
pub(crate) fn content_rect(&self) -> Rect {
self.content_rect
}
pub fn render_autocomplete(&mut self, f: &mut Frame, clamp: Rect, theme: &Theme) {
if let Some(ac) = &mut self.autocomplete {
ac.poll_results();
let caret = self.input.last_caret_pos();
if let (Some(state), Some(anchor)) = (ac.state_mut(), caret) {
state.anchor = anchor;
}
if let Some(state) = ac.state() {
crate::components::autocomplete::render(f, state, clamp, theme);
}
}
}
/// Close an open autocomplete popup. [`handle_mouse`] does this for every
/// event it sees ("any mouse interaction dismisses the popup"); hosts that
/// consume a mouse event WITHOUT routing it through the engine call this
/// to keep that rule intact.
///
/// [`handle_mouse`]: Self::handle_mouse
pub fn close_autocomplete(&mut self) {
if let Some(ac) = &mut self.autocomplete {
ac.close();
}
}
/// Test-only: true when the autocomplete popup is open, so host tests
/// can assert the any-mouse-interaction-dismisses rule.
#[cfg(test)]
pub(crate) fn autocomplete_is_open(&self) -> bool {
self.autocomplete.as_ref().is_some_and(|ac| ac.is_open())
}
pub fn handle_mouse(&mut self, m: &ratatui::crossterm::event::MouseEvent) -> SearchMouse {
use ratatui::crossterm::event::{MouseButton, MouseEventKind};
use ratatui::layout::Position;
// Any mouse interaction dismisses an open autocomplete popup (matches
// the old modal: a click on the preview/border closes a stale popup).
self.close_autocomplete();
let pos = Position {
x: m.column,
y: m.row,
};
// The wheel is hit-tested against the host's panel bounds (when
// recorded), so scrolling works from anywhere within the panel;
// clicks below keep hit-testing the list rect only.
if matches!(
m.kind,
MouseEventKind::ScrollUp | MouseEventKind::ScrollDown
) {
// The host's content sub-region wins over the panel bounds: a
// wheel inside it is the host's to handle (it scrolls its own
// view), so route it back instead of moving the list.
if !self.content_rect.is_empty() && self.content_rect.contains(pos) {
return if m.kind == MouseEventKind::ScrollUp {
SearchMouse::ContentScrollUp
} else {
SearchMouse::ContentScrollDown
};
}
let bounds = if self.panel_rect.is_empty() {
self.list_rect
} else {
self.panel_rect
};
if !bounds.contains(pos) {
return SearchMouse::None;
}
if m.kind == MouseEventKind::ScrollUp {
self.scroll_up();
} else {
self.scroll_down();
}
return SearchMouse::Scrolled;
}
let r = self.list_rect;
if !r.contains(pos) {
return SearchMouse::None;
}
match m.kind {
MouseEventKind::Down(MouseButton::Left) if m.row >= r.y => {
let target_visual = m.row - r.y; // 0-based visual offset; row 0 = first item
let mut acc: u16 = 0;
let mut hit: Option<usize> = None;
// Walk the VISIBLE sequence (leading row at position 0, then the
// display rows) starting at the viewport offset — screen row 0
// is the item at `offset`, not visible position 0 — so visual
// offsets map to the positions actually on screen.
for pos in self.offset..self.visible_len() {
let h = self
.visible_row(pos)
.map(|r| r.visual_height())
.unwrap_or(1);
if target_visual < acc + h {
hit = Some(pos);
break;
}
acc += h;
}
if let Some(pos) = hit {
let prev = self.selected;
self.selected = Some(pos);
return if prev == Some(pos) {
SearchMouse::Activated(pos)
} else {
SearchMouse::Selected(pos)
};
}
SearchMouse::None
}
_ => SearchMouse::None,
}
}
fn recompute_display(&mut self) {
let q = self.query.trim();
// The leading row is query-fresh: rebuilt on every poll AND on every
// local-filter `set_query`, so it never goes stale.
self.leading = self.source.leading_row(q);
let mut idx: Vec<usize> = match &self.filter {
Filter::SourceOrder => (0..self.rows.len()).collect(),
Filter::Fuzzy if q.is_empty() => (0..self.rows.len()).collect(),
Filter::Fuzzy => fuzzy_indices(&self.rows, q),
Filter::Rank(_) if q.is_empty() => (0..self.rows.len()).collect(),
Filter::Rank(f) => {
let f = f.clone();
f(&self.rows, q)
}
};
// Filter-exempt rows (match_text() == None: Up / Create / virtual pinned)
// are always present; prepend any that the filter dropped.
for i in 0..self.rows.len() {
if self.rows[i].match_text().is_none() && !idx.contains(&i) {
idx.insert(0, i);
}
}
self.display = idx;
self.clamp_selection();
}
#[cfg(test)]
pub(crate) async fn poll_until_idle(&mut self) {
// In-memory sources settle on the first poll (no sleep paid). Vault-backed
// sources run their read on a worker/blocking thread, which can starve
// under the full parallel suite — so once still loading, sleep a little
// between polls and use a generous ceiling. Early-breaks the instant the
// load lands, keeping the common (in-memory) path fast.
for _ in 0..600 {
tokio::task::yield_now().await;
self.poll();
if !self.is_loading() {
break;
}
tokio::time::sleep(std::time::Duration::from_millis(2)).await;
}
self.poll();
}
}
impl<R: SearchRow> SearchListBuilder<R> {
pub fn initial_query(mut self, q: impl Into<String>) -> Self {
self.initial_query = q.into();
self
}
pub fn filter(mut self, f: Filter<R>) -> Self {
self.filter = f;
self
}
pub fn autocomplete(
mut self,
suggestions: Arc<dyn SuggestionSource>,
mode: AutocompleteMode,
) -> Self {
self.autocomplete = Some((suggestions, mode));
self
}
pub fn intercept(mut self, v: Vec<KeyCombo>) -> Self {
self.intercept = v;
self
}
pub fn icons(mut self, icons: Icons) -> Self {
self.icons = icons;
self
}
/// Override the autocomplete controller's debounce. Tests use
/// `Duration::ZERO` to get suggestions without waiting on the debounce timer.
pub fn debounce(mut self, d: std::time::Duration) -> Self {
self.debounce = Some(d);
self
}
pub fn build(self) -> SearchList<R> {
SearchList::new(self)
}
}
#[cfg(test)]
mod tests {
use super::adapters::{
ScriptedStreamLeadSource, ScriptedStreamSource, StreamRow, TestRow, VecSource,
VecSourceWithLead,
};
use super::*;
use ratatui::crossterm::event::{KeyCode, KeyEvent, KeyModifiers};
fn noop_redraw() -> std::sync::Arc<dyn Fn() + Send + Sync> {
std::sync::Arc::new(|| {})
}
fn key(c: KeyCode) -> KeyEvent {
KeyEvent::new(c, KeyModifiers::NONE)
}
fn mouse_down_at(col: u16, row: u16) -> ratatui::crossterm::event::MouseEvent {
use ratatui::crossterm::event::{MouseButton, MouseEvent, MouseEventKind};
MouseEvent {
kind: MouseEventKind::Down(MouseButton::Left),
column: col,
row,
modifiers: KeyModifiers::NONE,
}
}
#[derive(Clone, Debug, PartialEq)]
struct TallRow {
name: String,
height: u16,
}
impl SearchRow for TallRow {
fn to_list_item(
&self,
_t: &crate::settings::themes::Theme,
_i: &crate::settings::icons::Icons,
_s: bool,
) -> ratatui::widgets::ListItem<'static> {
ratatui::widgets::ListItem::new(self.name.clone())
}
fn visual_height(&self) -> u16 {
self.height
}
fn match_text(&self) -> Option<&str> {
Some(&self.name)
}
}
struct TallSource(Vec<TallRow>);
#[async_trait::async_trait]
impl RowSource<TallRow> for TallSource {
async fn load(&self, _q: &str, emit: Emit<TallRow>) {
emit.replace(self.0.clone());
}
}
/// The wheel is routed to the host (ContentScroll*) inside the recorded
/// content sub-region — which wins over the panel bounds — and scrolls
/// the list everywhere else within the panel.
#[tokio::test]
async fn wheel_in_content_rect_routes_to_host() {
use ratatui::crossterm::event::{MouseEvent, MouseEventKind};
let rows: Vec<TallRow> = (0..10)
.map(|i| TallRow {
name: format!("r{}", i),
height: 1,
})
.collect();
let mut list = SearchList::builder(TallSource(rows), noop_redraw()).build();
list.poll_until_idle().await;
let rect = |y: u16, h: u16| ratatui::layout::Rect {
x: 0,
y,
width: 20,
height: h,
};
// Panel covers rows 0..10; list draws in 0..4; content region 5..10.
list.set_panel_rect(rect(0, 10));
list.set_list_rect(rect(0, 4));
list.set_content_rect(rect(5, 5));
let wheel = |kind: MouseEventKind, row: u16| MouseEvent {
kind,
column: 2,
row,
modifiers: KeyModifiers::NONE,
};
// Inside the content region: routed to the host, list untouched.
let m = wheel(MouseEventKind::ScrollDown, 6);
assert_eq!(list.handle_mouse(&m), SearchMouse::ContentScrollDown);
assert_eq!(list.offset, 0, "list viewport must not move");
let m = wheel(MouseEventKind::ScrollUp, 6);
assert_eq!(list.handle_mouse(&m), SearchMouse::ContentScrollUp);
// Over the list (panel bounds, outside content): the list scrolls.
let m = wheel(MouseEventKind::ScrollDown, 2);
assert_eq!(list.handle_mouse(&m), SearchMouse::Scrolled);
// Cleared sub-region: the wheel falls back to the panel-wide scroll.
list.set_content_rect(ratatui::layout::Rect::default());
let m = wheel(MouseEventKind::ScrollDown, 6);
assert_eq!(list.handle_mouse(&m), SearchMouse::Scrolled);
}
#[tokio::test]
async fn mouse_maps_visual_row_to_display_index_by_height() {
// Row 0 occupies 3 visual rows, row 1 occupies 1. The recorded list rect
// is the rendered-items area: row 0 == the FIRST item (no border row).
let src = TallSource(vec![
TallRow {
name: "a".into(),
height: 3,
},
TallRow {
name: "b".into(),
height: 1,
},
]);
let mut list = SearchList::builder(src, noop_redraw()).build();
list.poll_until_idle().await;
// Force the recorded list rect (render not run in test): items start at y=0.
list.set_list_rect(ratatui::layout::Rect {
x: 0,
y: 0,
width: 20,
height: 10,
});
// "a" occupies rows 0..=2; row 3 is the FIRST row of "b".
let m = mouse_down_at(2, 3);
assert!(matches!(list.handle_mouse(&m), SearchMouse::Selected(1)));
assert_eq!(list.selected_row().unwrap().name, "b");
// A click at row 1 = within "a" (rows 0..=2) -> display index 0.
let m = mouse_down_at(2, 1);
list.handle_mouse(&m);
assert_eq!(list.selected_row().unwrap().name, "a");
}
// Mouse-wheel scrolling moves the VIEWPORT, carrying the selection along
// so the selected row keeps its on-screen position (selected - offset is
// invariant) — unlike keyboard navigation, which moves the selection.
#[tokio::test]
async fn scroll_moves_viewport_and_keeps_selection_screen_position() {
let src = VecSource {
rows: (0..10).map(|i| TestRow::new(&format!("row{i}"))).collect(),
reload: true,
};
let mut list = SearchList::builder(src, noop_redraw()).build();
list.poll_until_idle().await;
// Viewport shows 4 of the 10 rows.
list.set_list_rect(ratatui::layout::Rect {
x: 0,
y: 0,
width: 20,
height: 4,
});
// Move the selection to screen row 2 first.
list.select_next();
list.select_next();
assert_eq!(list.selected_row().unwrap().name, "row2");
let scroll = |kind| ratatui::crossterm::event::MouseEvent {
kind,
column: 1,
row: 1,
modifiers: KeyModifiers::NONE,
};
use ratatui::crossterm::event::MouseEventKind;
// Scroll down: viewport and selection move together.
assert_eq!(
list.handle_mouse(&scroll(MouseEventKind::ScrollDown)),
SearchMouse::Scrolled
);
assert_eq!(list.scroll_offset(), 1);
assert_eq!(list.selected_row().unwrap().name, "row3");
// Scroll back up: both return.
list.handle_mouse(&scroll(MouseEventKind::ScrollUp));
assert_eq!(list.scroll_offset(), 0);
assert_eq!(list.selected_row().unwrap().name, "row2");
// At the top, scrolling up is a no-op (selection does NOT move).
list.handle_mouse(&scroll(MouseEventKind::ScrollUp));
assert_eq!(list.scroll_offset(), 0);
assert_eq!(list.selected_row().unwrap().name, "row2");
// Scrolling down clamps once the last row is in view: 10 rows in a
// 4-row viewport → max offset 6.
for _ in 0..20 {
list.handle_mouse(&scroll(MouseEventKind::ScrollDown));
}
assert_eq!(list.scroll_offset(), 6);
assert_eq!(list.selected_row().unwrap().name, "row8");
// The selection kept its screen row through the clamped scroll.
// (row2 at offset 0 → screen row 2; row8 at offset 6 → screen row 2.)
}
// The wheel hit-tests the recorded PANEL rect: scrolling over the host's
// header/query box (outside the list rect) still scrolls the list. Without
// a panel rect it falls back to the list rect only.
#[tokio::test]
async fn scroll_hits_panel_rect_clicks_hit_list_rect() {
let src = VecSource {
rows: (0..10).map(|i| TestRow::new(&format!("row{i}"))).collect(),
reload: true,
};
let mut list = SearchList::builder(src, noop_redraw()).build();
list.poll_until_idle().await;
// List items render at y 5..9; the panel spans y 0..20.
list.set_list_rect(ratatui::layout::Rect {
x: 0,
y: 5,
width: 20,
height: 4,
});
let scroll_at = |row| ratatui::crossterm::event::MouseEvent {
kind: ratatui::crossterm::event::MouseEventKind::ScrollDown,
column: 1,
row,
modifiers: KeyModifiers::NONE,
};
// No panel rect: a scroll over the header (y=1) misses.
assert_eq!(list.handle_mouse(&scroll_at(1)), SearchMouse::None);
assert_eq!(list.scroll_offset(), 0);
list.set_panel_rect(ratatui::layout::Rect {
x: 0,
y: 0,
width: 20,
height: 20,
});
// With the panel rect, the same scroll-over-header scrolls the list.
assert_eq!(list.handle_mouse(&scroll_at(1)), SearchMouse::Scrolled);
assert_eq!(list.scroll_offset(), 1);
// Clicks still hit-test the LIST rect only: a click on the header
// (inside the panel, outside the list) selects nothing.
let before = list.selected_row().unwrap().name.clone();
assert_eq!(list.handle_mouse(&mouse_down_at(1, 1)), SearchMouse::None);
assert_eq!(list.selected_row().unwrap().name, before);
}
// Regression: the click hit-test must account for the viewport offset —
// after wheel scrolling, screen row 0 is the item at `offset`, not
// visible position 0.
#[tokio::test]
async fn click_after_scroll_selects_the_clicked_row() {
let src = VecSource {
rows: (0..10).map(|i| TestRow::new(&format!("row{i}"))).collect(),
reload: true,
};
let mut list = SearchList::builder(src, noop_redraw()).build();
list.poll_until_idle().await;
list.set_list_rect(ratatui::layout::Rect {
x: 0,
y: 0,
width: 20,
height: 4,
});
let scroll_down = ratatui::crossterm::event::MouseEvent {
kind: ratatui::crossterm::event::MouseEventKind::ScrollDown,
column: 1,
row: 1,
modifiers: KeyModifiers::NONE,
};
for _ in 0..3 {
list.handle_mouse(&scroll_down);
}
assert_eq!(list.scroll_offset(), 3);
// Screen row 2 shows visible position offset + 2 = 5.
assert!(matches!(
list.handle_mouse(&mouse_down_at(2, 2)),
SearchMouse::Selected(5)
));
assert_eq!(list.selected_row().unwrap().name, "row5");
// Screen row 0 shows the item at the offset itself.
list.handle_mouse(&mouse_down_at(2, 0));
assert_eq!(list.selected_row().unwrap().name, "row3");
}
#[tokio::test]
async fn initial_load_populates_rows() {
let src = VecSource {
rows: vec![TestRow::new("alpha"), TestRow::new("beta")],
reload: true,
};
let mut list = SearchList::builder(src, noop_redraw()).build();
list.poll_until_idle().await;
assert_eq!(list.rows().len(), 2);
assert_eq!(list.selected_row().map(|r| r.name.as_str()), Some("alpha"));
}
#[tokio::test]
async fn requery_supersedes_and_reloads() {
let src = VecSource {
rows: vec![
TestRow::new("alpha"),
TestRow::new("alps"),
TestRow::new("beta"),
],
reload: true,
};
let mut list = SearchList::builder(src, noop_redraw()).build();
list.poll_until_idle().await;
assert_eq!(list.rows().len(), 3);
list.set_query("alp");
list.poll_until_idle().await;
assert_eq!(list.rows().len(), 2); // alpha, alps
assert!(list.rows().iter().all(|r| r.name.contains("alp")));
}
#[tokio::test]
async fn arrows_navigate_and_enter_submits() {
let src = VecSource {
rows: vec![TestRow::new("a"), TestRow::new("b")],
reload: true,
};
let mut list = SearchList::builder(src, noop_redraw()).build();
list.poll_until_idle().await;
assert_eq!(list.handle_key(&key(KeyCode::Down)), KeyReaction::Consumed);
assert_eq!(list.selected_row().unwrap().name, "b");
assert_eq!(list.handle_key(&key(KeyCode::Enter)), KeyReaction::Submit);
assert_eq!(list.handle_key(&key(KeyCode::Esc)), KeyReaction::Cancel);
}
#[tokio::test]
async fn typing_a_char_changes_query() {
let src = VecSource {
rows: vec![TestRow::new("alpha"), TestRow::new("beta")],
reload: true,
};
let mut list = SearchList::builder(src, noop_redraw()).build();
list.poll_until_idle().await;
assert_eq!(
list.handle_key(&key(KeyCode::Char('a'))),
KeyReaction::Consumed
);
list.poll_until_idle().await;
assert_eq!(list.query(), "a");
}
#[tokio::test]
async fn rank_filter_orders_by_closure() {
let src = VecSource {
rows: vec![
TestRow::new("todo"),
TestRow::new("today"),
TestRow::new("misc"),
],
reload: false,
};
let rank = std::sync::Arc::new(|rows: &[TestRow], q: &str| -> Vec<usize> {
let mut idx: Vec<usize> = (0..rows.len())
.filter(|&i| rows[i].name.contains(q))
.collect();
idx.sort_by_key(|&i| if rows[i].name == q { 0 } else { 1 });
idx
});
let mut list = SearchList::builder(src, noop_redraw())
.filter(Filter::Rank(rank))
.build();
list.poll_until_idle().await;
list.set_query("today");
list.poll();
assert_eq!(list.selected_row().unwrap().name, "today");
}
#[tokio::test]
async fn fuzzy_filter_narrows_local_set() {
let src = VecSource {
rows: vec![TestRow::new("alpha"), TestRow::new("beta")],
reload: false,
};
let mut list = SearchList::builder(src, noop_redraw())
.filter(Filter::Fuzzy)
.build();
list.poll_until_idle().await;
list.set_query("alp");
list.poll();
assert_eq!(list.visible_rows().len(), 1);
assert_eq!(list.selected_row().unwrap().name, "alpha");
}
#[tokio::test]
async fn streamed_rows_arrive_then_done_and_filter_locally() {
let src = ScriptedStreamSource {
batches: vec![vec![TestRow::new("alpha")], vec![TestRow::new("beta")]],
};
let mut list = SearchList::builder(src, noop_redraw())
.filter(Filter::Fuzzy)
.build();
list.poll_until_idle().await;
assert_eq!(list.rows().len(), 2);
assert!(!list.is_loading());
list.set_query("alp");
list.poll();
assert_eq!(list.visible_rows().len(), 1);
}
#[tokio::test]
async fn source_order_unfiltered_passthrough() {
let src = VecSource {
rows: vec![TestRow::new("a"), TestRow::new("b")],
reload: true,
};
let mut list = SearchList::builder(src, noop_redraw()).build(); // default Filter::SourceOrder
list.poll_until_idle().await;
assert_eq!(list.visible_rows().len(), 2);
assert_eq!(list.selected_row().unwrap().name, "a");
}
#[tokio::test]
async fn intercepted_combo_returns_intercepted_without_acting() {
let src = VecSource {
rows: vec![TestRow::new("a")],
reload: true,
};
let combo = crate::keys::key_event_to_combo(&key(KeyCode::Enter)).unwrap();
let mut list = SearchList::builder(src, noop_redraw())
.intercept(vec![combo])
.build();
list.poll_until_idle().await;
// Enter is intercepted: engine returns Intercepted, does NOT submit/act.
assert_eq!(
list.handle_key(&key(KeyCode::Enter)),
KeyReaction::Intercepted(combo)
);
}
#[tokio::test]
async fn autocomplete_accept_rewrites_query_without_vault() {
struct Mem;
#[async_trait::async_trait]
impl crate::components::search_list::SuggestionSource for Mem {
async fn notes_by_prefix(
&self,
_p: &str,
_n: usize,
) -> Vec<crate::components::search_list::SuggestionItem> {
vec![]
}
async fn tags_by_prefix(
&self,
p: &str,
_n: usize,
) -> Vec<crate::components::search_list::SuggestionItem> {
if "projects".starts_with(p) {
vec![crate::components::search_list::SuggestionItem::plain(
"projects",
)]
} else {
vec![]
}
}
}
let src = VecSource {
rows: vec![],
reload: true,
};
let mut list = SearchList::builder(src, noop_redraw())
.autocomplete(
std::sync::Arc::new(Mem),
crate::components::autocomplete::AutocompleteMode::SearchQuery,
)
.debounce(std::time::Duration::ZERO)
.build();
for c in ['#', 'p', 'r', 'o'] {
let _ = list.handle_key(&key(KeyCode::Char(c)));
}
for _ in 0..50 {
tokio::task::yield_now().await;
list.poll();
}
let _ = list.handle_key(&key(KeyCode::Tab));
assert_eq!(list.query(), "#projects");
}
// Accepting a SavedSearch suggestion expands the whole field to the
// stored query AND exposes the accepted name (for the breadcrumb) via
// `take_accepted_saved_search`.
#[tokio::test]
async fn accepting_saved_search_expands_query_and_exposes_name() {
struct Mem;
#[async_trait::async_trait]
impl crate::components::search_list::SuggestionSource for Mem {
async fn notes_by_prefix(&self, _p: &str, _n: usize) -> Vec<SuggestionItem> {
vec![]
}
async fn tags_by_prefix(&self, _p: &str, _n: usize) -> Vec<SuggestionItem> {
vec![]
}
async fn saved_searches_by_prefix(&self, p: &str, _n: usize) -> Vec<SuggestionItem> {
if "todo-week".starts_with(p) {
vec![SuggestionItem {
display: "todo-week".into(),
secondary: Some("#todo ^modified".into()),
}]
} else {
vec![]
}
}
}
let src = VecSource {
rows: vec![],
reload: true,
};
let mut list = SearchList::builder(src, noop_redraw())
.autocomplete(
std::sync::Arc::new(Mem),
crate::components::autocomplete::AutocompleteMode::SearchQuery,
)
.debounce(std::time::Duration::ZERO)
.build();
for c in ['?', 't', 'o'] {
let _ = list.handle_key(&key(KeyCode::Char(c)));
}
for _ in 0..50 {
tokio::task::yield_now().await;
list.poll();
}
let _ = list.handle_key(&key(KeyCode::Tab));
// Whole field expanded to the stored query.
assert_eq!(list.query(), "#todo ^modified");
// The accepted name is exposed once, then cleared.
assert_eq!(
list.take_accepted_saved_search().as_deref(),
Some("todo-week")
);
assert_eq!(list.take_accepted_saved_search(), None);
}
// Regression: Enter (not just Tab) must accept an open autocomplete popup,
// and the engine must report Consumed — NOT Submit — so a host does not
// mistake the accept for a list submit. (A QueryPanel Enter pre-check used
// to swallow this, breaking accept-on-Enter in the right sidebar.)
#[tokio::test]
async fn enter_accepts_open_popup_and_reports_consumed() {
struct Mem;
#[async_trait::async_trait]
impl crate::components::search_list::SuggestionSource for Mem {
async fn notes_by_prefix(
&self,
_p: &str,
_n: usize,
) -> Vec<crate::components::search_list::SuggestionItem> {
vec![]
}
async fn tags_by_prefix(
&self,
p: &str,
_n: usize,
) -> Vec<crate::components::search_list::SuggestionItem> {
if "projects".starts_with(p) {
vec![crate::components::search_list::SuggestionItem::plain(
"projects",
)]
} else {
vec![]
}
}
}
let src = VecSource {
rows: vec![],
reload: true,
};
let mut list = SearchList::builder(src, noop_redraw())
.autocomplete(
std::sync::Arc::new(Mem),
crate::components::autocomplete::AutocompleteMode::SearchQuery,
)
.debounce(std::time::Duration::ZERO)
.build();
for c in ['#', 'p', 'r', 'o'] {
let _ = list.handle_key(&key(KeyCode::Char(c)));
}
for _ in 0..50 {
tokio::task::yield_now().await;
list.poll();
}
// Popup is open: Enter accepts the suggestion and reports Consumed.
assert_eq!(list.handle_key(&key(KeyCode::Enter)), KeyReaction::Consumed);
assert_eq!(list.query(), "#projects");
// Popup now closed: a second Enter falls through to Submit.
assert_eq!(list.handle_key(&key(KeyCode::Enter)), KeyReaction::Submit);
}
// Regression (P0): a STREAMED source (sidebar shape) supplies a query-fresh
// leading row. It must appear at visible position 0 even though rows arrive
// via Push (never Replace), be present when the query matches no streamed
// row, and refresh when the query changes (reload_on_query() == false).
#[tokio::test]
async fn streamed_source_leading_row_is_pinned_and_query_fresh() {
let src = ScriptedStreamLeadSource {
items: vec!["alpha".into(), "beta".into()],
};
let mut list = SearchList::builder(src, noop_redraw())
.filter(Filter::Fuzzy)
.initial_query("zz")
.build();
list.poll_until_idle().await;
// Leading present even though "zz" matches no streamed Item.
let vis = list.visible_rows();
assert_eq!(vis[0], &StreamRow::Create("zz".into()));
assert_eq!(list.visible_len(), 1); // just the leading; no Item matches
// Query-fresh: changing the query rebuilds the leading and re-filters.
list.set_query("alp");
list.poll();
let vis = list.visible_rows();
assert_eq!(vis[0], &StreamRow::Create("alp".into()));
assert_eq!(vis[1], &StreamRow::Item("alpha".into()));
assert_eq!(list.visible_len(), 2);
// Empty query: leading disappears, both Items show.
list.set_query("");
list.poll();
assert!(
list.visible_rows()
.iter()
.all(|r| matches!(r, StreamRow::Item(_)))
);
assert_eq!(list.visible_len(), 2);
}
// Regression guard for the saved-searches virtual entry: a one-shot
// (Replace) source with a leading row still pins it at position 0.
#[tokio::test]
async fn oneshot_source_leading_row_still_works() {
let src = VecSourceWithLead {
rows: vec![TestRow::new("alpha"), TestRow::new("beta")],
};
let mut list = SearchList::builder(src, noop_redraw())
.filter(Filter::Fuzzy)
.initial_query("alp")
.build();
list.poll_until_idle().await;
let vis = list.visible_rows();
assert_eq!(vis[0].name, "create:alp");
assert_eq!(vis[1].name, "alpha");
assert_eq!(list.visible_len(), 2);
}
// Selection walks the VISIBLE sequence: position 0 is the leading row, and
// select_next steps from the leading to the first real row.
#[tokio::test]
async fn selection_includes_leading_at_position_zero() {
let src = VecSourceWithLead {
rows: vec![TestRow::new("alpha"), TestRow::new("alps")],
};
let mut list = SearchList::builder(src, noop_redraw())
.filter(Filter::Fuzzy)
.initial_query("alp")
.build();
list.poll_until_idle().await;
// Auto-selected position 0 -> the leading.
assert_eq!(list.selected_row().unwrap().name, "create:alp");
list.handle_key(&key(KeyCode::Down));
assert_eq!(list.selected_row().unwrap().name, "alpha");
}
// A source with NO leading row has no off-by-one: visible_len == display.
#[tokio::test]
async fn no_leading_row_visible_len_matches_display() {
let src = VecSource {
rows: vec![TestRow::new("a"), TestRow::new("b")],
reload: true,
};
let mut list = SearchList::builder(src, noop_redraw()).build();
list.poll_until_idle().await;
assert_eq!(list.visible_len(), 2);
assert_eq!(list.visible_rows().len(), 2);
assert_eq!(list.selected_row().unwrap().name, "a");
}
}