Skip to main content

fresh/primitives/
reference_highlight_text.rs

1//! Text-based reference highlighting (WASM-compatible)
2//!
3//! When the cursor is on a word, all occurrences of that word in the viewport
4//! are highlighted. This module provides simple whole-word text matching
5//! without requiring tree-sitter.
6//!
7//! # Design
8//!
9//! - Pure text matching (no AST analysis)
10//! - Efficient viewport-based search
11//! - Respects word boundaries (won't match partial words)
12
13use crate::model::buffer::Buffer;
14use crate::primitives::highlight_types::HighlightSpan;
15use crate::primitives::word_navigation::{find_word_end, find_word_start, is_word_char};
16use ratatui::style::Color;
17use std::ops::Range;
18
19/// Default highlight color for word occurrences
20pub const DEFAULT_HIGHLIGHT_COLOR: Color = Color::Rgb(60, 60, 80);
21
22/// Text-based reference highlighter (WASM-compatible)
23///
24/// Highlights all occurrences of the word under cursor using simple
25/// text matching. This is the fallback mode when tree-sitter is not available.
26pub struct TextReferenceHighlighter {
27    /// Color for occurrence highlights
28    pub highlight_color: Color,
29    /// Minimum word length to trigger highlighting
30    pub min_word_length: usize,
31    /// Whether highlighting is enabled
32    pub enabled: bool,
33}
34
35impl Default for TextReferenceHighlighter {
36    fn default() -> Self {
37        Self {
38            highlight_color: DEFAULT_HIGHLIGHT_COLOR,
39            min_word_length: 2,
40            enabled: true,
41        }
42    }
43}
44
45impl TextReferenceHighlighter {
46    /// Create a new text reference highlighter
47    pub fn new() -> Self {
48        Self::default()
49    }
50
51    /// Create with custom highlight color
52    pub fn with_color(color: Color) -> Self {
53        Self {
54            highlight_color: color,
55            ..Self::default()
56        }
57    }
58
59    /// Highlight occurrences of word under cursor
60    ///
61    /// Returns highlight spans for all whole-word matches of the word
62    /// at `cursor_position` within the viewport range.
63    pub fn highlight_occurrences(
64        &self,
65        buffer: &Buffer,
66        cursor_position: usize,
67        viewport_start: usize,
68        viewport_end: usize,
69    ) -> Vec<HighlightSpan> {
70        if !self.enabled {
71            return Vec::new();
72        }
73
74        // Find the word under the cursor
75        let word_range = match self.get_word_at_position(buffer, cursor_position) {
76            Some(range) => range,
77            None => return Vec::new(),
78        };
79
80        // Get the word text
81        let word_bytes = buffer.slice_bytes(word_range.clone());
82        let word = match std::str::from_utf8(&word_bytes) {
83            Ok(s) => s.to_string(),
84            Err(_) => return Vec::new(),
85        };
86
87        // Check minimum length
88        if word.len() < self.min_word_length {
89            return Vec::new();
90        }
91
92        // Find all occurrences in the viewport
93        let occurrences =
94            self.find_occurrences_in_range(buffer, &word, viewport_start, viewport_end);
95
96        // Convert to highlight spans
97        occurrences
98            .into_iter()
99            .map(|range| HighlightSpan {
100                range,
101                color: self.highlight_color,
102            })
103            .collect()
104    }
105
106    /// Get the word range at the given position
107    fn get_word_at_position(&self, buffer: &Buffer, position: usize) -> Option<Range<usize>> {
108        let buf_len = buffer.len();
109        if position > buf_len {
110            return None;
111        }
112
113        // Check if cursor is on a word character
114        let is_on_word = if position < buf_len {
115            let byte_at_pos = buffer.slice_bytes(position..position + 1);
116            byte_at_pos
117                .first()
118                .map(|&b| is_word_char(b))
119                .unwrap_or(false)
120        } else if position > 0 {
121            // Cursor at end of buffer - check previous character
122            let byte_before = buffer.slice_bytes(position - 1..position);
123            byte_before
124                .first()
125                .map(|&b| is_word_char(b))
126                .unwrap_or(false)
127        } else {
128            false
129        };
130
131        if !is_on_word && position > 0 {
132            // Check if we're just after a word at end of buffer
133            let byte_before = buffer.slice_bytes(position.saturating_sub(1)..position);
134            let is_after_word = byte_before
135                .first()
136                .map(|&b| is_word_char(b))
137                .unwrap_or(false);
138
139            if is_after_word && position >= buf_len {
140                let start = find_word_start(buffer, position.saturating_sub(1));
141                let end = position;
142                if start < end {
143                    return Some(start..end);
144                }
145            }
146            return None;
147        }
148
149        if !is_on_word {
150            return None;
151        }
152
153        // Find word boundaries
154        let start = find_word_start(buffer, position);
155        let end = find_word_end(buffer, position);
156
157        if start < end {
158            Some(start..end)
159        } else {
160            None
161        }
162    }
163
164    /// Maximum search range (1MB) to avoid performance issues
165    const MAX_SEARCH_RANGE: usize = 1024 * 1024;
166
167    /// Find all whole-word occurrences in a byte range
168    fn find_occurrences_in_range(
169        &self,
170        buffer: &Buffer,
171        word: &str,
172        start: usize,
173        end: usize,
174    ) -> Vec<Range<usize>> {
175        // Skip if search range is too large
176        if end.saturating_sub(start) > Self::MAX_SEARCH_RANGE {
177            return Vec::new();
178        }
179
180        let mut occurrences = Vec::new();
181
182        // Get the text with padding for edge words
183        let search_start = start.saturating_sub(word.len());
184        let search_end = (end + word.len()).min(buffer.len());
185
186        let bytes = buffer.slice_bytes(search_start..search_end);
187        let text = match std::str::from_utf8(&bytes) {
188            Ok(s) => s,
189            Err(_) => return occurrences,
190        };
191
192        // Use match_indices for efficient single-pass searching
193        for (rel_pos, _) in text.match_indices(word) {
194            let abs_start = search_start + rel_pos;
195            let abs_end = abs_start + word.len();
196
197            // Check if this is a whole word match
198            let is_word_start = abs_start == 0 || {
199                let prev_byte = buffer.slice_bytes(abs_start - 1..abs_start);
200                prev_byte.first().map(|&b| !is_word_char(b)).unwrap_or(true)
201            };
202
203            let is_word_end = abs_end >= buffer.len() || {
204                let next_byte = buffer.slice_bytes(abs_end..abs_end + 1);
205                next_byte.first().map(|&b| !is_word_char(b)).unwrap_or(true)
206            };
207
208            if is_word_start && is_word_end {
209                // Only include if within viewport
210                if abs_start < end && abs_end > start {
211                    occurrences.push(abs_start..abs_end);
212                }
213            }
214        }
215
216        occurrences
217    }
218}
219
220#[cfg(test)]
221mod tests {
222    use super::*;
223    use crate::model::filesystem::NoopFileSystem;
224    use std::sync::Arc;
225
226    fn make_buffer(content: &str) -> Buffer {
227        let fs = Arc::new(NoopFileSystem);
228        let mut buf = Buffer::empty(fs);
229        buf.insert(0, content);
230        buf
231    }
232
233    #[test]
234    fn test_highlight_word_occurrences() {
235        let buffer = make_buffer("foo bar foo baz foo");
236        let highlighter = TextReferenceHighlighter::new();
237
238        // Cursor on first "foo"
239        let spans = highlighter.highlight_occurrences(&buffer, 1, 0, buffer.len());
240        assert_eq!(spans.len(), 3); // Three occurrences of "foo"
241    }
242
243    #[test]
244    fn test_no_partial_matches() {
245        let buffer = make_buffer("foobar foo barfoo");
246        let highlighter = TextReferenceHighlighter::new();
247
248        // Cursor on standalone "foo"
249        let spans = highlighter.highlight_occurrences(&buffer, 8, 0, buffer.len());
250        assert_eq!(spans.len(), 1); // Only the standalone "foo", not "foobar" or "barfoo"
251    }
252
253    #[test]
254    fn test_minimum_word_length() {
255        let buffer = make_buffer("a a a a");
256        let highlighter = TextReferenceHighlighter::new();
257
258        // Single-character word should not be highlighted (min_word_length = 2)
259        let spans = highlighter.highlight_occurrences(&buffer, 0, 0, buffer.len());
260        assert_eq!(spans.len(), 0);
261    }
262
263    #[test]
264    fn test_disabled_highlighting() {
265        let buffer = make_buffer("foo foo foo");
266        let mut highlighter = TextReferenceHighlighter::new();
267        highlighter.enabled = false;
268
269        let spans = highlighter.highlight_occurrences(&buffer, 0, 0, buffer.len());
270        assert_eq!(spans.len(), 0);
271    }
272}