quick_search/crates/quicksearch-core/src/snippet.rs

//! Snippet extraction for search results; contentless FTS5 has no
//! `snippet()`. Output is structural (window text plus byte ranges), never
//! markup. Matching folds ASCII case only, as full-text verification does:
//! `cafe` neither finds nor marks `café`.

#[derive(Debug, Clone)]
pub struct Options {
    /// Approximate byte budget for the returned window: a soft target, since
    /// matches expand the window so a hit is never cut off.
    pub approx_bytes: usize,
}

impl Default for Options {
    fn default() -> Self {
        Options { approx_bytes: 200 }
    }
}

/// A context window from a document plus the match positions inside it.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Snippet {
    /// The excerpt, sliced verbatim from the source text.
    pub window: String,
    /// Byte ranges *into `window`*, sorted, non-overlapping (overlapping
    /// term hits are coalesced), always on char boundaries.
    pub ranges: Vec<(usize, usize)>,
    /// Content exists before/after the window.
    pub truncated_start: bool,
    pub truncated_end: bool,
}

impl Snippet {
    fn empty() -> Snippet {
        Snippet {
            window: String::new(),
            ranges: Vec::new(),
            truncated_start: false,
            truncated_end: false,
        }
    }
}

/// Extract against a haystack the caller has already ASCII-folded. `folded`
/// must be `text.to_ascii_lowercase()`: the fold preserves byte length, so
/// offsets found in it slice the original.
///
/// Returns the window and how many occurrences of `term` it found before
/// touching ranges were coalesced, the count the full-text pass ranks on. A
/// blank term matches nothing, but a padded term is searched as given, never
/// trimmed.
pub fn extract_folded(text: &str, folded: &str, term: &str, opts: &Options) -> (Snippet, usize) {
    debug_assert_eq!(folded.len(), text.len(), "ASCII folding preserves length");
    if text.is_empty() {
        return (Snippet::empty(), 0);
    }
    if term.trim().is_empty() {
        return (head_window(text, opts.approx_bytes), 0);
    }

    // Borrow when the term is already folded, as every cascade call's is,
    // to avoid an allocation per candidate row.
    let pattern: std::borrow::Cow<'_, str> = if term.bytes().any(|b| b.is_ascii_uppercase()) {
        std::borrow::Cow::Owned(term.to_ascii_lowercase())
    } else {
        std::borrow::Cow::Borrowed(term)
    };
    // `memmem`, not `str::match_indices`: measured faster on whole-body
    // scans. The walk runs to the end (the count must see every occurrence),
    // but matches past the window's right edge are not stored.
    let mut matches: Vec<(usize, usize)> = Vec::new();
    let mut found = 0usize;
    // The window's right edge once the first match fixes it, from the same
    // [`window_bounds`] the window itself uses.
    let mut keep_below: Option<usize> = None;
    // The end of the last kept match, so a chain of touching occurrences
    // (`abab…` for `ab`) that starts inside the window and continues past
    // it stays intact for `coalesce_overlapping` and the expansion step.
    let mut chain_end = 0usize;
    for at in memchr::memmem::find_iter(folded.as_bytes(), pattern.as_bytes()) {
        // Before any dropping: two abutting occurrences are two hits for
        // ranking even though they paint as one highlight.
        found += 1;
        let bound = *keep_below.get_or_insert_with(|| window_bounds(text, at, opts.approx_bytes).1);
        if at >= bound && at > chain_end {
            // Past the edge and not chained to anything kept: keep counting,
            // stop storing.
            continue;
        }
        chain_end = at + pattern.len();
        matches.push((at, chain_end));
    }

    if matches.is_empty() {
        return (head_window(text, opts.approx_bytes), 0);
    }

    // One term's occurrences arrive in order and never overlap; only
    // abutting ones merge.
    let matches = coalesce_overlapping(matches);

    let (win_start, mut win_end) = window_bounds(text, matches[0].0, opts.approx_bytes);
    // A match straddling the right edge is fully included, not cut mid-hit.
    if let Some((_, end)) = matches.iter().rfind(|(s, _)| *s < win_end) {
        if *end > win_end {
            win_end = text.ceil_char_boundary(*end);
        }
    }

    let ranges = matches
        .iter()
        .filter(|(s, e)| *e > win_start && *s < win_end)
        .map(|(s, e)| {
            (
                (*s).max(win_start) - win_start,
                (*e).min(win_end) - win_start,
            )
        })
        .collect();

    (
        Snippet {
            window: text[win_start..win_end].to_string(),
            ranges,
            truncated_start: win_start > 0,
            truncated_end: win_end < text.len(),
        },
        found,
    )
}

/// The window cut around a match that starts at `first`: from a third of
/// `budget` before it, rounded down to a char boundary, to `budget` past that
/// unrounded start, rounded up. The third keeps the hit off the left edge.
fn window_bounds(text: &str, first: usize, budget: usize) -> (usize, usize) {
    let start = first.saturating_sub(budget / 3);
    let end = (start + budget).min(text.len());
    (
        text.floor_char_boundary(start),
        text.ceil_char_boundary(end),
    )
}

/// Clamp `range` into `text` and widen it to the nearest char boundaries.
/// Callers take ranges from byte-level matchers, so an endpoint can land
/// inside a multi-byte character, where slicing panics.
fn aligned_range(text: &str, range: (usize, usize)) -> (usize, usize) {
    let start = range.0.min(text.len());
    let end = range.1.clamp(start, text.len());
    (
        text.floor_char_boundary(start),
        text.ceil_char_boundary(end),
    )
}

/// The whole of `text` as the window, with `range` marked: the shape the name
/// and path tiers use. `window` is the field verbatim, so the ranges index the
/// field the column is already painting.
pub fn whole_field(text: &str, range: (usize, usize)) -> Snippet {
    if text.is_empty() {
        return Snippet::empty();
    }
    let (start, end) = aligned_range(text, range);
    Snippet {
        window: text.to_string(),
        ranges: if end > start {
            vec![(start, end)]
        } else {
            Vec::new()
        },
        truncated_start: false,
        truncated_end: false,
    }
}

/// Build a snippet window around one known match range in `text`. The range
/// is clamped into `text` and widened to char boundaries.
pub fn window_around(text: &str, range: (usize, usize), opts: &Options) -> Snippet {
    if text.is_empty() {
        return Snippet::empty();
    }
    let (ms, me) = aligned_range(text, range);
    let (win_start, win_end) = window_bounds(text, ms, opts.approx_bytes);
    // The whole match stays inside the window.
    let win_end = win_end.max(me);

    let ranges = if me > ms {
        vec![(ms - win_start, me - win_start)]
    } else {
        Vec::new()
    };
    Snippet {
        window: text[win_start..win_end].to_string(),
        ranges,
        truncated_start: win_start > 0,
        truncated_end: win_end < text.len(),
    }
}

/// Count non-overlapping occurrences of `term` in `text`, byte for byte: a
/// case-insensitive count passes both already folded.
pub fn count_occurrences(text: &str, term: &str) -> usize {
    if term.is_empty() || text.len() < term.len() {
        return 0;
    }
    memchr::memmem::find_iter(text.as_bytes(), term.as_bytes()).count()
}

/// The first `n` bytes of `text` (char-aligned) as a match-less window.
fn head_window(text: &str, n: usize) -> Snippet {
    let cut = text.floor_char_boundary(n);
    Snippet {
        window: text[..cut].to_string(),
        ranges: Vec::new(),
        truncated_start: false,
        truncated_end: cut < text.len(),
    }
}

/// Merge adjacent/overlapping ranges. Input must be sorted by start.
fn coalesce_overlapping(v: Vec<(usize, usize)>) -> Vec<(usize, usize)> {
    let mut out = Vec::with_capacity(v.len());
    let mut it = v.into_iter();
    let Some(mut cur) = it.next() else {
        return out;
    };
    for next in it {
        if next.0 <= cur.1 {
            cur.1 = cur.1.max(next.1);
        } else {
            out.push(cur);
            cur = next;
        }
    }
    out.push(cur);
    out
}

#[cfg(test)]
mod tests {
    use super::*;

    fn extract(text: &str, term: &str, opts: &Options) -> Snippet {
        extract_folded(text, &text.to_ascii_lowercase(), term, opts).0
    }

    fn extract_counted(text: &str, term: &str, opts: &Options) -> (Snippet, usize) {
        extract_folded(text, &text.to_ascii_lowercase(), term, opts)
    }

    fn opts_small() -> Options {
        Options { approx_bytes: 40 }
    }

    /// The count is occurrences, not the highlights they coalesce into.
    #[test]
    fn extract_folded_counts_occurrences_not_ranges() {
        let text = "abab and ab";
        let (s, n) = extract_counted(text, "ab", &opts_small());
        assert_eq!(n, 3, "three occurrences");
        assert_eq!(
            n,
            count_occurrences(text, "ab"),
            "must agree with count_occurrences"
        );
        assert_eq!(s.ranges.len(), 2, "the abutting pair paints as one range");
    }

    /// A disagreement here would change which rows survive the pass.
    #[test]
    fn extract_folded_count_agrees_with_count_occurrences() {
        let cases: &[(&str, &str)] = &[
            ("no hits at all", "zzz"),
            ("one hit here", "hit"),
            ("Hit hit HIT", "hit"),
            ("aaaa", "aa"),
            ("", "x"),
            ("short", "much longer than the haystack"),
            ("ünïcode ünïcode", "ünïcode"),
        ];
        for (text, term) in cases {
            let folded = text.to_ascii_lowercase();
            let (_, n) = extract_folded(text, &folded, term, &opts_small());
            assert_eq!(
                n,
                count_occurrences(&folded, &term.to_ascii_lowercase()),
                "count mismatch for {:?} in {:?}",
                term,
                text
            );
        }
    }

    /// The owning and borrowing branches of the fold must find the same
    /// matches.
    #[test]
    fn extract_folded_needle_case_does_not_change_matches() {
        let text = "The Needle and the needle";
        let folded = text.to_ascii_lowercase();
        let (upper, n_upper) = extract_folded(text, &folded, "Needle", &opts_small());
        let (lower, n_lower) = extract_folded(text, &folded, "needle", &opts_small());
        assert_eq!(n_upper, 2);
        assert_eq!(n_upper, n_lower);
        assert_eq!(upper.ranges, lower.ranges);
        assert_eq!(upper.window, lower.window);
    }

    /// An empty needle would match at every byte offset.
    #[test]
    fn extract_folded_ignores_blank_terms() {
        let text = "some text";
        let folded = text.to_ascii_lowercase();
        for term in ["", "   ", "\t"] {
            let (s, n) = extract_folded(text, &folded, term, &opts_small());
            assert_eq!(n, 0, "blank term {:?} counted", term);
            assert!(s.ranges.is_empty(), "blank term {:?} highlighted", term);
        }
    }

    /// A term with surrounding space is searched as given, never trimmed.
    #[test]
    fn extract_folded_does_not_trim_a_padded_term() {
        let text = "needle needlework";
        let folded = text.to_ascii_lowercase();
        let (_, n) = extract_folded(text, &folded, "needle ", &opts_small());
        assert_eq!(n, 1, "only the occurrence followed by a space");
        assert_eq!(n, count_occurrences(&folded, "needle "));
    }

    /// The `Snippet::ranges` contract egui's LayoutJob sections rely on.
    fn assert_ranges_valid(s: &Snippet) {
        let mut prev_end = 0;
        for &(a, b) in &s.ranges {
            assert!(a < b, "empty/inverted range {:?}", (a, b));
            assert!(b <= s.window.len(), "range {:?} beyond window", (a, b));
            assert!(a >= prev_end, "overlapping ranges");
            assert!(s.window.is_char_boundary(a) && s.window.is_char_boundary(b));
            prev_end = b;
        }
    }

    fn marked(s: &Snippet) -> Vec<&str> {
        s.ranges.iter().map(|&(a, b)| &s.window[a..b]).collect()
    }

    /// Occurrences past the window's right edge are counted but not kept; a
    /// bound leaking into either side would be a ranking change or a missing
    /// highlight.
    #[test]
    fn occurrences_past_the_window_are_counted_but_not_kept() {
        let unit = "needle filler filler ";
        let text = unit.repeat(400);
        let (snip, found) = extract_counted(&text, "needle", &opts_small());

        assert_eq!(found, 400, "every occurrence must still be counted");
        assert_ranges_valid(&snip);
        assert!(!snip.ranges.is_empty());
        assert!(snip.truncated_end, "there is a great deal more body");

        for &(a, b) in &snip.ranges {
            assert_eq!(&snip.window[a..b], "needle");
        }
        let win_at = text
            .find(&snip.window)
            .expect("the window is a slice of the text");
        let expected = memchr::memmem::find_iter(text.as_bytes(), b"needle")
            .filter(|at| *at >= win_at && *at < win_at + snip.window.len())
            .count();
        assert_eq!(
            snip.ranges.len(),
            expected,
            "every occurrence inside the window must be marked"
        );
    }

    /// The case the chain rule exists for: a chain that starts inside the
    /// window can run past its right edge, and dropping at the edge would
    /// cut the highlight short.
    #[test]
    fn a_coalescing_chain_is_not_cut_at_the_window_edge() {
        let text = "ab".repeat(400);
        let (snip, found) = extract_counted(&text, "ab", &opts_small());

        assert_eq!(found, 400, "non-overlapping occurrences, all counted");
        assert_ranges_valid(&snip);
        assert_eq!(snip.ranges.len(), 1, "one chain, one highlight");

        // An unbroken chain grows the window to the whole text; without the
        // chain rule the window is 40 bytes, which "range == whole window"
        // alone cannot tell apart.
        assert_eq!(
            snip.window.len(),
            text.len(),
            "the window must grow to cover the coalesced run"
        );
        assert!(
            !snip.truncated_end,
            "nothing is left past a full-length window"
        );
        assert_eq!(
            snip.ranges[0],
            (0, text.len()),
            "one highlight over the lot"
        );
    }

    #[test]
    fn empty_text_returns_empty() {
        let s = extract("", "foo", &Options::default());
        assert_eq!(s, Snippet::empty());
    }

    #[test]
    fn a_blank_term_returns_head_marked_truncated() {
        let long = "abcdefghijklmnop".repeat(10);
        let s = extract(&long, "", &opts_small());
        assert!(s.truncated_end);
        assert!(!s.truncated_start);
        assert!(s.ranges.is_empty());
        assert!(s.window.len() <= 40);
    }

    #[test]
    fn a_blank_term_untruncated() {
        let s = extract("short text", "", &opts_small());
        assert_eq!(s.window, "short text");
        assert!(!s.truncated_end && !s.truncated_start);
    }

    #[test]
    fn simple_match_range() {
        let s = extract("the quick brown fox", "quick", &opts_small());
        assert_eq!(marked(&s), vec!["quick"]);
        assert_ranges_valid(&s);
    }

    #[test]
    fn case_insensitive_match_reports_original_case() {
        let s = extract("The QUICK brown fox", "quick", &opts_small());
        assert_eq!(marked(&s), vec!["QUICK"]);
    }

    #[test]
    fn window_truncation_flags_on_both_sides() {
        let text = "prefix ".repeat(20) + "MATCH in middle " + &"suffix ".repeat(20);
        let s = extract(&text, "MATCH", &opts_small());
        assert!(s.truncated_start);
        assert!(s.truncated_end);
        assert_eq!(marked(&s), vec!["MATCH"]);
    }

    #[test]
    fn match_at_start_not_truncated_left() {
        let s = extract(
            "MATCH right at the start of this paragraph",
            "match",
            &opts_small(),
        );
        assert!(!s.truncated_start);
        assert_eq!(s.ranges[0].0, 0);
    }

    #[test]
    fn no_match_returns_head_without_ranges() {
        let text = "alpha beta gamma delta epsilon zeta eta theta iota kappa";
        let s = extract(text, "nomatch", &opts_small());
        assert!(s.ranges.is_empty());
        assert!(s.window.starts_with("alpha"));
    }

    #[test]
    fn utf8_boundaries_hold_with_multibyte_text() {
        let text = "café café café café café café café café café café";
        let s = extract(text, "café", &opts_small());
        assert!(!s.ranges.is_empty());
        assert_ranges_valid(&s);
        for m in marked(&s) {
            assert_eq!(m, "café");
        }
    }

    #[test]
    fn match_near_right_edge_is_fully_included() {
        let prefix = "x".repeat(30);
        let text = format!("{}{}", prefix, "LONGMATCHTERMTEXT");
        let s = extract(&text, "LONGMATCHTERMTEXT", &opts_small());
        assert_eq!(marked(&s), vec!["LONGMATCHTERMTEXT"]);
    }

    #[test]
    fn window_around_basic() {
        let text = "prefix ".repeat(20) + "NEEDLE" + &" suffix".repeat(20);
        let at = text.find("NEEDLE").unwrap();
        let s = window_around(&text, (at, at + 6), &opts_small());
        assert_eq!(marked(&s), vec!["NEEDLE"]);
        assert!(s.truncated_start && s.truncated_end);
        assert_ranges_valid(&s);
    }

    #[test]
    fn window_around_clamps_out_of_bounds() {
        let s = window_around("tiny", (2, 999), &opts_small());
        assert_eq!(s.window, "tiny");
        assert_eq!(s.ranges, vec![(2, 4)]);
        // Fully out-of-range → no ranges, but never a panic.
        let s = window_around("tiny", (999, 1000), &opts_small());
        assert!(s.ranges.is_empty());
    }

    #[test]
    fn window_around_aligns_multibyte_boundaries() {
        let text = "ééééééééé needle ééééééééé";
        let s = window_around(text, (1, 3), &opts_small());
        assert_ranges_valid(&s);
    }

    #[test]
    fn count_occurrences_cases() {
        assert_eq!(count_occurrences("aaaa", "aaa"), 1, "non-overlapping");
        assert_eq!(count_occurrences("abcABC", "abc"), 1, "byte for byte");
        assert_eq!(count_occurrences("", "x"), 0);
        assert_eq!(count_occurrences("xyz", ""), 0);
        assert_eq!(count_occurrences("no hits here", "zzz"), 0);
        assert_eq!(count_occurrences("ab ab ab", "ab"), 3);
    }
}