Support loading diff options from project config

Author: encounter

Cargo.lock

@@ -111,6 +111,25 @@
       "items": {
         "$ref": "#/$defs/progress_category"
       }
+    },
+    "options": {
+      "type": "object",
+      "description": "Diff configuration options that should be applied automatically when the project is loaded.",
+      "additionalProperties": {
+        "oneOf": [
+          {
+            "type": "boolean"
+          },
+          {
+            "type": "string"
+          }
+        ]
+      },
+      "examples": [
+        {
+          "demangler": "gnu_legacy"
+        }
+      ]
     }
   },
   "$defs": {

config.schema.json

@@ -24,7 +24,7 @@ use objdiff_core::{
         watcher::{Watcher, create_watcher},
     },
     config::{
-        ProjectConfig, ProjectObject, ProjectObjectMetadata, build_globset,
+        ProjectConfig, ProjectObject, ProjectObjectMetadata, apply_project_options, build_globset,
         path::{check_path_buf, platform_path, platform_path_serde_option},
     },
     diff::{DiffObjConfig, MappingConfig, ObjectDiff},
@@ -164,8 +164,14 @@ pub fn run(args: Args) -> Result<()> {
     run_interactive(args, target_path, base_path, project_config)
 }
 
-fn build_config_from_args(args: &Args) -> Result<(DiffObjConfig, MappingConfig)> {
+fn build_config_from_args(
+    args: &Args,
+    project_config: Option<&ProjectConfig>,
+) -> Result<(DiffObjConfig, MappingConfig)> {
     let mut diff_config = DiffObjConfig::default();
+    if let Some(options) = project_config.and_then(|config| config.options.as_ref()) {
+        apply_project_options(&mut diff_config, options)?;
+    }
     apply_config_args(&mut diff_config, &args.config)?;
     let mut mapping_config = MappingConfig {
         mappings: Default::default(),
@@ -320,7 +326,7 @@ fn run_interactive(
     let Some(symbol_name) = &args.symbol else { bail!("Interactive mode requires a symbol name") };
     let time_format = time::format_description::parse_borrowed::<2>("[hour]:[minute]:[second]")
         .context("Failed to parse time format")?;
-    let (diff_obj_config, mapping_config) = build_config_from_args(&args)?;
+    let (diff_obj_config, mapping_config) = build_config_from_args(&args, project_config.as_ref())?;
     let mut state = AppState {
         jobs: Default::default(),
         waker: Default::default(),

objdiff-cli/src/cmd/diff.rs

@@ -7,7 +7,7 @@ use objdiff_core::{
         ChangeItem, ChangeItemInfo, ChangeUnit, Changes, ChangesInput, Measures, REPORT_VERSION,
         Report, ReportCategory, ReportItem, ReportItemMetadata, ReportUnit, ReportUnitMetadata,
     },
-    config::path::platform_path,
+    config::{apply_project_options, path::platform_path},
     diff,
     obj::{self, SectionKind, SymbolFlag, SymbolKind},
 };
@@ -90,7 +90,6 @@ fn generate(args: GenerateArgs) -> Result<()> {
         ppc_calculate_pool_relocations: false,
         ..Default::default()
     };
-    apply_config_args(&mut diff_config, &args.config)?;
 
     let output_format = OutputFormat::from_option(args.format.as_deref())?;
     let project_dir = args.project.as_deref().unwrap_or_else(|| Utf8PlatformPath::new("."));
@@ -101,6 +100,10 @@ fn generate(args: GenerateArgs) -> Result<()> {
         Some((Err(err), _)) => bail!("Failed to load project configuration: {}", err),
         None => bail!("No project configuration found"),
     };
+    if let Some(options) = project.options.as_ref() {
+        apply_project_options(&mut diff_config, options)?;
+    }
+    apply_config_args(&mut diff_config, &args.config)?;
     info!(
         "Generating report for {} units (using {} threads)",
         project.units().len(),

objdiff-cli/src/cmd/report.rs

@@ -1,6 +1,7 @@
 pub mod path;
 
 use alloc::{
+    borrow::Cow,
     collections::BTreeMap,
     string::{String, ToString},
     vec::Vec,
@@ -45,6 +46,8 @@ pub struct ProjectConfig {
     pub units: Option<Vec<ProjectObject>>,
     #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub progress_categories: Option<Vec<ProjectProgressCategory>>,
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
+    pub options: Option<ProjectOptions>,
 }
 
 impl ProjectConfig {
@@ -143,6 +146,15 @@ pub struct ProjectProgressCategory {
     pub name: String,
 }
 
+pub type ProjectOptions = BTreeMap<String, ProjectOptionValue>;
+
+#[derive(Clone, Debug)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize), serde(untagged))]
+pub enum ProjectOptionValue {
+    Bool(bool),
+    String(String),
+}
+
 impl ProjectObject {
     pub fn name(&self) -> &str {
         if let Some(name) = &self.name {
@@ -310,3 +322,47 @@ pub fn build_globset(vec: &[Glob]) -> Result<GlobSet, globset::Error> {
     }
     builder.build()
 }
+
+#[cfg(feature = "any-arch")]
+pub fn apply_project_options(
+    diff_config: &mut crate::diff::DiffObjConfig,
+    options: &ProjectOptions,
+) -> Result<()> {
+    use core::str::FromStr;
+
+    use crate::diff::{ConfigEnum, ConfigPropertyId, ConfigPropertyKind};
+
+    let mut result = Ok(());
+    for (key, value) in options.iter() {
+        let property_id = ConfigPropertyId::from_str(key)
+            .map_err(|()| anyhow!("Invalid configuration property: {key}"))?;
+        let value = match value {
+            ProjectOptionValue::Bool(value) => Cow::Borrowed(if *value { "true" } else { "false" }),
+            ProjectOptionValue::String(value) => Cow::Borrowed(value.as_str()),
+        };
+        if diff_config.set_property_value_str(property_id, &value).is_err() {
+            if result.is_err() {
+                // Already returning an error, skip further errors
+                continue;
+            }
+            let mut expected = String::new();
+            match property_id.kind() {
+                ConfigPropertyKind::Boolean => expected.push_str("true, false"),
+                ConfigPropertyKind::Choice(variants) => {
+                    for (idx, variant) in variants.iter().enumerate() {
+                        if idx > 0 {
+                            expected.push_str(", ");
+                        }
+                        expected.push_str(variant.value);
+                    }
+                }
+            }
+            result = Err(anyhow!(
+                "Invalid value for {}. Expected one of: {}",
+                property_id.name(),
+                expected
+            ));
+        }
+    }
+    result
+}

objdiff-core/src/config/mod.rs

@@ -32,6 +32,7 @@ cwdemangle = "1.0"
 dirs = "6.0"
 egui = "0.32"
 egui_extras = "0.32"
+egui-notify = "0.20"
 filetime = "0.2"
 float-ord = "0.3"
 font-kit = "0.14"

objdiff-gui/Cargo.toml

@@ -11,14 +11,15 @@ use std::{
     time::Instant,
 };
 
+use egui::text::LayoutJob;
 use filetime::FileTime;
 use globset::Glob;
 use objdiff_core::{
     build::watcher::{Watcher, create_watcher},
     config::{
-        ProjectConfig, ProjectConfigInfo, ProjectObject, ScratchConfig, build_globset,
-        default_ignore_patterns, default_watch_patterns, path::platform_path_serde_option,
-        save_project_config,
+        ProjectConfig, ProjectConfigInfo, ProjectObject, ScratchConfig, apply_project_options,
+        build_globset, default_ignore_patterns, default_watch_patterns,
+        path::platform_path_serde_option, save_project_config,
     },
     diff::DiffObjConfig,
     jobs::{Job, JobQueue, JobResult},
@@ -164,7 +165,7 @@ pub struct AppState {
     pub selecting_left: Option<String>,
     /// The left object symbol name that we're selecting a right symbol for
     pub selecting_right: Option<String>,
-    pub config_error: Option<String>,
+    pub top_left_toasts: egui_notify::Toasts,
 }
 
 impl Default for AppState {
@@ -183,11 +184,23 @@ impl Default for AppState {
             last_mod_check: Instant::now(),
             selecting_left: None,
             selecting_right: None,
-            config_error: None,
+            top_left_toasts: create_toasts(egui_notify::Anchor::TopLeft),
         }
     }
 }
 
+pub fn create_toasts(anchor: egui_notify::Anchor) -> egui_notify::Toasts {
+    egui_notify::Toasts::default()
+        .with_anchor(anchor)
+        .with_margin(egui::vec2(10.0, 32.0))
+        .with_shadow(egui::Shadow {
+            offset: [0, 0],
+            blur: 0,
+            spread: 1,
+            color: egui::Color32::GRAY,
+        })
+}
+
 #[derive(Clone, serde::Deserialize, serde::Serialize)]
 pub struct AppConfig {
     // TODO: https://github.com/ron-rs/ron/pull/455
@@ -321,6 +334,17 @@ impl AppState {
         self.selecting_right = None;
     }
 
+    pub fn effective_diff_config(&self) -> DiffObjConfig {
+        let mut config = self.config.diff_obj_config.clone();
+        if let Some(options) =
+            self.current_project_config.as_ref().and_then(|project| project.options.as_ref())
+        {
+            // Ignore errors here, we display them when loading the project config
+            let _ = apply_project_options(&mut config, options);
+        }
+        config
+    }
+
     pub fn set_selecting_left(&mut self, right: &str) {
         let Some(object) = self.config.selected_obj.as_mut() else {
             return;
@@ -401,11 +425,22 @@ impl AppState {
         match save_project_config(config, info) {
             Ok(new_info) => *info = new_info,
             Err(e) => {
-                log::error!("Failed to save project config: {e}");
-                self.config_error = Some(format!("Failed to save project config: {e}"));
+                log::error!("Failed to save project config: {e:#}");
+                self.show_error_toast("Failed to save project config", &e);
             }
         }
     }
+
+    pub fn show_error_toast(&mut self, context: &str, e: &anyhow::Error) {
+        let mut job = LayoutJob::default();
+        job.append(context, 0.0, Default::default());
+        job.append("\n", 0.0, Default::default());
+        job.append(&format!("{e:#}"), 0.0, egui::TextFormat {
+            color: egui::Color32::LIGHT_RED,
+            ..Default::default()
+        });
+        self.top_left_toasts.error(job).closable(true).duration(None);
+    }
 }
 
 pub type AppStateRef = Arc<RwLock<AppState>>;
@@ -548,12 +583,9 @@ impl App {
 
         if state.config_change {
             state.config_change = false;
-            match load_project_config(state) {
-                Ok(()) => state.config_error = None,
-                Err(e) => {
-                    log::error!("Failed to load project config: {e}");
-                    state.config_error = Some(e.to_string());
-                }
+            if let Err(e) = load_project_config(state) {
+                log::error!("Failed to load project config: {e:#}");
+                state.show_error_toast("Failed to load project config", &e);
             }
         }
 
@@ -579,7 +611,10 @@ impl App {
                         .map_err(anyhow::Error::new)
                     }) {
                     Ok(watcher) => self.watcher = Some(watcher),
-                    Err(e) => log::error!("Failed to create watcher: {e}"),
+                    Err(e) => {
+                        log::error!("Failed to create watcher: {e:#}");
+                        state.show_error_toast("Failed to create file watcher", &e);
+                    }
                 }
                 state.watcher_change = false;
             }
@@ -806,7 +841,7 @@ impl eframe::App for App {
         let mut action = None;
         egui::CentralPanel::default().show(ctx, |ui| {
             let state = state.read().unwrap();
-            action = diff_view_ui(ui, diff_state, appearance, &state.config.diff_obj_config);
+            action = diff_view_ui(ui, diff_state, appearance, &state.effective_diff_config());
         });
 
         project_window(ctx, state, show_project_config, config_state, appearance);
@@ -818,6 +853,10 @@ impl eframe::App for App {
         graphics_window(ctx, show_graphics, frame_history, graphics_state, appearance);
         jobs_window(ctx, show_jobs, jobs, appearance);
 
+        if let Ok(mut state) = self.state.write() {
+            state.top_left_toasts.show(ctx);
+        }
+
         self.post_update(ctx, action);
     }
 

objdiff-gui/src/app.rs

@@ -1,6 +1,11 @@
 use anyhow::Result;
 use globset::Glob;
-use objdiff_core::config::{default_ignore_patterns, default_watch_patterns, try_project_config};
+use objdiff_core::{
+    config::{
+        apply_project_options, default_ignore_patterns, default_watch_patterns, try_project_config,
+    },
+    diff::DiffObjConfig,
+};
 use typed_path::{Utf8UnixComponent, Utf8UnixPath};
 
 use crate::app::{AppState, ObjectConfig};
@@ -124,6 +129,15 @@ pub fn load_project_config(state: &mut AppState) -> Result<()> {
         state.object_nodes = build_nodes(&mut state.objects);
         state.current_project_config = Some(project_config);
         state.project_config_info = Some(info);
+        if let Some(options) =
+            state.current_project_config.as_ref().and_then(|project| project.options.as_ref())
+        {
+            let mut diff_config = DiffObjConfig::default();
+            if let Err(e) = apply_project_options(&mut diff_config, options) {
+                log::error!("Failed to apply project config options: {e:#}");
+                state.show_error_toast("Failed to apply project config options", &e);
+            }
+        }
 
         // Reload selected object
         if let Some(selected_obj) = &state.config.selected_obj {

objdiff-gui/src/config.rs

@@ -106,7 +106,7 @@ pub fn create_objdiff_config(state: &AppState) -> objdiff::ObjDiffConfig {
             .as_ref()
             .and_then(|obj| obj.base_path.as_ref())
             .cloned(),
-        diff_obj_config: state.config.diff_obj_config.clone(),
+        diff_obj_config: state.effective_diff_config(),
         mapping_config: MappingConfig {
             mappings: state
                 .config