The TreeChange now keeps track of the underlying gix status item.

That way it's possible to reconstruct the exact status, and know if it's
coming from a change in the index, or a change in the worktree.

This is relevant later when storing index changes.

Author: Byron

crates/but-core/src/diff/mod.rs

@@ -59,6 +59,15 @@ impl TreeChange {
     }
 }
 
+impl std::fmt::Debug for TreeChange {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        f.debug_struct("TreeChange")
+            .field("path", &self.path)
+            .field("status", &self.status)
+            .finish()
+    }
+}
+
 impl ModeFlags {
     fn calculate(old: &ChangeState, new: &ChangeState) -> Option<Self> {
         Self::calculate_inner(old.kind, new.kind)

crates/but-core/src/diff/tree_changes.rs

@@ -81,6 +81,7 @@ impl From<gix::object::tree::diff::ChangeDetached> for TreeChange {
                     },
                     is_untracked: false,
                 },
+                status_item: None,
             },
             Change::Deletion {
                 location,
@@ -95,6 +96,7 @@ impl From<gix::object::tree::diff::ChangeDetached> for TreeChange {
                         kind: entry_mode.kind(),
                     },
                 },
+                status_item: None,
             },
             Change::Modification {
                 location,
@@ -118,6 +120,7 @@ impl From<gix::object::tree::diff::ChangeDetached> for TreeChange {
                         state,
                         flags: ModeFlags::calculate(&previous_state, &state),
                     },
+                    status_item: None,
                 }
             }
             Change::Rewrite {
@@ -147,6 +150,7 @@ impl From<gix::object::tree::diff::ChangeDetached> for TreeChange {
                         state,
                         flags: ModeFlags::calculate(&previous_state, &state),
                     },
+                    status_item: None,
                 }
             }
         }

crates/but-core/src/diff/worktree.rs

@@ -75,7 +75,7 @@ pub fn worktree_changes(repo: &gix::Repository) -> anyhow::Result<WorktreeChange
     let mut ignored_changes = Vec::new();
     for change in status_changes {
         let change = change?;
-        let change = match change {
+        let change = match change.clone() {
             status::Item::TreeIndex(gix::diff::index::Change::Deletion {
                 location,
                 id,
@@ -91,6 +91,7 @@ pub fn worktree_changes(repo: &gix::Repository) -> anyhow::Result<WorktreeChange
                         },
                     },
                     path: location.into_owned(),
+                    status_item: Some(change),
                 },
             ),
             status::Item::TreeIndex(gix::diff::index::Change::Addition {
@@ -109,6 +110,7 @@ pub fn worktree_changes(repo: &gix::Repository) -> anyhow::Result<WorktreeChange
                             kind: into_tree_entry_kind(entry_mode)?,
                         },
                     },
+                    status_item: Some(change),
                 },
             ),
             status::Item::TreeIndex(gix::diff::index::Change::Modification {
@@ -136,6 +138,7 @@ pub fn worktree_changes(repo: &gix::Repository) -> anyhow::Result<WorktreeChange
                             state,
                             flags: ModeFlags::calculate(&previous_state, &state),
                         },
+                        status_item: Some(change),
                     },
                 )
             }
@@ -154,6 +157,7 @@ pub fn worktree_changes(repo: &gix::Repository) -> anyhow::Result<WorktreeChange
                             kind: into_tree_entry_kind(entry.mode)?,
                         },
                     },
+                    status_item: Some(change),
                 },
             ),
             status::Item::IndexWorktree(index_worktree::Item::Modification {
@@ -180,6 +184,7 @@ pub fn worktree_changes(repo: &gix::Repository) -> anyhow::Result<WorktreeChange
                             state,
                             flags: ModeFlags::calculate(&previous_state, &state),
                         },
+                        status_item: Some(change),
                     },
                 )
             }
@@ -216,6 +221,7 @@ pub fn worktree_changes(repo: &gix::Repository) -> anyhow::Result<WorktreeChange
                             state,
                             flags: ModeFlags::calculate(&previous_state, &state),
                         },
+                        status_item: Some(change),
                     },
                 )
             }
@@ -237,6 +243,7 @@ pub fn worktree_changes(repo: &gix::Repository) -> anyhow::Result<WorktreeChange
                         },
                         is_untracked: false,
                     },
+                    status_item: Some(change),
                 },
             ),
             status::Item::IndexWorktree(index_worktree::Item::DirectoryContents {
@@ -269,17 +276,20 @@ pub fn worktree_changes(repo: &gix::Repository) -> anyhow::Result<WorktreeChange
                             },
                             is_untracked: true,
                         },
+                        status_item: Some(change),
                     },
                 )
             }
             status::Item::IndexWorktree(index_worktree::Item::Modification {
                 rela_path,
                 entry,
                 status:
-                    EntryStatus::Change(index_as_worktree::Change::SubmoduleModification(change)),
+                    EntryStatus::Change(index_as_worktree::Change::SubmoduleModification(
+                        submodule_change,
+                    )),
                 ..
             }) => {
-                let Some(checked_out_head_id) = change.checked_out_head_id else {
+                let Some(checked_out_head_id) = submodule_change.checked_out_head_id else {
                     continue;
                 };
                 // We can arrive here if the user configures to `ignore = none`, and there are
@@ -306,6 +316,7 @@ pub fn worktree_changes(repo: &gix::Repository) -> anyhow::Result<WorktreeChange
                             state,
                             flags: ModeFlags::calculate(&previous_state, &state),
                         },
+                        status_item: Some(change),
                     },
                 )
             }
@@ -361,6 +372,7 @@ pub fn worktree_changes(repo: &gix::Repository) -> anyhow::Result<WorktreeChange
                             state,
                             flags: ModeFlags::calculate(&previous_state, &state),
                         },
+                        status_item: Some(change),
                     },
                 )
             }
@@ -391,6 +403,7 @@ pub fn worktree_changes(repo: &gix::Repository) -> anyhow::Result<WorktreeChange
                             state,
                             flags: ModeFlags::calculate(&previous_state, &state),
                         },
+                        status_item: Some(change),
                     },
                 )
             }
@@ -655,6 +668,8 @@ fn merge_changes(
                 status: TreeStatus::Deletion {
                     previous_state: *previous_state,
                 },
+                // NOTE: not relevant, as renames are disabled for snapshots where this is used.
+                status_item: None,
             }));
         }
         (
@@ -674,6 +689,8 @@ fn merge_changes(
                         // It's just in the index, which to us doesn't exist.
                         is_untracked: true,
                     },
+                    // NOTE: not relevant, as renames are disabled for snapshots where this is used.
+                    status_item: None,
                 }),
                 Some(TreeChange {
                     path: index_wt.path,
@@ -685,6 +702,8 @@ fn merge_changes(
                         // read the initial state of a file from.
                         is_untracked: true,
                     },
+                    // NOTE: not relevant, as renames are disabled for snapshots where this is used.
+                    status_item: None,
                 }),
             ]);
         }

crates/but-core/src/lib.rs

@@ -233,12 +233,16 @@ pub fn open_repo(path: impl Into<PathBuf>) -> anyhow::Result<gix::Repository> {
 ///
 /// For simplicity, copy-tracking is not representable right now, but `copy: bool` could be added
 /// if needed. Copy-tracking is deactivated as well.
-#[derive(Debug, Clone)]
+#[derive(Clone)]
 pub struct TreeChange {
     /// The *relative* path in the worktree where the entry can be found.
     pub path: BString,
     /// The specific information about this change.
     pub status: TreeStatus,
+    /// The status item that this change is derived from, used in places that need detailed information.
+    /// This is only set if this instance was created from a worktree-status, and is `None` when created
+    /// from a tree-diff.
+    pub status_item: Option<gix::status::Item>,
 }
 
 /// Specifically defines a [`TreeChange`].

crates/but-core/src/ui.rs

@@ -269,12 +269,20 @@ impl From<TreeChange> for crate::TreeChange {
         crate::TreeChange {
             path: path_bytes,
             status: status.into(),
+            // Lossy conversion, but this is fine.
+            status_item: None,
         }
     }
 }
 
 impl From<crate::TreeChange> for TreeChange {
-    fn from(crate::TreeChange { path, status }: crate::TreeChange) -> Self {
+    fn from(
+        crate::TreeChange {
+            path,
+            status,
+            status_item: _,
+        }: crate::TreeChange,
+    ) -> Self {
         TreeChange {
             path: path.clone().into(),
             path_bytes: path,