objdiff/objdiff-gui/src/views/function_diff.rs

use std::{cmp::Ordering, default::Default};

use egui::{Label, Response, Sense, Widget, text::LayoutJob};
use egui_extras::TableRow;
use objdiff_core::{
    diff::{
        DiffObjConfig, InstructionDiffKind, InstructionDiffRow, ObjectDiff,
        display::{
            DiffText, DiffTextColor, DiffTextSegment, HighlightKind, display_row,
            instruction_context, instruction_hover,
        },
    },
    obj::{InstructionArgValue, InstructionRef, Object},
    util::ReallySigned,
};

use crate::views::{
    appearance::Appearance,
    diff::{context_menu_items_ui, hover_items_ui},
    symbol_diff::DiffViewAction,
};

#[derive(Default)]
pub struct FunctionViewState {
    left_highlight: HighlightKind,
    right_highlight: HighlightKind,
}

impl FunctionViewState {
    pub fn highlight(&self, column: usize) -> &HighlightKind {
        match column {
            0 => &self.left_highlight,
            1 => &self.right_highlight,
            _ => &HighlightKind::None,
        }
    }

    pub fn set_highlight(&mut self, column: usize, highlight: HighlightKind) {
        match column {
            0 => {
                if highlight == self.left_highlight {
                    if highlight == self.right_highlight {
                        self.left_highlight = HighlightKind::None;
                        self.right_highlight = HighlightKind::None;
                    } else {
                        self.right_highlight = self.left_highlight.clone();
                    }
                } else {
                    self.left_highlight = highlight;
                }
            }
            1 => {
                if highlight == self.right_highlight {
                    if highlight == self.left_highlight {
                        self.left_highlight = HighlightKind::None;
                        self.right_highlight = HighlightKind::None;
                    } else {
                        self.left_highlight = self.right_highlight.clone();
                    }
                } else {
                    self.right_highlight = highlight;
                }
            }
            _ => {}
        }
    }

    pub fn clear_highlight(&mut self) {
        self.left_highlight = HighlightKind::None;
        self.right_highlight = HighlightKind::None;
    }
}

fn ins_hover_ui(
    ui: &mut egui::Ui,
    obj: &Object,
    symbol_idx: usize,
    ins_ref: InstructionRef,
    diff_config: &DiffObjConfig,
    appearance: &Appearance,
) {
    let Some(resolved) = obj.resolve_instruction_ref(symbol_idx, ins_ref) else {
        ui.colored_label(appearance.delete_color, "Failed to resolve instruction");
        return;
    };
    let ins = match obj.arch.process_instruction(resolved, diff_config) {
        Ok(ins) => ins,
        Err(e) => {
            ui.colored_label(
                appearance.delete_color,
                format!("Failed to process instruction: {e}"),
            );
            return;
        }
    };

    ui.scope(|ui| {
        ui.style_mut().override_text_style = Some(egui::TextStyle::Monospace);
        ui.style_mut().wrap_mode = Some(egui::TextWrapMode::Wrap);
        hover_items_ui(ui, instruction_hover(obj, resolved, &ins), appearance);
    });
}

fn ins_context_menu(
    ui: &mut egui::Ui,
    obj: &Object,
    symbol_idx: usize,
    ins_ref: InstructionRef,
    column: usize,
    diff_config: &DiffObjConfig,
    appearance: &Appearance,
) {
    let Some(resolved) = obj.resolve_instruction_ref(symbol_idx, ins_ref) else {
        ui.colored_label(appearance.delete_color, "Failed to resolve instruction");
        return;
    };
    let ins = match obj.arch.process_instruction(resolved, diff_config) {
        Ok(ins) => ins,
        Err(e) => {
            ui.colored_label(
                appearance.delete_color,
                format!("Failed to process instruction: {e}"),
            );
            return;
        }
    };

    ui.scope(|ui| {
        ui.style_mut().override_text_style = Some(egui::TextStyle::Monospace);
        ui.style_mut().wrap_mode = Some(egui::TextWrapMode::Truncate);
        context_menu_items_ui(ui, instruction_context(obj, resolved, &ins), column, appearance);
    });
}

#[must_use]
fn diff_text_ui(
    ui: &mut egui::Ui,
    segment: DiffTextSegment,
    appearance: &Appearance,
    ins_view_state: &FunctionViewState,
    column: usize,
    space_width: f32,
    response_cb: impl Fn(Response) -> Response,
) -> Option<DiffViewAction> {
    let highlight_kind = HighlightKind::from(&segment.text);
    let label_text = match segment.text {
        DiffText::Basic(text) => text.to_string(),
        DiffText::Line(num) => format!("{num} "),
        DiffText::Address(addr) => format!("{:x}:", addr),
        DiffText::Opcode(mnemonic, _op) => format!("{mnemonic} "),
        DiffText::Argument(arg) => match arg {
            InstructionArgValue::Signed(v) => format!("{:#x}", ReallySigned(v)),
            InstructionArgValue::Unsigned(v) => format!("{:#x}", v),
            InstructionArgValue::Opaque(v) => v.into_owned(),
        },
        DiffText::BranchDest(addr) => format!("{addr:x}"),
        DiffText::Symbol(sym) => sym.demangled_name.as_ref().unwrap_or(&sym.name).clone(),
        DiffText::Addend(addend) => match addend.cmp(&0i64) {
            Ordering::Greater => format!("+{:#x}", addend),
            Ordering::Less => format!("-{:#x}", -addend),
            _ => String::new(),
        },
        DiffText::Spacing(n) => {
            ui.add_space(n as f32 * space_width);
            return None;
        }
        DiffText::Eol => "\n".to_string(),
    };

    let len = label_text.len();
    let highlight = highlight_kind != HighlightKind::None
        && *ins_view_state.highlight(column) == highlight_kind;
    let color = match segment.color {
        DiffTextColor::Normal => appearance.text_color,
        DiffTextColor::Dim => appearance.deemphasized_text_color,
        DiffTextColor::Bright => appearance.emphasized_text_color,
        DiffTextColor::Replace => appearance.replace_color,
        DiffTextColor::Delete => appearance.delete_color,
        DiffTextColor::Insert => appearance.insert_color,
        DiffTextColor::Rotating(i) => {
            appearance.diff_colors[i as usize % appearance.diff_colors.len()]
        }
    };
    let mut response = Label::new(LayoutJob::single_section(
        label_text,
        appearance.code_text_format(color, highlight),
    ))
    .sense(Sense::click())
    .ui(ui);
    response = response_cb(response);
    let mut ret = None;
    if response.clicked() {
        ret = Some(DiffViewAction::SetDiffHighlight(column, highlight_kind));
    }
    if len < segment.pad_to as usize {
        ui.add_space((segment.pad_to as usize - len) as f32 * space_width);
    }
    ret
}

#[must_use]
fn asm_row_ui(
    ui: &mut egui::Ui,
    obj: &Object,
    ins_diff: &InstructionDiffRow,
    symbol_idx: usize,
    appearance: &Appearance,
    ins_view_state: &FunctionViewState,
    diff_config: &DiffObjConfig,
    column: usize,
    response_cb: impl Fn(Response) -> Response,
) -> Option<DiffViewAction> {
    let mut ret = None;
    ui.spacing_mut().item_spacing.x = 0.0;
    ui.style_mut().wrap_mode = Some(egui::TextWrapMode::Extend);
    if ins_diff.kind != InstructionDiffKind::None {
        ui.painter().rect_filled(ui.available_rect_before_wrap(), 0.0, ui.visuals().faint_bg_color);
    }
    let space_width = ui.fonts(|f| f.glyph_width(&appearance.code_font, ' '));
    display_row(obj, symbol_idx, ins_diff, diff_config, |segment| {
        if let Some(action) =
            diff_text_ui(ui, segment, appearance, ins_view_state, column, space_width, &response_cb)
        {
            ret = Some(action);
        }
        Ok(())
    })
    .unwrap();
    ret
}

#[must_use]
pub(crate) fn asm_col_ui(
    row: &mut TableRow<'_, '_>,
    ctx: FunctionDiffContext<'_>,
    appearance: &Appearance,
    ins_view_state: &FunctionViewState,
    diff_config: &DiffObjConfig,
    column: usize,
) -> Option<DiffViewAction> {
    let mut ret = None;
    let symbol_ref = ctx.symbol_ref?;
    let ins_row = &ctx.diff.symbols[symbol_ref].instruction_rows[row.index()];
    let response_cb = |response: Response| {
        if let Some(ins_ref) = ins_row.ins_ref {
            response.context_menu(|ui| {
                ins_context_menu(ui, ctx.obj, symbol_ref, ins_ref, column, diff_config, appearance)
            });
            response.on_hover_ui_at_pointer(|ui| {
                ins_hover_ui(ui, ctx.obj, symbol_ref, ins_ref, diff_config, appearance)
            })
        } else {
            response
        }
    };
    let (_, response) = row.col(|ui| {
        if let Some(action) = asm_row_ui(
            ui,
            ctx.obj,
            ins_row,
            symbol_ref,
            appearance,
            ins_view_state,
            diff_config,
            column,
            response_cb,
        ) {
            ret = Some(action);
        }
    });
    response_cb(response);
    ret
}

#[derive(Clone, Copy)]
pub struct FunctionDiffContext<'a> {
    pub obj: &'a Object,
    pub diff: &'a ObjectDiff,
    pub symbol_ref: Option<usize>,
}