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
//! Virtual text rendering infrastructure
//!
//! Provides a system for rendering virtual text that doesn't exist in the buffer.
//! Used for inlay hints (type annotations, parameter names), git blame headers, etc.
//!
//! Two types of virtual text are supported:
//! - **Inline**: Text inserted before/after a character (e.g., `: i32` type hints)
//! - **Line**: Full lines inserted above/below a position (e.g., git blame headers)
//!
//! Virtual text is rendered during the render phase by reading from VirtualTextManager.
//! The buffer content remains unchanged - we just inject extra styled text during rendering.
//!
//! ## Architecture
//!
//! This follows an Emacs-like model where:
//! 1. Plugins add virtual text in response to buffer changes (async, fire-and-forget)
//! 2. Virtual text is stored persistently with marker-based position tracking
//! 3. Render loop reads virtual text synchronously from memory (no async waiting)
//!
//! This ensures frame coherence: render always sees a consistent snapshot of virtual text.
use ratatui::style::{Color, Style};
use std::collections::HashMap;
use crate::model::marker::{MarkerId, MarkerList};
/// Position relative to the character at the marker position
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum VirtualTextPosition {
// ─── Inline positions (within a line) ───
/// Render before the character (e.g., parameter hints: `/*count=*/5`)
BeforeChar,
/// Render after the character (e.g., type hints: `x: i32`)
AfterChar,
// ─── Line positions (full lines) ───
/// Render as a full line ABOVE the line containing this position
/// Used for git blame headers, section separators, etc.
/// These lines do NOT get line numbers in the gutter.
LineAbove,
/// Render as a full line BELOW the line containing this position
/// Used for inline documentation, fold previews, etc.
/// These lines do NOT get line numbers in the gutter.
LineBelow,
}
impl VirtualTextPosition {
/// Returns true if this is a line-level position (LineAbove/LineBelow)
pub fn is_line(&self) -> bool {
matches!(self, Self::LineAbove | Self::LineBelow)
}
/// Returns true if this is an inline position (BeforeChar/AfterChar)
pub fn is_inline(&self) -> bool {
matches!(self, Self::BeforeChar | Self::AfterChar)
}
}
/// Namespace for grouping virtual texts (for efficient bulk removal).
/// Similar to OverlayNamespace - plugins create a namespace once and use it for all their virtual texts.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct VirtualTextNamespace(pub String);
impl VirtualTextNamespace {
/// Create a namespace from a string (for plugin registration)
pub fn from_string(s: String) -> Self {
Self(s)
}
/// Get the internal string representation
pub fn as_str(&self) -> &str {
&self.0
}
}
/// A piece of virtual text to render at a specific position
#[derive(Debug, Clone)]
pub struct VirtualText {
/// Marker tracking the position (auto-adjusts on edits)
pub marker_id: MarkerId,
/// Text to display (for LineAbove/LineBelow, this is the full line content)
pub text: String,
/// Fallback styling, used when the theme-key fields below are unset OR
/// the keys don't resolve in the active theme. The renderer composes
/// the final style by overlaying any resolved theme colours on top of
/// this fallback (see [`VirtualText::resolved_style`]).
pub style: Style,
/// Optional theme key for the foreground colour (e.g.
/// `"editor.line_number_fg"`). Resolved on every render so the line
/// follows live theme changes.
pub fg_theme_key: Option<String>,
/// Optional theme key for the background colour.
pub bg_theme_key: Option<String>,
/// Where to render relative to the marker position
pub position: VirtualTextPosition,
/// Priority for ordering multiple items at same position (higher = later)
pub priority: i32,
/// Optional string identifier for this virtual text (for plugin use)
pub string_id: Option<String>,
/// Optional namespace for bulk removal (like Overlay's namespace)
pub namespace: Option<VirtualTextNamespace>,
/// Optional gutter glyph rendered in the line-number column on the
/// FIRST visual row of this virtual line. Subsequent wrapped rows
/// keep a blank gutter. `None` (the default) renders blank, which
/// matches the legacy behaviour. Used by `live_diff` to place "-"
/// directly on the deletion line itself instead of the source
/// line that happens to follow it.
pub gutter_glyph: Option<String>,
/// Foreground color for `gutter_glyph`. Falls back to
/// `theme.line_number_fg` when `None`.
pub gutter_color: Option<Color>,
/// Per-range modifier overlays applied on top of the base fg/bg.
/// Offsets are byte offsets within `text`. Used e.g. by live-diff
/// to bold + underline removed words on deletion virtual lines.
pub text_overlays: Vec<fresh_core::api::VirtualLineTextOverlay>,
}
impl VirtualText {
/// Resolve the on-screen `Style` for this entry against a live theme.
///
/// Theme keys take precedence over the fallback `style`'s fg/bg. If a
/// key fails to resolve (e.g. the theme doesn't define it), the
/// fallback colour is kept. Modifiers from `style` (bold/italic/etc.)
/// always survive.
pub fn resolved_style(&self, theme: &crate::view::theme::Theme) -> Style {
let mut style = self.style;
if let Some(ref key) = self.fg_theme_key {
if let Some(color) = theme.resolve_theme_key(key) {
style = style.fg(color);
}
}
if let Some(ref key) = self.bg_theme_key {
if let Some(color) = theme.resolve_theme_key(key) {
style = style.bg(color);
}
}
style
}
}
/// Unique identifier for a virtual text entry
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct VirtualTextId(pub u64);
/// Manages virtual text entries for a buffer
///
/// Uses the marker system for position tracking, so virtual text automatically
/// adjusts when the buffer is edited.
pub struct VirtualTextManager {
/// Map from virtual text ID to virtual text entry
texts: HashMap<VirtualTextId, VirtualText>,
/// Next ID to assign
next_id: u64,
/// Monotonic version, bumped on every mutation. Folded into
/// `pipeline_inputs_version` so that adding / removing virtual
/// lines (e.g. markdown_compose's table borders) invalidates
/// `LineWrapCache` / `VisualRowIndex` entries — same mechanism
/// `SoftBreakManager` and `ConcealManager` use.
version: u32,
}
impl VirtualTextManager {
/// Create a new empty manager
pub fn new() -> Self {
Self {
texts: HashMap::new(),
next_id: 0,
version: 0,
}
}
/// Monotonic version. Increments on every mutation to virtual text
/// state. Used by `pipeline_inputs_version` to invalidate scroll-math
/// caches keyed off `EditorState`.
#[inline]
pub fn version(&self) -> u32 {
self.version
}
#[inline]
fn bump_version(&mut self) {
self.version = self.version.wrapping_add(1);
}
/// Add a virtual text entry
///
/// # Arguments
/// * `marker_list` - The marker list to create a position marker in
/// * `position` - Byte offset in the buffer
/// * `text` - Text to display
/// * `style` - Styling for the text
/// * `vtext_position` - Whether to render before or after the character
/// * `priority` - Ordering priority (higher = later in render order)
///
/// # Returns
/// The ID of the created virtual text entry
pub fn add(
&mut self,
marker_list: &mut MarkerList,
position: usize,
text: String,
style: Style,
vtext_position: VirtualTextPosition,
priority: i32,
) -> VirtualTextId {
// Create marker at position
// Use right affinity (false) so the marker stays with the following character
let marker_id = marker_list.create(position, false);
let id = VirtualTextId(self.next_id);
self.next_id += 1;
self.texts.insert(
id,
VirtualText {
marker_id,
text,
style,
fg_theme_key: None,
bg_theme_key: None,
position: vtext_position,
priority,
string_id: None,
namespace: None,
gutter_glyph: None,
gutter_color: None,
text_overlays: Vec::new(),
},
);
self.bump_version();
id
}
/// Add an inline virtual text entry whose foreground/background colours
/// are stored as theme keys (resolved at render time so theme changes
/// apply live).
///
/// `style` is the fallback used when a theme key fails to resolve;
/// `fg_theme_key` / `bg_theme_key` are the keys passed to
/// `Theme::resolve_theme_key` (e.g. `"editor.line_number_fg"`).
#[allow(clippy::too_many_arguments)]
pub fn add_with_theme_keys(
&mut self,
marker_list: &mut MarkerList,
position: usize,
text: String,
style: Style,
fg_theme_key: Option<String>,
bg_theme_key: Option<String>,
vtext_position: VirtualTextPosition,
priority: i32,
) -> VirtualTextId {
debug_assert!(
vtext_position.is_inline(),
"add_with_theme_keys requires BeforeChar or AfterChar"
);
let marker_id = marker_list.create(position, false);
let id = VirtualTextId(self.next_id);
self.next_id += 1;
self.texts.insert(
id,
VirtualText {
marker_id,
text,
style,
fg_theme_key,
bg_theme_key,
position: vtext_position,
priority,
string_id: None,
namespace: None,
gutter_glyph: None,
gutter_color: None,
text_overlays: Vec::new(),
},
);
self.bump_version();
id
}
/// Add a virtual text entry with a string identifier
///
/// This is useful for plugins that need to track and remove virtual texts by name.
#[allow(clippy::too_many_arguments)]
pub fn add_with_id(
&mut self,
marker_list: &mut MarkerList,
position: usize,
text: String,
style: Style,
vtext_position: VirtualTextPosition,
priority: i32,
string_id: String,
) -> VirtualTextId {
let marker_id = marker_list.create(position, false);
let id = VirtualTextId(self.next_id);
self.next_id += 1;
self.texts.insert(
id,
VirtualText {
marker_id,
text,
style,
fg_theme_key: None,
bg_theme_key: None,
position: vtext_position,
priority,
string_id: Some(string_id),
namespace: None,
gutter_glyph: None,
gutter_color: None,
text_overlays: Vec::new(),
},
);
self.bump_version();
id
}
/// String-id form of [`add_with_theme_keys`] — same as
/// [`add_with_id`] but stores theme keys for live theme updates.
#[allow(clippy::too_many_arguments)]
pub fn add_with_id_and_theme_keys(
&mut self,
marker_list: &mut MarkerList,
position: usize,
text: String,
style: Style,
fg_theme_key: Option<String>,
bg_theme_key: Option<String>,
vtext_position: VirtualTextPosition,
priority: i32,
string_id: String,
) -> VirtualTextId {
debug_assert!(
vtext_position.is_inline(),
"add_with_id_and_theme_keys requires BeforeChar or AfterChar"
);
let marker_id = marker_list.create(position, false);
let id = VirtualTextId(self.next_id);
self.next_id += 1;
self.texts.insert(
id,
VirtualText {
marker_id,
text,
style,
fg_theme_key,
bg_theme_key,
position: vtext_position,
priority,
string_id: Some(string_id),
namespace: None,
gutter_glyph: None,
gutter_color: None,
text_overlays: Vec::new(),
},
);
id
}
/// Add a virtual line (LineAbove or LineBelow) with namespace for bulk removal
///
/// This is the primary API for features like git blame headers.
///
/// # Arguments
/// * `marker_list` - The marker list to create a position marker in
/// * `position` - Byte offset in the buffer (anchors the line to this position)
/// * `text` - Full line content to display
/// * `style` - Styling for the line
/// * `placement` - LineAbove or LineBelow
/// * `namespace` - Namespace for bulk removal (e.g., "git-blame")
/// * `priority` - Ordering when multiple lines at same position
#[allow(clippy::too_many_arguments)]
pub fn add_line(
&mut self,
marker_list: &mut MarkerList,
position: usize,
text: String,
style: Style,
placement: VirtualTextPosition,
namespace: VirtualTextNamespace,
priority: i32,
) -> VirtualTextId {
self.add_line_with_theme_keys(
marker_list,
position,
text,
style,
None,
None,
placement,
namespace,
priority,
None,
None,
Vec::new(),
)
}
/// Add a virtual line whose foreground/background colours are stored
/// as theme keys (resolved at render time so theme changes apply
/// live).
///
/// `style` is the fallback used when a theme key fails to resolve;
/// `fg_theme_key` / `bg_theme_key` are the keys passed to
/// `Theme::resolve_theme_key` (e.g. `"editor.line_number_fg"`).
#[allow(clippy::too_many_arguments)]
pub fn add_line_with_theme_keys(
&mut self,
marker_list: &mut MarkerList,
position: usize,
text: String,
style: Style,
fg_theme_key: Option<String>,
bg_theme_key: Option<String>,
placement: VirtualTextPosition,
namespace: VirtualTextNamespace,
priority: i32,
gutter_glyph: Option<String>,
gutter_color: Option<Color>,
text_overlays: Vec<fresh_core::api::VirtualLineTextOverlay>,
) -> VirtualTextId {
debug_assert!(
placement.is_line(),
"add_line requires LineAbove or LineBelow"
);
let marker_id = marker_list.create(position, false);
let id = VirtualTextId(self.next_id);
self.next_id += 1;
self.texts.insert(
id,
VirtualText {
marker_id,
text,
style,
fg_theme_key,
bg_theme_key,
position: placement,
priority,
string_id: None,
namespace: Some(namespace),
gutter_glyph,
gutter_color,
text_overlays,
},
);
self.bump_version();
id
}
/// Remove a virtual text entry by its string identifier
pub fn remove_by_id(&mut self, marker_list: &mut MarkerList, string_id: &str) -> bool {
// Find the entry with matching string_id
let to_remove: Vec<VirtualTextId> = self
.texts
.iter()
.filter_map(|(id, vtext)| {
if vtext.string_id.as_deref() == Some(string_id) {
Some(*id)
} else {
None
}
})
.collect();
let mut removed = false;
for id in to_remove {
if let Some(vtext) = self.texts.remove(&id) {
marker_list.delete(vtext.marker_id);
removed = true;
}
}
if removed {
self.bump_version();
}
removed
}
/// Remove all virtual text entries whose string_id starts with the given prefix
pub fn remove_by_prefix(&mut self, marker_list: &mut MarkerList, prefix: &str) {
// Collect markers to delete
let markers_to_delete: Vec<(VirtualTextId, MarkerId)> = self
.texts
.iter()
.filter_map(|(id, vtext)| {
if let Some(ref sid) = vtext.string_id {
if sid.starts_with(prefix) {
return Some((*id, vtext.marker_id));
}
}
None
})
.collect();
// Delete markers and remove entries
let removed = !markers_to_delete.is_empty();
for (id, marker_id) in markers_to_delete {
marker_list.delete(marker_id);
self.texts.remove(&id);
}
if removed {
self.bump_version();
}
}
/// Remove a virtual text entry
pub fn remove(&mut self, marker_list: &mut MarkerList, id: VirtualTextId) -> bool {
if let Some(vtext) = self.texts.remove(&id) {
marker_list.delete(vtext.marker_id);
self.bump_version();
true
} else {
false
}
}
/// Clear all virtual text entries
pub fn clear(&mut self, marker_list: &mut MarkerList) {
let was_non_empty = !self.texts.is_empty();
for vtext in self.texts.values() {
marker_list.delete(vtext.marker_id);
}
self.texts.clear();
if was_non_empty {
self.bump_version();
}
}
/// Remove all virtual text entries whose marker position lies within the
/// half-open byte range `[start, end)`.
///
/// This must be called BEFORE the underlying buffer/marker list is
/// adjusted for a deletion, otherwise the affected markers will already
/// have been clamped to the deletion start and appear to fall outside
/// the range. Used by the editor to drop stale inlay hints whose
/// anchors have been erased by the user (a fresh LSP response will
/// repopulate them if still applicable).
///
/// Returns the number of entries removed.
pub fn remove_in_range(
&mut self,
marker_list: &mut MarkerList,
start: usize,
end: usize,
) -> usize {
if start >= end {
return 0;
}
let to_remove: Vec<VirtualTextId> = self
.texts
.iter()
.filter_map(|(id, vtext)| {
let pos = marker_list.get_position(vtext.marker_id)?;
if pos >= start && pos < end {
Some(*id)
} else {
None
}
})
.collect();
let count = to_remove.len();
for id in to_remove {
if let Some(vtext) = self.texts.remove(&id) {
marker_list.delete(vtext.marker_id);
}
}
if count > 0 {
self.bump_version();
}
count
}
/// Get the number of virtual text entries
pub fn len(&self) -> usize {
self.texts.len()
}
/// Check if there are no virtual text entries
pub fn is_empty(&self) -> bool {
self.texts.is_empty()
}
/// Query virtual texts in a byte range
///
/// Returns a vector of (byte_position, &VirtualText) pairs, sorted by:
/// 1. Byte position (ascending)
/// 2. Priority (ascending, so higher priority renders later)
///
/// # Arguments
/// * `marker_list` - The marker list to query positions from
/// * `start` - Start byte offset (inclusive)
/// * `end` - End byte offset (exclusive)
pub fn query_range(
&self,
marker_list: &MarkerList,
start: usize,
end: usize,
) -> Vec<(usize, &VirtualText)> {
let mut results: Vec<(usize, &VirtualText)> = self
.texts
.values()
.filter_map(|vtext| {
let pos = marker_list.get_position(vtext.marker_id)?;
if pos >= start && pos < end {
Some((pos, vtext))
} else {
None
}
})
.collect();
// Sort by position, then by priority
results.sort_by(|a, b| a.0.cmp(&b.0).then_with(|| a.1.priority.cmp(&b.1.priority)));
results
}
/// Build a lookup map for efficient per-character access during rendering
///
/// Returns a HashMap where keys are byte positions and values are vectors
/// of virtual texts at that position, sorted by priority.
pub fn build_lookup(
&self,
marker_list: &MarkerList,
start: usize,
end: usize,
) -> HashMap<usize, Vec<&VirtualText>> {
let mut lookup: HashMap<usize, Vec<&VirtualText>> = HashMap::new();
for vtext in self.texts.values() {
if let Some(pos) = marker_list.get_position(vtext.marker_id) {
if pos >= start && pos < end {
lookup.entry(pos).or_default().push(vtext);
}
}
}
// Sort each position's texts by priority
for texts in lookup.values_mut() {
texts.sort_by_key(|vt| vt.priority);
}
lookup
}
/// Clear all virtual texts in a namespace
///
/// This is the primary way plugins remove their virtual texts (e.g., before updating blame data).
pub fn clear_namespace(
&mut self,
marker_list: &mut MarkerList,
namespace: &VirtualTextNamespace,
) {
let to_remove: Vec<VirtualTextId> = self
.texts
.iter()
.filter_map(|(id, vtext)| {
if vtext.namespace.as_ref() == Some(namespace) {
Some(*id)
} else {
None
}
})
.collect();
let removed = !to_remove.is_empty();
for id in to_remove {
if let Some(vtext) = self.texts.remove(&id) {
marker_list.delete(vtext.marker_id);
}
}
if removed {
self.bump_version();
}
}
/// Query only virtual LINES (LineAbove/LineBelow) in a byte range
///
/// Used by the render pipeline to inject header/footer lines.
/// Returns (byte_position, &VirtualText) pairs sorted by position then priority.
pub fn query_lines_in_range(
&self,
marker_list: &MarkerList,
start: usize,
end: usize,
) -> Vec<(usize, &VirtualText)> {
let mut results: Vec<(usize, &VirtualText)> = self
.texts
.values()
.filter(|vtext| vtext.position.is_line())
.filter_map(|vtext| {
let pos = marker_list.get_position(vtext.marker_id)?;
if pos >= start && pos < end {
Some((pos, vtext))
} else {
None
}
})
.collect();
// Sort by position, then by priority
results.sort_by(|a, b| a.0.cmp(&b.0).then_with(|| a.1.priority.cmp(&b.1.priority)));
results
}
/// Query only INLINE virtual texts (BeforeChar/AfterChar) in a byte range
///
/// Used by the render pipeline to inject inline hints.
pub fn query_inline_in_range(
&self,
marker_list: &MarkerList,
start: usize,
end: usize,
) -> Vec<(usize, &VirtualText)> {
let mut results: Vec<(usize, &VirtualText)> = self
.texts
.values()
.filter(|vtext| vtext.position.is_inline())
.filter_map(|vtext| {
let pos = marker_list.get_position(vtext.marker_id)?;
if pos >= start && pos < end {
Some((pos, vtext))
} else {
None
}
})
.collect();
// Sort by position, then by priority
results.sort_by(|a, b| a.0.cmp(&b.0).then_with(|| a.1.priority.cmp(&b.1.priority)));
results
}
/// Build a lookup map for virtual LINES, keyed by the line's anchor byte position
///
/// For each source line, the renderer can quickly check if there are
/// LineAbove or LineBelow virtual texts anchored to positions within that line.
pub fn build_lines_lookup(
&self,
marker_list: &MarkerList,
start: usize,
end: usize,
) -> HashMap<usize, Vec<&VirtualText>> {
let mut lookup: HashMap<usize, Vec<&VirtualText>> = HashMap::new();
for vtext in self.texts.values() {
if !vtext.position.is_line() {
continue;
}
if let Some(pos) = marker_list.get_position(vtext.marker_id) {
if pos >= start && pos < end {
lookup.entry(pos).or_default().push(vtext);
}
}
}
// Sort each position's texts by priority
for texts in lookup.values_mut() {
texts.sort_by_key(|vt| vt.priority);
}
lookup
}
}
impl Default for VirtualTextManager {
fn default() -> Self {
Self::new()
}
}
#[cfg(test)]
mod tests {
use super::*;
use ratatui::style::Color;
fn hint_style() -> Style {
Style::default().fg(Color::DarkGray)
}
#[test]
fn test_new_manager() {
let manager = VirtualTextManager::new();
assert_eq!(manager.len(), 0);
assert!(manager.is_empty());
}
#[test]
fn test_add_virtual_text() {
let mut marker_list = MarkerList::new();
let mut manager = VirtualTextManager::new();
let id = manager.add(
&mut marker_list,
10,
": i32".to_string(),
hint_style(),
VirtualTextPosition::AfterChar,
0,
);
assert_eq!(manager.len(), 1);
assert!(!manager.is_empty());
assert_eq!(id.0, 0);
}
#[test]
fn test_remove_virtual_text() {
let mut marker_list = MarkerList::new();
let mut manager = VirtualTextManager::new();
let id = manager.add(
&mut marker_list,
10,
": i32".to_string(),
hint_style(),
VirtualTextPosition::AfterChar,
0,
);
assert_eq!(manager.len(), 1);
let removed = manager.remove(&mut marker_list, id);
assert!(removed);
assert_eq!(manager.len(), 0);
// Marker should also be removed
assert_eq!(marker_list.marker_count(), 0);
}
#[test]
fn test_remove_nonexistent() {
let mut marker_list = MarkerList::new();
let mut manager = VirtualTextManager::new();
let removed = manager.remove(&mut marker_list, VirtualTextId(999));
assert!(!removed);
}
#[test]
fn test_clear() {
let mut marker_list = MarkerList::new();
let mut manager = VirtualTextManager::new();
manager.add(
&mut marker_list,
10,
": i32".to_string(),
hint_style(),
VirtualTextPosition::AfterChar,
0,
);
manager.add(
&mut marker_list,
20,
": String".to_string(),
hint_style(),
VirtualTextPosition::AfterChar,
0,
);
assert_eq!(manager.len(), 2);
assert_eq!(marker_list.marker_count(), 2);
manager.clear(&mut marker_list);
assert_eq!(manager.len(), 0);
assert_eq!(marker_list.marker_count(), 0);
}
#[test]
fn test_query_range() {
let mut marker_list = MarkerList::new();
let mut manager = VirtualTextManager::new();
// Add three virtual texts at positions 10, 20, 30
manager.add(
&mut marker_list,
10,
": i32".to_string(),
hint_style(),
VirtualTextPosition::AfterChar,
0,
);
manager.add(
&mut marker_list,
20,
": String".to_string(),
hint_style(),
VirtualTextPosition::AfterChar,
0,
);
manager.add(
&mut marker_list,
30,
": bool".to_string(),
hint_style(),
VirtualTextPosition::AfterChar,
0,
);
// Query range [15, 35) should return positions 20 and 30
let results = manager.query_range(&marker_list, 15, 35);
assert_eq!(results.len(), 2);
assert_eq!(results[0].0, 20);
assert_eq!(results[0].1.text, ": String");
assert_eq!(results[1].0, 30);
assert_eq!(results[1].1.text, ": bool");
// Query range [0, 15) should return position 10
let results = manager.query_range(&marker_list, 0, 15);
assert_eq!(results.len(), 1);
assert_eq!(results[0].0, 10);
assert_eq!(results[0].1.text, ": i32");
}
#[test]
fn test_query_empty_range() {
let mut marker_list = MarkerList::new();
let mut manager = VirtualTextManager::new();
manager.add(
&mut marker_list,
10,
": i32".to_string(),
hint_style(),
VirtualTextPosition::AfterChar,
0,
);
// Query range with no virtual texts
let results = manager.query_range(&marker_list, 100, 200);
assert!(results.is_empty());
}
#[test]
fn test_priority_ordering() {
let mut marker_list = MarkerList::new();
let mut manager = VirtualTextManager::new();
// Add multiple virtual texts at the same position with different priorities
manager.add(
&mut marker_list,
10,
"low".to_string(),
hint_style(),
VirtualTextPosition::AfterChar,
0,
);
manager.add(
&mut marker_list,
10,
"high".to_string(),
hint_style(),
VirtualTextPosition::AfterChar,
10,
);
manager.add(
&mut marker_list,
10,
"medium".to_string(),
hint_style(),
VirtualTextPosition::AfterChar,
5,
);
let results = manager.query_range(&marker_list, 0, 20);
assert_eq!(results.len(), 3);
// Should be sorted by priority: 0, 5, 10
assert_eq!(results[0].1.text, "low");
assert_eq!(results[1].1.text, "medium");
assert_eq!(results[2].1.text, "high");
}
#[test]
fn test_build_lookup() {
let mut marker_list = MarkerList::new();
let mut manager = VirtualTextManager::new();
manager.add(
&mut marker_list,
10,
": i32".to_string(),
hint_style(),
VirtualTextPosition::AfterChar,
0,
);
manager.add(
&mut marker_list,
10,
" = 5".to_string(),
hint_style(),
VirtualTextPosition::AfterChar,
1,
);
manager.add(
&mut marker_list,
20,
": String".to_string(),
hint_style(),
VirtualTextPosition::AfterChar,
0,
);
let lookup = manager.build_lookup(&marker_list, 0, 30);
assert_eq!(lookup.len(), 2); // Two unique positions
let at_10 = lookup.get(&10).unwrap();
assert_eq!(at_10.len(), 2);
assert_eq!(at_10[0].text, ": i32"); // priority 0
assert_eq!(at_10[1].text, " = 5"); // priority 1
let at_20 = lookup.get(&20).unwrap();
assert_eq!(at_20.len(), 1);
assert_eq!(at_20[0].text, ": String");
}
#[test]
fn test_position_tracking_after_insert() {
let mut marker_list = MarkerList::new();
let mut manager = VirtualTextManager::new();
manager.add(
&mut marker_list,
10,
": i32".to_string(),
hint_style(),
VirtualTextPosition::AfterChar,
0,
);
// Insert 5 bytes before position 10
marker_list.adjust_for_insert(5, 5);
// Virtual text should now be at position 15
let results = manager.query_range(&marker_list, 0, 20);
assert_eq!(results.len(), 1);
assert_eq!(results[0].0, 15);
}
#[test]
fn test_position_tracking_after_delete() {
let mut marker_list = MarkerList::new();
let mut manager = VirtualTextManager::new();
manager.add(
&mut marker_list,
20,
": i32".to_string(),
hint_style(),
VirtualTextPosition::AfterChar,
0,
);
// Delete 5 bytes before position 20 (at position 10)
marker_list.adjust_for_delete(10, 5);
// Virtual text should now be at position 15
let results = manager.query_range(&marker_list, 0, 20);
assert_eq!(results.len(), 1);
assert_eq!(results[0].0, 15);
}
#[test]
fn test_before_and_after_positions() {
let mut marker_list = MarkerList::new();
let mut manager = VirtualTextManager::new();
manager.add(
&mut marker_list,
10,
"/*param=*/".to_string(),
hint_style(),
VirtualTextPosition::BeforeChar,
0,
);
manager.add(
&mut marker_list,
10,
": Type".to_string(),
hint_style(),
VirtualTextPosition::AfterChar,
0,
);
let lookup = manager.build_lookup(&marker_list, 0, 20);
let at_10 = lookup.get(&10).unwrap();
assert_eq!(at_10.len(), 2);
// Both at same position, check they have different positions
let before = at_10
.iter()
.find(|vt| vt.position == VirtualTextPosition::BeforeChar);
let after = at_10
.iter()
.find(|vt| vt.position == VirtualTextPosition::AfterChar);
assert!(before.is_some());
assert!(after.is_some());
assert_eq!(before.unwrap().text, "/*param=*/");
assert_eq!(after.unwrap().text, ": Type");
}
}