Project configuration fixes & improvements

- Allow config to specify object "target_path" and "base_path" explicitly, rather than relying on relative path from the "target_dir" and "base_dir". Useful for more complex directory layouts.
- Fix watch_patterns in project config not using default.
- Fix "Rebuild on changes" not defaulting to true.
- Keep watching project config updates even when "Rebuild on changes" is false.
- Disable some configuration options when loaded from project config file.

Author: encounter

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "objdiff"
-version = "0.4.0"
+version = "0.4.1"
 edition = "2021"
 rust-version = "1.65"
 authors = ["Luke Street <[email protected]>"]
@@ -27,7 +27,7 @@ byteorder = "1.4.3"
 bytes = "1.4.0"
 cfg-if = "1.0.0"
 const_format = "0.2.31"
-cwdemangle = "0.1.5"
+cwdemangle = "0.1.6"
 dirs = "5.0.1"
 eframe = { version = "0.22.0", features = ["persistence"] }
 egui = "0.22.0"

Cargo.toml

@@ -50,8 +50,11 @@ file as well. You can then add `objdiff.json` to your `.gitignore` to prevent it
 // objdiff.json
 {
   "custom_make": "ninja",
+
+  // Only required if objects use "path" instead of "target_path" and "base_path".
   "target_dir": "build/asm",
   "base_dir": "build/src",
+
   "build_target": true,
   "watch_patterns": [
     "*.c",
@@ -63,34 +66,59 @@ file as well. You can then add `objdiff.json` to your `.gitignore` to prevent it
   ],
   "objects": [
     {
+      "name": "main/MetroTRK/mslsupp",
+
+      // Option 1: Relative to target_dir and base_dir
       "path": "MetroTRK/mslsupp.o",
-      "name": "MetroTRK/mslsupp",
+      // Option 2: Explicit paths from project root
+      // Useful for more complex directory layouts
+      "target_path": "build/asm/MetroTRK/mslsupp.o",
+      "base_path": "build/src/MetroTRK/mslsupp.o",
+      
       "reverse_fn_order": false
     },
     // ...
   ]
 }
 ```
 
-- `custom_make` _(optional)_: By default, objdiff will use `make` to build the project.  
-  If the project uses a different build system (e.g. `ninja`), specify it here.
-- `target_dir`: Relative from the root of the project, this where the "target" or "expected" objects are located.  
-  These are the **intended result** of the match.
-- `base_dir`: Relative from the root of the project, this is where the "base" or "actual" objects are located.  
-  These are objects built from the **current source code**.
-- `build_target`: If true, objdiff will tell the build system to build the target objects before diffing (e.g.
+`custom_make` _(optional)_: By default, objdiff will use `make` to build the project.  
+If the project uses a different build system (e.g. `ninja`), specify it here.
+
+`target_dir` _(optional)_: Relative from the root of the project, this where the "target" or "expected" objects are located.  
+These are the **intended result** of the match.
+
+`base_dir` _(optional)_: Relative from the root of the project, this is where the "base" or "actual" objects are located.  
+These are objects built from the **current source code**.
+
+`build_target`: If true, objdiff will tell the build system to build the target objects before diffing (e.g.
   `make path/to/target.o`).  
-  This is useful if the target objects are not built by default or can change based on project configuration or edits
-  to assembly files.  
-  Requires the build system to be configured properly.
-- `watch_patterns` _(optional)_: A list of glob patterns to watch for changes.
-  ([Supported syntax](https://docs.rs/globset/latest/globset/#syntax))  
-  If any of these files change, objdiff will automatically rebuild the objects and re-compare them.
-- `objects` _(optional)_: If specified, objdiff will display a list of objects in the sidebar for easy navigation.
-    - `path`: Relative path to the object from the `target_dir` and `base_dir`.
-    - `name` _(optional)_: The name of the object in the UI. If not specified, the object's `path` will be used.
-    - `reverse_fn_order` _(optional)_: Displays function symbols in reversed order.  
-      Used to support MWCC's `-inline deferred` option, which reverses the order of functions in the object file.
+This is useful if the target objects are not built by default or can change based on project configuration or edits
+to assembly files.  
+Requires the build system to be configured properly.
+
+`watch_patterns` _(optional)_: A list of glob patterns to watch for changes.
+([Supported syntax](https://docs.rs/globset/latest/globset/#syntax))  
+If any of these files change, objdiff will automatically rebuild the objects and re-compare them.  
+If not specified, objdiff will use the default patterns listed above.
+
+`objects` _(optional)_: If specified, objdiff will display a list of objects in the sidebar for easy navigation.
+
+> `name` _(optional)_: The name of the object in the UI. If not specified, the object's `path` will be used.
+> 
+> `path`: Relative path to the object from the `target_dir` and `base_dir`.  
+> Requires `target_dir` and `base_dir` to be specified.
+> 
+> `target_path`: Path to the target object from the project root.  
+> Required if `path` is not specified.
+> 
+> `base_path`: Path to the base object from the project root.  
+> Required if `path` is not specified.
+> 
+> `reverse_fn_order` _(optional)_: Displays function symbols in reversed order.  
+Used to support MWCC's `-inline deferred` option, which reverses the order of functions in the object file.
+
+
 
 ## License
 

README.md

@@ -40,16 +40,29 @@ pub struct ViewState {
     pub show_project_config: bool,
 }
 
+/// The configuration for a single object file.
+#[derive(Clone, Eq, PartialEq, serde::Deserialize, serde::Serialize)]
+pub struct ObjectConfig {
+    pub name: String,
+    pub target_path: PathBuf,
+    pub base_path: PathBuf,
+    pub reverse_fn_order: Option<bool>,
+}
+
+#[inline]
+fn bool_true() -> bool { true }
+
 #[derive(Default, Clone, serde::Deserialize, serde::Serialize)]
 pub struct AppConfig {
     pub custom_make: Option<String>,
     pub selected_wsl_distro: Option<String>,
     pub project_dir: Option<PathBuf>,
     pub target_obj_dir: Option<PathBuf>,
     pub base_obj_dir: Option<PathBuf>,
-    pub obj_path: Option<String>,
+    pub selected_obj: Option<ObjectConfig>,
     pub build_target: bool,
-    pub watcher_enabled: bool,
+    #[serde(default = "bool_true")]
+    pub rebuild_on_changes: bool,
     pub auto_update_check: bool,
     pub watch_patterns: Vec<Glob>,
 
@@ -65,39 +78,42 @@ pub struct AppConfig {
     pub obj_change: bool,
     #[serde(skip)]
     pub queue_build: bool,
+    #[serde(skip)]
+    pub project_config_loaded: bool,
 }
 
 impl AppConfig {
     pub fn set_project_dir(&mut self, path: PathBuf) {
         self.project_dir = Some(path);
         self.target_obj_dir = None;
         self.base_obj_dir = None;
-        self.obj_path = None;
+        self.selected_obj = None;
         self.build_target = false;
         self.objects.clear();
         self.object_nodes.clear();
         self.watcher_change = true;
         self.config_change = true;
         self.obj_change = true;
         self.queue_build = false;
+        self.project_config_loaded = false;
     }
 
     pub fn set_target_obj_dir(&mut self, path: PathBuf) {
         self.target_obj_dir = Some(path);
-        self.obj_path = None;
+        self.selected_obj = None;
         self.obj_change = true;
         self.queue_build = false;
     }
 
     pub fn set_base_obj_dir(&mut self, path: PathBuf) {
         self.base_obj_dir = Some(path);
-        self.obj_path = None;
+        self.selected_obj = None;
         self.obj_change = true;
         self.queue_build = false;
     }
 
-    pub fn set_obj_path(&mut self, path: String) {
-        self.obj_path = Some(path);
+    pub fn set_selected_obj(&mut self, object: ObjectConfig) {
+        self.selected_obj = Some(object);
         self.obj_change = true;
         self.queue_build = false;
     }
@@ -258,19 +274,19 @@ impl App {
 
         if config.obj_change {
             *diff_state = Default::default();
-            if config.obj_path.is_some() {
+            if config.selected_obj.is_some() {
                 config.queue_build = true;
             }
             config.obj_change = false;
         }
 
-        if self.modified.swap(false, Ordering::Relaxed) {
+        if self.modified.swap(false, Ordering::Relaxed) && config.rebuild_on_changes {
             config.queue_build = true;
         }
 
         // Don't clear `queue_build` if a build is running. A file may have been modified during
         // the build, so we'll start another build after the current one finishes.
-        if config.queue_build && config.obj_path.is_some() && !jobs.is_running(Job::ObjDiff) {
+        if config.queue_build && config.selected_obj.is_some() && !jobs.is_running(Job::ObjDiff) {
             jobs.push(start_build(self.config.clone()));
             config.queue_build = false;
         }

src/app.rs

@@ -6,7 +6,7 @@ use std::{
 use anyhow::{Context, Result};
 use globset::{Glob, GlobSet, GlobSetBuilder};
 
-use crate::app::AppConfig;
+use crate::{app::AppConfig, views::config::DEFAULT_WATCH_PATTERNS};
 
 #[derive(Default, Clone, serde::Deserialize)]
 #[serde(default)]
@@ -15,18 +15,32 @@ pub struct ProjectConfig {
     pub target_dir: Option<PathBuf>,
     pub base_dir: Option<PathBuf>,
     pub build_target: bool,
-    pub watch_patterns: Vec<Glob>,
+    pub watch_patterns: Option<Vec<Glob>>,
     #[serde(alias = "units")]
     pub objects: Vec<ProjectObject>,
 }
 
 #[derive(Default, Clone, serde::Deserialize)]
 pub struct ProjectObject {
     pub name: Option<String>,
-    pub path: PathBuf,
+    pub path: Option<PathBuf>,
+    pub target_path: Option<PathBuf>,
+    pub base_path: Option<PathBuf>,
     pub reverse_fn_order: Option<bool>,
 }
 
+impl ProjectObject {
+    pub fn name(&self) -> &str {
+        if let Some(name) = &self.name {
+            name
+        } else if let Some(path) = &self.path {
+            path.to_str().unwrap_or("[invalid path]")
+        } else {
+            "[unknown]"
+        }
+    }
+}
+
 #[derive(Clone)]
 pub enum ProjectObjectNode {
     File(String, ProjectObject),
@@ -53,11 +67,22 @@ fn find_dir<'a>(
     unreachable!();
 }
 
-fn build_nodes(objects: &[ProjectObject]) -> Vec<ProjectObjectNode> {
+fn build_nodes(
+    objects: &[ProjectObject],
+    project_dir: &PathBuf,
+    target_obj_dir: &Option<PathBuf>,
+    base_obj_dir: &Option<PathBuf>,
+) -> Vec<ProjectObjectNode> {
     let mut nodes = vec![];
     for object in objects {
         let mut out_nodes = &mut nodes;
-        let path = object.name.as_ref().map(Path::new).unwrap_or(&object.path);
+        let path = if let Some(name) = &object.name {
+            Path::new(name)
+        } else if let Some(path) = &object.path {
+            path
+        } else {
+            continue;
+        };
         if let Some(parent) = path.parent() {
             for component in parent.components() {
                 if let Component::Normal(name) = component {
@@ -66,8 +91,23 @@ fn build_nodes(objects: &[ProjectObject]) -> Vec<ProjectObjectNode> {
                 }
             }
         }
+        let mut object = object.clone();
+        if let (Some(target_obj_dir), Some(path), None) =
+            (target_obj_dir, &object.path, &object.target_path)
+        {
+            object.target_path = Some(target_obj_dir.join(path));
+        } else if let Some(path) = &object.target_path {
+            object.target_path = Some(project_dir.join(path));
+        }
+        if let (Some(base_obj_dir), Some(path), None) =
+            (base_obj_dir, &object.path, &object.base_path)
+        {
+            object.base_path = Some(base_obj_dir.join(path));
+        } else if let Some(path) = &object.base_path {
+            object.base_path = Some(project_dir.join(path));
+        }
         let filename = path.file_name().unwrap().to_str().unwrap().to_string();
-        out_nodes.push(ProjectObjectNode::File(filename, object.clone()));
+        out_nodes.push(ProjectObjectNode::File(filename, object));
     }
     nodes
 }
@@ -84,10 +124,14 @@ pub fn load_project_config(config: &mut AppConfig) -> Result<()> {
         config.target_obj_dir = project_config.target_dir.map(|p| project_dir.join(p));
         config.base_obj_dir = project_config.base_dir.map(|p| project_dir.join(p));
         config.build_target = project_config.build_target;
-        config.watch_patterns = project_config.watch_patterns;
+        config.watch_patterns = project_config.watch_patterns.unwrap_or_else(|| {
+            DEFAULT_WATCH_PATTERNS.iter().map(|s| Glob::new(s).unwrap()).collect()
+        });
         config.watcher_change = true;
         config.objects = project_config.objects;
-        config.object_nodes = build_nodes(&config.objects);
+        config.object_nodes =
+            build_nodes(&config.objects, project_dir, &config.target_obj_dir, &config.base_obj_dir);
+        config.project_config_loaded = true;
     }
     Ok(())
 }