use crate::bstr::{BStr, BString, ByteSlice, ByteVec}; use crate::ext::ObjectIdExt; use crate::{Repository, Tree}; use git_object::TreeRefIter; use git_odb::FindExt; use std::collections::VecDeque; /// The error return by methods on the [diff platform][Platform]. #[derive(Debug, thiserror::Error)] #[allow(missing_docs)] pub enum Error { #[error(transparent)] Diff(#[from] git_diff::tree::changes::Error), #[error("The user-provided callback failed")] ForEach(#[source] Box), } /// Returned by the `for_each` function to control flow. #[derive(Clone, Copy, PartialOrd, PartialEq, Ord, Eq, Hash)] pub enum Action { /// Continue the traversal of changes. Continue, /// Stop the traversal of changes and stop calling this function. Cancel, } impl Default for Action { fn default() -> Self { Action::Continue } } /// Represents any possible change in order to turn one tree into another. #[derive(Debug, Clone, Copy)] pub struct Change<'a, 'old, 'new> { /// The location of the file or directory described by `event`, if tracking was enabled. /// /// Otherwise this value is always an empty path. pub location: &'a BStr, /// The diff event itself to provide information about what would need to change. pub event: change::Event<'old, 'new>, } /// pub mod change { use crate::bstr::ByteSlice; use crate::Id; use git_object::tree::EntryMode; /// An event emitted when finding differences between two trees. #[derive(Debug, Clone, Copy)] pub enum Event<'old, 'new> { /// An entry was added, like the addition of a file or directory. Addition { /// The mode of the added entry. entry_mode: git_object::tree::EntryMode, /// The object id of the added entry. id: Id<'new>, }, /// An entry was deleted, like the deletion of a file or directory. Deletion { /// The mode of the deleted entry. entry_mode: git_object::tree::EntryMode, /// The object id of the deleted entry. id: Id<'old>, }, /// An entry was modified, e.g. changing the contents of a file adjusts its object id and turning /// a file into a symbolic link adjusts its mode. Modification { /// The mode of the entry before the modification. previous_entry_mode: git_object::tree::EntryMode, /// The object id of the entry before the modification. previous_id: Id<'old>, /// The mode of the entry after the modification. entry_mode: git_object::tree::EntryMode, /// The object id after the modification. id: Id<'new>, }, } /// A platform to keep temporary information to perform line diffs. pub struct DiffPlatform<'old, 'new> { old: crate::Object<'old>, new: crate::Object<'new>, } impl<'old, 'new> Event<'old, 'new> { /// Produce a platform for performing a line-diff, or `None` if this is not a [`Modification`][Event::Modification] /// or one of the entries to compare is not a blob. pub fn diff(&self) -> Option, crate::object::find::existing::Error>> { match self { Event::Modification { previous_entry_mode: EntryMode::BlobExecutable | EntryMode::Blob, previous_id, entry_mode: EntryMode::BlobExecutable | EntryMode::Blob, id, } => match previous_id.object().and_then(|old| id.object().map(|new| (old, new))) { Ok((old, new)) => Some(Ok(DiffPlatform { old, new })), Err(err) => Some(Err(err)), }, _ => None, } } } impl<'old, 'new> DiffPlatform<'old, 'new> { /// Create a platform for performing various tasks to diff text. /// /// It can be used to traverse [all line changes](git_diff::lines::similar::TextDiff::iter_all_changes()) for example. // TODO: How should this integrate with configurable algorithms? Maybe users should get it themselves and pass it here? pub fn text<'bufs>( &self, algorithm: git_diff::lines::Algorithm, ) -> git_diff::lines::similar::TextDiff<'_, '_, 'bufs, [u8]> { git_diff::lines::with(self.old.data.as_bstr(), self.new.data.as_bstr(), algorithm) } } } /// Diffing impl<'repo> Tree<'repo> { /// Return a platform to see the changes needed to create other trees, for instance. /// /// # Performance /// /// It's highly recommended to set an object cache to avoid extracting the same object multiple times. pub fn changes<'a>(&'a self) -> Platform<'a, 'repo> { Platform { state: Default::default(), lhs: self, tracking: None, } } } /// The diffing platform returned by [`Tree::changes()`]. #[derive(Clone)] pub struct Platform<'a, 'repo> { state: git_diff::tree::State, lhs: &'a Tree<'repo>, tracking: Option, } #[derive(Clone, Copy)] enum Tracking { FileName, Path, } /// Configuration impl<'a, 'repo> Platform<'a, 'repo> { /// Keep track of file-names, which makes the [`location`][Change::location] field usable with the filename of the changed item. pub fn track_filename(&mut self) -> &mut Self { self.tracking = Some(Tracking::FileName); self } /// Keep track of the entire path of a change, relative to the repository. /// /// This makes the [`location`][Change::location] field usable. pub fn track_path(&mut self) -> &mut Self { self.tracking = Some(Tracking::Path); self } } /// Add the item to compare to. impl<'a, 'old> Platform<'a, 'old> { /// Call `for_each` repeatedly with all changes that are needed to convert the source of the diff to the tree to `other`. pub fn for_each_to_obtain_tree<'new, E>( &mut self, other: &Tree<'new>, for_each: impl FnMut(Change<'_, 'old, 'new>) -> Result, ) -> Result<(), Error> where E: std::error::Error + Sync + Send + 'static, { let repo = self.lhs.repo; let mut delegate = Delegate { repo: self.lhs.repo, other_repo: other.repo, tracking: self.tracking, location: BString::default(), path_deque: Default::default(), visit: for_each, err: None, }; git_diff::tree::Changes::from(TreeRefIter::from_bytes(&self.lhs.data)).needed_to_obtain( TreeRefIter::from_bytes(&other.data), &mut self.state, |oid, buf| repo.objects.find_tree_iter(oid, buf), &mut delegate, )?; match delegate.err { Some(err) => Err(Error::ForEach(Box::new(err))), None => Ok(()), } } } struct Delegate<'old, 'new, VisitFn, E> { repo: &'old Repository, other_repo: &'new Repository, tracking: Option, location: BString, path_deque: VecDeque, visit: VisitFn, err: Option, } impl Delegate<'_, '_, A, B> { fn pop_element(&mut self) { if let Some(pos) = self.location.rfind_byte(b'/') { self.location.resize(pos, 0); } else { self.location.clear(); } } fn push_element(&mut self, name: &BStr) { if !self.location.is_empty() { self.location.push(b'/'); } self.location.push_str(name); } } impl<'old, 'new, VisitFn, E> git_diff::tree::Visit for Delegate<'old, 'new, VisitFn, E> where VisitFn: for<'delegate> FnMut(Change<'delegate, 'old, 'new>) -> Result, E: std::error::Error + Sync + Send + 'static, { fn pop_front_tracked_path_and_set_current(&mut self) { if let Some(Tracking::Path) = self.tracking { self.location = self .path_deque .pop_front() .expect("every call is matched with push_tracked_path_component"); } } fn push_back_tracked_path_component(&mut self, component: &BStr) { if let Some(Tracking::Path) = self.tracking { self.push_element(component); self.path_deque.push_back(self.location.clone()); } } fn push_path_component(&mut self, component: &BStr) { match self.tracking { Some(Tracking::FileName) => { self.location.clear(); self.location.push_str(component); } Some(Tracking::Path) => { self.push_element(component); } None => {} } } fn pop_path_component(&mut self) { if let Some(Tracking::Path) = self.tracking { self.pop_element(); } } fn visit(&mut self, change: git_diff::tree::visit::Change) -> git_diff::tree::visit::Action { use git_diff::tree::visit::Change::*; let event = match change { Addition { entry_mode, oid } => change::Event::Addition { entry_mode, id: oid.attach(self.other_repo), }, Deletion { entry_mode, oid } => change::Event::Deletion { entry_mode, id: oid.attach(self.repo), }, Modification { previous_entry_mode, previous_oid, entry_mode, oid, } => change::Event::Modification { previous_entry_mode, entry_mode, previous_id: previous_oid.attach(self.repo), id: oid.attach(self.other_repo), }, }; match (self.visit)(Change { event, location: self.location.as_ref(), }) { Ok(Action::Cancel) => git_diff::tree::visit::Action::Cancel, Ok(Action::Continue) => git_diff::tree::visit::Action::Continue, Err(err) => { self.err = Some(err); git_diff::tree::visit::Action::Cancel } } } }