Ely-GPUI-Components/src/collab/annotate.rs

use std::{ops::Range, rc::Rc};

use gpui::{
    App, ElementId, HighlightStyle, InteractiveText, IntoElement, RenderOnce, SharedString,
    StyledText, UnderlineStyle, Window,
};

use super::peers::Peer;
use crate::{forms::Pick, primitives::Tooltip, theme::ActiveTheme};

/// How strongly an author's color washes what they marked, and the one picked.
const WASH: f32 = 0.18;
const PICKED: f32 = 0.36;

/// A stretch of text someone marked: its byte range, who marked it, and the note they left; without a note it is a plain highlight.
#[derive(Clone, Debug, PartialEq)]
pub struct Annotation {
    pub range: Range<usize>,
    pub author: Peer,
    pub note: Option<SharedString>,
}

/// Text with stretches people marked, each washed in its author's color and noted ones underlined: resting on a noted one shows the note and who left it; a press picks one.
#[derive(IntoElement)]
pub struct AnnotatedText {
    id: ElementId,
    text: SharedString,
    annotations: Rc<Vec<Annotation>>,
    kept: Rc<Vec<usize>>,
    picked: Option<usize>,
    on_pick: Option<Pick>,
}

impl AnnotatedText {
    /// `annotations` in order, none overlapping.
    pub fn new(
        id: impl Into<ElementId>,
        text: impl Into<SharedString>,
        annotations: impl IntoIterator<Item = Annotation>,
    ) -> Self {
        let text = text.into();
        let (kept, annotations): (Vec<usize>, Vec<Annotation>) = annotations
            .into_iter()
            .enumerate()
            .filter(|(_, annotation)| {
                let inside = text.get(annotation.range.clone()).is_some();
                if !inside {
                    log::error!(
                        "annotated text: {:?} lies outside the text; left out",
                        annotation.range
                    );
                }
                inside
            })
            .unzip();
        for annotation in &annotations {
            assert!(
                !annotation.range.is_empty(),
                "annotation {:?} is empty",
                annotation.range
            );
        }
        assert!(
            annotations
                .windows(2)
                .all(|pair| pair[0].range.end <= pair[1].range.start),
            "annotations come in order without overlapping"
        );
        Self {
            id: id.into(),
            text,
            annotations: Rc::new(annotations),
            kept: Rc::new(kept),
            picked: None,
            on_pick: None,
        }
    }

    /// The annotation picked, by index, and what a press on one asks.
    pub fn picked(
        mut self,
        picked: Option<usize>,
        on_pick: impl Fn(usize, &mut Window, &mut App) + 'static,
    ) -> Self {
        self.picked = picked;
        self.on_pick = Some(Rc::new(on_pick));
        self
    }
}

impl RenderOnce for AnnotatedText {
    fn render(self, _: &mut Window, cx: &mut App) -> impl IntoElement {
        if let Some(picked) = self.picked.filter(|picked| !self.kept.contains(picked)) {
            log::error!("annotated text: annotation {picked} is not shown; none picked");
        }
        let thickness = cx.theme().underline_thickness();
        let highlights: Vec<(Range<usize>, HighlightStyle)> = self
            .annotations
            .iter()
            .enumerate()
            .map(|(ix, annotation)| {
                let color = annotation.author.color(cx);
                let wash = if self.picked == Some(self.kept[ix]) {
                    PICKED
                } else {
                    WASH
                };
                let style = HighlightStyle {
                    background_color: Some(color.opacity(wash)),
                    underline: annotation.note.is_some().then_some(UnderlineStyle {
                        thickness,
                        color: Some(color),
                        wavy: false,
                    }),
                    ..HighlightStyle::default()
                };
                (annotation.range.clone(), style)
            })
            .collect();
        let ranges: Vec<Range<usize>> = self
            .annotations
            .iter()
            .map(|annotation| annotation.range.clone())
            .collect();
        let notes = self.annotations.clone();
        let text = InteractiveText::new(
            self.id,
            StyledText::new(self.text).with_highlights(highlights),
        )
        .tooltip(move |at, window, cx| {
            let annotation = notes
                .iter()
                .find(|annotation| annotation.range.contains(&at))?;
            let note = annotation.note.clone()?;
            Some(Tooltip::with_meta(note, annotation.author.name.clone())(
                window, cx,
            ))
        });
        match self.on_pick {
            Some(pick) => text.on_click(ranges, move |ix, window, cx| {
                let ix = self.kept[ix];
                log::info!("annotated text: picked {ix}");
                pick(ix, window, cx)
            }),
            None => text,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::{AnnotatedText, Annotation};
    use crate::collab::Peer;

    #[test]
    fn an_annotation_outside_the_text_is_left_out() {
        let note = |range| Annotation {
            range,
            author: Peer::new("ada", "Ada", 0),
            note: None,
        };
        let text = AnnotatedText::new("text", "éabc", [note(1..2), note(2..3)]);
        assert_eq!(text.annotations.len(), 1);
        assert_eq!(text.annotations[0].range, 2..3);
        assert_eq!(*text.kept, [1], "a pick names the owner's index");
    }
}