egui_json_tree 0.15.0

//! Rendering implementation for a [`JsonTree`](crate::JsonTree).

use std::fmt::Display;

use egui::{
    Color32, FontId, Label, Response, Sense, TextFormat, Ui,
    collapsing_header::CollapsingState,
    text::LayoutJob,
    util::cache::{ComputerMut, FrameCache},
};

use crate::{
    JsonTreeStyle, JsonTreeVisuals,
    delimiters::{ExpandableDelimiter, SpacingDelimiter},
    pointer::{JsonPointer, JsonPointerSegment},
    search::SearchTerm,
    value::{BaseValueType, ToJsonTreeValue},
};

/// A closure for a user-defined custom rendering implementation.
pub type RenderHook<'a, T> = dyn FnMut(&mut Ui, RenderContext<'a, '_, T>) + 'a;

/// A trait for types that provide a default rendering implementation.
pub trait DefaultRender {
    fn render_default(&self, ui: &mut Ui) -> Response;
}

/// A handle to the information of a render call.
pub enum RenderContext<'a, 'b, T: ToJsonTreeValue> {
    /// A render call for an array index or an object key.
    Property(RenderPropertyContext<'a, 'b, T>),
    /// A render call for a non-recursive JSON value.
    BaseValue(RenderBaseValueContext<'a, 'b, T>),
    /// A render call for array brackets or object braces.
    ExpandableDelimiter(RenderExpandableDelimiterContext<'a, 'b, T>),
}

impl<T: ToJsonTreeValue> DefaultRender for RenderContext<'_, '_, T> {
    fn render_default(&self, ui: &mut Ui) -> Response {
        match self {
            RenderContext::Property(context) => context.render_default(ui),
            RenderContext::BaseValue(context) => context.render_default(ui),
            RenderContext::ExpandableDelimiter(context) => context.render_default(ui),
        }
    }
}

impl<'a, T: ToJsonTreeValue> RenderContext<'a, '_, T> {
    /// Convenience method to access the JSON value involved in this render call.
    pub fn value(&self) -> &'a T {
        match self {
            RenderContext::Property(context) => context.value,
            RenderContext::BaseValue(context) => context.value,
            RenderContext::ExpandableDelimiter(context) => context.value,
        }
    }

    /// Convenience method to access the full JSON pointer to the JSON value involved in this render call.
    pub fn pointer(&self) -> JsonPointer<'a, '_> {
        match self {
            RenderContext::Property(context) => context.pointer,
            RenderContext::BaseValue(context) => context.pointer,
            RenderContext::ExpandableDelimiter(context) => context.pointer,
        }
    }
}

/// A handle to the information of a render call for an array index or object key.
pub struct RenderPropertyContext<'a, 'b, T: ToJsonTreeValue> {
    /// The array index or object key being rendered.
    pub property: JsonPointerSegment<'a>,
    /// The JSON value under this property.
    pub value: &'a T,
    /// The full JSON pointer to the array or object under this property.
    pub pointer: JsonPointer<'a, 'b>,
    /// The [`JsonTreeStyle`] that the [`JsonTree`](crate::JsonTree) was configured with.
    pub style: &'b JsonTreeStyle,
    /// If an array/object is under this property, contains the [`egui::collapsing_header::CollapsingState`] for it.
    /// This can be used to toggle or check whether the array/object is expanded. Any mutations will be stored after the render hook.
    pub collapsing_state: Option<&'b mut CollapsingState>,
    pub(crate) search_term: Option<&'b SearchTerm>,
}

impl<T: ToJsonTreeValue> DefaultRender for RenderPropertyContext<'_, '_, T> {
    fn render_default(&self, ui: &mut Ui) -> Response {
        render_property(ui, self.style, &self.property, self.search_term)
    }
}

#[derive(Debug, Clone, Copy)]
pub(crate) enum ParentStatus {
    NoParent,
    ExpandedParent,
    CollapsedRoot,
}

/// A handle to the information of a render call for a non-recursive JSON value.
pub struct RenderBaseValueContext<'a, 'b, T: ToJsonTreeValue> {
    /// The non-recursive JSON value being rendered.
    pub value: &'a T,
    /// A reference to a value that visually represents the JSON value being rendered.
    pub display_value: &'a dyn Display,
    /// The type of the non-recursive JSON value being rendered.
    pub value_type: BaseValueType,
    /// The full JSON pointer to the JSON value being rendered.
    pub pointer: JsonPointer<'a, 'b>,
    /// The [`JsonTreeStyle`] that the [`JsonTree`](crate::JsonTree) was configured with.
    pub style: &'b JsonTreeStyle,
    pub(crate) search_term: Option<&'b SearchTerm>,
    pub(crate) parent_status: ParentStatus,
}

impl<T: ToJsonTreeValue> DefaultRender for RenderBaseValueContext<'_, '_, T> {
    fn render_default(&self, ui: &mut Ui) -> Response {
        render_value(
            ui,
            self.style,
            &self.display_value.to_string(),
            &self.value_type,
            self.search_term,
            self.parent_status,
        )
    }
}

/// A handle to the information of a render call for array brackets or object braces.
pub struct RenderExpandableDelimiterContext<'a, 'b, T: ToJsonTreeValue> {
    /// The specific token of the array bracket or object brace being rendered.
    pub delimiter: ExpandableDelimiter,
    /// The JSON array or object that the delimiter belongs to.
    pub value: &'a T,
    /// The full JSON pointer to the array or object that the delimiter belongs to.
    pub pointer: JsonPointer<'a, 'b>,
    /// The [`JsonTreeStyle`] that the [`JsonTree`](crate::JsonTree) was configured with.
    pub style: &'b JsonTreeStyle,
    /// The [`egui::collapsing_header::CollapsingState`] for the array or object that this delimiter belongs to.
    /// This can be used to toggle or check whether the array/object is expanded. Any mutations will be stored after the render hook.
    pub collapsing_state: &'b mut CollapsingState,
}

impl<T: ToJsonTreeValue> DefaultRender for RenderExpandableDelimiterContext<'_, '_, T> {
    fn render_default(&self, ui: &mut Ui) -> Response {
        render_delimiter(ui, self.style, self.delimiter.as_ref())
    }
}

pub(crate) struct RenderSpacingDelimiterContext<'b> {
    pub(crate) delimiter: SpacingDelimiter,
    pub(crate) style: &'b JsonTreeStyle,
}

impl DefaultRender for RenderSpacingDelimiterContext<'_> {
    fn render_default(&self, ui: &mut Ui) -> Response {
        render_delimiter(ui, self.style, self.delimiter.as_ref())
    }
}

pub(crate) struct JsonTreeRenderer<'a, T: ToJsonTreeValue> {
    pub(crate) render_hook: Option<Box<RenderHook<'a, T>>>,
}

impl<T: ToJsonTreeValue> Default for JsonTreeRenderer<'_, T> {
    fn default() -> Self {
        Self { render_hook: None }
    }
}

impl<'a, T: ToJsonTreeValue> JsonTreeRenderer<'a, T> {
    pub(crate) fn render_property<'b>(
        &mut self,
        ui: &mut Ui,
        context: RenderPropertyContext<'a, 'b, T>,
    ) {
        match self.render_hook.as_mut() {
            Some(render_hook) => {
                render_hook(ui, RenderContext::Property(context));
            }
            None => {
                context.render_default(ui);
            }
        };
    }

    pub(crate) fn render_value<'b>(
        &mut self,
        ui: &mut Ui,
        context: RenderBaseValueContext<'a, 'b, T>,
    ) {
        match self.render_hook.as_mut() {
            Some(render_hook) => {
                render_hook(ui, RenderContext::BaseValue(context));
            }
            None => {
                context.render_default(ui);
            }
        };
    }

    pub(crate) fn render_expandable_delimiter<'b>(
        &mut self,
        ui: &mut Ui,
        context: RenderExpandableDelimiterContext<'a, 'b, T>,
    ) {
        match self.render_hook.as_mut() {
            Some(render_hook) => {
                render_hook(ui, RenderContext::ExpandableDelimiter(context));
            }
            None => {
                context.render_default(ui);
            }
        };
    }

    pub(crate) fn render_spacing_delimiter(
        &mut self,
        ui: &mut Ui,
        context: RenderSpacingDelimiterContext,
    ) {
        context.render_default(ui);
    }
}

#[derive(Default)]
struct ValueLayoutJobCreator;

impl ValueLayoutJobCreator {
    fn create(
        &self,
        visuals: &JsonTreeVisuals,
        value_str: &str,
        value_type: &BaseValueType,
        search_term: Option<&SearchTerm>,
        font_id: &FontId,
    ) -> LayoutJob {
        let color = visuals.get_color(value_type);
        let add_quote_if_string = |job: &mut LayoutJob| {
            if *value_type == BaseValueType::String {
                append(job, "\"", color, None, font_id)
            };
        };
        let mut job = LayoutJob::default();
        add_quote_if_string(&mut job);
        add_text_with_highlighting(
            &mut job,
            value_str,
            color,
            search_term,
            visuals.highlight_color,
            font_id,
        );
        add_quote_if_string(&mut job);
        job
    }
}

impl
    ComputerMut<
        (
            &JsonTreeVisuals,
            &str,
            &BaseValueType,
            Option<&SearchTerm>,
            &FontId,
        ),
        LayoutJob,
    > for ValueLayoutJobCreator
{
    fn compute(
        &mut self,
        (visuals, value_str, value_type, search_term, font_id): (
            &JsonTreeVisuals,
            &str,
            &BaseValueType,
            Option<&SearchTerm>,
            &FontId,
        ),
    ) -> LayoutJob {
        self.create(visuals, value_str, value_type, search_term, font_id)
    }
}

type ValueLayoutJobCreatorCache = FrameCache<LayoutJob, ValueLayoutJobCreator>;

fn render_value(
    ui: &mut Ui,
    style: &JsonTreeStyle,
    value_str: &str,
    value_type: &BaseValueType,
    search_term: Option<&SearchTerm>,
    parent_status: ParentStatus,
) -> Response {
    let mut job = ui.ctx().memory_mut(|mem| {
        mem.caches
            .cache::<ValueLayoutJobCreatorCache>()
            .get((
                style.resolve_visuals(ui),
                value_str,
                value_type,
                search_term,
                &style.resolve_font_id(ui),
            ))
            .clone()
    });
    job.wrap = style.resolve_value_text_wrapping(parent_status, ui);
    render_job(ui, job)
}

#[derive(Default)]
struct PropertyLayoutJobCreator;

impl PropertyLayoutJobCreator {
    fn create(
        &self,
        visuals: &JsonTreeVisuals,
        property: &JsonPointerSegment,
        search_term: Option<&SearchTerm>,
        font_id: &FontId,
    ) -> LayoutJob {
        let mut job = LayoutJob::default();
        match property {
            JsonPointerSegment::Index(_) => add_array_idx(
                &mut job,
                &property.to_string(),
                visuals.array_idx_color,
                font_id,
            ),
            JsonPointerSegment::Key(_) => add_object_key(
                &mut job,
                &property.to_string(),
                visuals.object_key_color,
                search_term,
                visuals.highlight_color,
                font_id,
            ),
        };
        job
    }
}

impl
    ComputerMut<
        (
            &JsonTreeVisuals,
            &JsonPointerSegment<'_>,
            Option<&SearchTerm>,
            &FontId,
        ),
        LayoutJob,
    > for PropertyLayoutJobCreator
{
    fn compute(
        &mut self,
        (visuals, parent, search_term, font_id): (
            &JsonTreeVisuals,
            &JsonPointerSegment,
            Option<&SearchTerm>,
            &FontId,
        ),
    ) -> LayoutJob {
        self.create(visuals, parent, search_term, font_id)
    }
}

type PropertyLayoutJobCreatorCache = FrameCache<LayoutJob, PropertyLayoutJobCreator>;

fn render_property(
    ui: &mut Ui,
    style: &JsonTreeStyle,
    property: &JsonPointerSegment,
    search_term: Option<&SearchTerm>,
) -> Response {
    let job = ui.ctx().memory_mut(|mem| {
        mem.caches
            .cache::<PropertyLayoutJobCreatorCache>()
            .get((
                style.resolve_visuals(ui),
                property,
                search_term,
                &style.resolve_font_id(ui),
            ))
            .clone()
    });

    render_job(ui, job)
}

fn add_object_key(
    job: &mut LayoutJob,
    key_str: &str,
    color: Color32,
    search_term: Option<&SearchTerm>,
    highlight_color: Color32,
    font_id: &FontId,
) {
    append(job, "\"", color, None, font_id);
    add_text_with_highlighting(job, key_str, color, search_term, highlight_color, font_id);
    append(job, "\"", color, None, font_id);
}

fn add_array_idx(job: &mut LayoutJob, idx_str: &str, color: Color32, font_id: &FontId) {
    append(job, idx_str, color, None, font_id);
}

fn add_text_with_highlighting(
    job: &mut LayoutJob,
    text_str: &str,
    text_color: Color32,
    search_term: Option<&SearchTerm>,
    highlight_color: Color32,
    font_id: &FontId,
) {
    if let Some(search_term) = search_term {
        let matches = search_term.find_match_indices_in(text_str);
        if !matches.is_empty() {
            let mut start = 0;
            for match_idx in matches {
                append(job, &text_str[start..match_idx], text_color, None, font_id);

                let highlight_end_idx = match_idx + search_term.len();

                append(
                    job,
                    &text_str[match_idx..highlight_end_idx],
                    text_color,
                    Some(highlight_color),
                    font_id,
                );

                start = highlight_end_idx;
            }
            append(job, &text_str[start..], text_color, None, font_id);
            return;
        }
    }
    append(job, text_str, text_color, None, font_id);
}

fn append(
    job: &mut LayoutJob,
    text_str: &str,
    color: Color32,
    background_color: Option<Color32>,
    font_id: &FontId,
) {
    let mut text_format = TextFormat {
        color,
        font_id: font_id.clone(),
        ..Default::default()
    };

    if let Some(background_color) = background_color {
        text_format.background = background_color;
    }

    job.append(text_str, 0.0, text_format);
}

fn render_delimiter(ui: &mut Ui, style: &JsonTreeStyle, delimiter_str: &str) -> Response {
    let mut job = LayoutJob::default();
    append(
        &mut job,
        delimiter_str,
        style.resolve_visuals(ui).punctuation_color,
        None,
        &style.resolve_font_id(ui),
    );
    render_job(ui, job)
}

fn render_job(ui: &mut Ui, job: LayoutJob) -> Response {
    let galley = ui.fonts_mut(|f| f.layout_job(job));
    ui.add(Label::new(galley).sense(Sense::click_and_drag()))
}