jiq 3.21.0

//! Overlay utilities for syntax-highlighted text in scrolled viewports.
//!
//! This module provides functions for:
//! - Extracting the visible portion of styled spans when horizontally scrolled
//! - Inserting a cursor indicator into styled spans
//! - Highlighting matching bracket pairs with underline

use ratatui::style::Modifier;
use ratatui::text::Span;

use crate::theme;

/// Extracts the visible portion of spans for a scrolled viewport.
///
/// When the user scrolls horizontally in the input field, this function
/// determines which parts of the styled text should be displayed.
///
/// # Parameters
/// - `spans`: Complete styled text spans
/// - `scroll_offset`: Horizontal scroll position (characters from left)
/// - `viewport_width`: Width of visible area in characters
///
/// # Returns
/// Vector of spans containing only text visible in the viewport.
///
/// # Example
/// For text "Hello World" with scroll_offset=3 and viewport_width=5,
/// returns spans for "lo Wo".
pub fn extract_visible_spans(
    spans: &[Span<'static>],
    scroll_offset: usize,
    viewport_width: usize,
) -> Vec<Span<'static>> {
    let mut result = Vec::new();
    let mut current_col = 0;
    let end_col = scroll_offset + viewport_width;

    for span in spans {
        let span_len = span.content.chars().count();
        let span_end = current_col + span_len;

        if span_end <= scroll_offset {
            current_col = span_end;
            continue;
        }

        if current_col >= end_col {
            break;
        }
        let start_in_span = scroll_offset.saturating_sub(current_col);
        let end_in_span = (end_col - current_col).min(span_len);

        if start_in_span < end_in_span {
            let visible_content: String = span
                .content
                .chars()
                .skip(start_in_span)
                .take(end_in_span - start_in_span)
                .collect();

            result.push(Span::styled(visible_content, span.style));
        }

        current_col = span_end;
    }

    result
}

/// Inserts a cursor indicator at the specified position within spans.
///
/// Splits the span containing the cursor and applies a REVERSED style modifier
/// to the cursor character for visibility. This makes the cursor character appear
/// with inverted colors.
///
/// # Parameters
/// - `spans`: Styled text spans
/// - `cursor_pos`: Character position for cursor (0-indexed)
///
/// # Returns
/// Vector of spans with cursor character styled with REVERSED modifier.
/// If cursor_pos is beyond text length, appends a reversed space at the end.
pub fn insert_cursor_into_spans(
    spans: Vec<Span<'static>>,
    cursor_pos: usize,
) -> Vec<Span<'static>> {
    use ratatui::style::Modifier;

    let mut result = Vec::new();
    let mut current_pos = 0;

    for span in &spans {
        let span_chars: Vec<char> = span.content.chars().collect();
        let span_len = span_chars.len();
        let span_end = current_pos + span_len;

        if cursor_pos < current_pos || cursor_pos >= span_end {
            result.push(span.clone());
            current_pos = span_end;
            continue;
        }

        let cursor_in_span = cursor_pos - current_pos;

        if cursor_in_span > 0 {
            let before: String = span_chars[..cursor_in_span].iter().collect();
            result.push(Span::styled(before, span.style));
        }

        let cursor_char = span_chars[cursor_in_span].to_string();
        result.push(Span::styled(
            cursor_char,
            span.style.add_modifier(Modifier::REVERSED),
        ));

        if cursor_in_span + 1 < span_len {
            let after: String = span_chars[cursor_in_span + 1..].iter().collect();
            result.push(Span::styled(after, span.style));
        }

        current_pos = span_end;
    }
    let total_len: usize = spans.iter().map(|s| s.content.chars().count()).sum();
    if cursor_pos >= total_len {
        use ratatui::style::Style;
        result.push(Span::styled(
            " ",
            Style::default().add_modifier(Modifier::REVERSED),
        ));
    }

    result
}

/// Highlights matching bracket pairs with bold and underline.
///
/// Takes a vector of spans and positions of matching bracket pairs,
/// and applies BOLD and UNDERLINED modifiers while preserving existing
/// style (color, etc.) to make the matching brackets highly visible.
///
/// # Parameters
/// - `spans`: Styled text spans to process
/// - `bracket_positions`: Tuple of (opening_bracket_pos, closing_bracket_pos)
///
/// # Returns
/// Vector of spans with bold and underline applied to bracket characters.
///
/// # Example
/// For query "map(.)" with bracket_positions (3, 5), the '(' at position 3
/// and ')' at position 5 will have bold and underline modifiers added.
pub fn highlight_bracket_pairs(
    spans: Vec<Span<'static>>,
    bracket_positions: (usize, usize),
) -> Vec<Span<'static>> {
    let (open_pos, close_pos) = bracket_positions;
    apply_enhanced_modifiers_at_positions(
        spans,
        &[open_pos, close_pos],
        Modifier::BOLD | Modifier::UNDERLINED,
    )
}

/// Applies modifiers to characters at specific positions while preserving existing style.
///
/// This helper function splits spans as needed and adds the given modifiers
/// to the existing style at specified positions, preserving all other style attributes.
///
/// # Parameters
/// - `spans`: Styled text spans to process
/// - `positions`: Character positions where modifiers should be added
/// - `modifiers`: The modifiers to add (e.g., Modifier::BOLD | Modifier::UNDERLINED)
///
/// # Returns
/// Vector of spans with modifiers added to characters at specified positions.
fn apply_enhanced_modifiers_at_positions(
    spans: Vec<Span<'static>>,
    positions: &[usize],
    modifiers: Modifier,
) -> Vec<Span<'static>> {
    if positions.is_empty() {
        return spans;
    }

    let mut result = Vec::new();
    let mut current_pos = 0;

    for span in spans {
        let span_chars: Vec<char> = span.content.chars().collect();
        let span_len = span_chars.len();
        let span_end = current_pos + span_len;

        let mut positions_in_span: Vec<usize> = positions
            .iter()
            .filter_map(|&pos| {
                if pos >= current_pos && pos < span_end {
                    Some(pos - current_pos)
                } else {
                    None
                }
            })
            .collect();

        if positions_in_span.is_empty() {
            result.push(span);
            current_pos = span_end;
            continue;
        }

        positions_in_span.sort_unstable();

        let mut last_end = 0;

        for &pos_in_span in &positions_in_span {
            if pos_in_span > last_end {
                let before: String = span_chars[last_end..pos_in_span].iter().collect();
                result.push(Span::styled(before, span.style));
            }

            let char_at_pos = span_chars[pos_in_span].to_string();
            let enhanced_style = span
                .style
                .fg(theme::syntax::bracket_match::COLOR)
                .add_modifier(modifiers);
            result.push(Span::styled(char_at_pos, enhanced_style));

            last_end = pos_in_span + 1;
        }

        if last_end < span_len {
            let after: String = span_chars[last_end..].iter().collect();
            result.push(Span::styled(after, span.style));
        }

        current_pos = span_end;
    }

    result
}

/// Applies a style modifier to characters at specific positions within spans.
///
/// This is a helper function that splits spans as needed and applies the modifier
/// to characters at the specified positions.
///
/// # Parameters
/// - `spans`: Styled text spans to process
/// - `positions`: Character positions where modifier should be applied
/// - `modifier`: The style modifier to apply (e.g., UNDERLINED, BOLD)
///
/// # Returns
/// Vector of spans with modifier applied to characters at specified positions.
#[cfg(test)]
fn apply_modifier_at_positions(
    spans: Vec<Span<'static>>,
    positions: &[usize],
    modifier: Modifier,
) -> Vec<Span<'static>> {
    if positions.is_empty() {
        return spans;
    }

    let mut result = Vec::new();
    let mut current_pos = 0;

    for span in spans {
        let span_chars: Vec<char> = span.content.chars().collect();
        let span_len = span_chars.len();
        let span_end = current_pos + span_len;

        let mut positions_in_span: Vec<usize> = positions
            .iter()
            .filter_map(|&pos| {
                if pos >= current_pos && pos < span_end {
                    Some(pos - current_pos)
                } else {
                    None
                }
            })
            .collect();

        if positions_in_span.is_empty() {
            result.push(span);
            current_pos = span_end;
            continue;
        }

        positions_in_span.sort_unstable();

        let mut last_end = 0;

        for &pos_in_span in &positions_in_span {
            if pos_in_span > last_end {
                let before: String = span_chars[last_end..pos_in_span].iter().collect();
                result.push(Span::styled(before, span.style));
            }

            let char_at_pos = span_chars[pos_in_span].to_string();
            result.push(Span::styled(char_at_pos, span.style.add_modifier(modifier)));

            last_end = pos_in_span + 1;
        }

        if last_end < span_len {
            let after: String = span_chars[last_end..].iter().collect();
            result.push(Span::styled(after, span.style));
        }

        current_pos = span_end;
    }

    result
}

#[cfg(test)]
#[path = "overlay_tests.rs"]
mod overlay_tests;