fix!: leave more control to the user when creating pathspecs

Author: Byron

gix/src/dirwalk.rs

@@ -17,6 +17,7 @@ pub struct Options {
     emit_empty_directories: bool,
     classify_untracked_bare_repositories: bool,
     emit_collapsed: Option<CollapsedEntriesEmissionMode>,
+    pub(crate) use_prefix: bool,
 }
 
 /// Construction
@@ -34,6 +35,7 @@ impl Options {
             emit_empty_directories: false,
             classify_untracked_bare_repositories: false,
             emit_collapsed: None,
+            use_prefix: false,
         }
     }
 }
@@ -57,6 +59,14 @@ impl From<Options> for gix_dir::walk::Options {
 }
 
 impl Options {
+    /// If `true`, default `false`, pathspecs and the directory walk itself will be setup to use the [prefix](crate::Repository::prefix).
+    ///
+    /// This means that the directory walk will be limited to only what's inside the [repository prefix](crate::Repository::prefix).
+    /// By default, the directory walk will see everything.
+    pub fn use_prefix(mut self, toggle: bool) -> Self {
+        self.use_prefix = toggle;
+        self
+    }
     /// If `toggle` is `true`, we will stop figuring out if any directory that is a candidate for recursion is also a nested repository,
     /// which saves time but leads to recurse into it. If `false`, nested repositories will not be traversed.
     pub fn recurse_repositories(mut self, toggle: bool) -> Self {

gix/src/repository/dirwalk.rs

@@ -1,5 +1,5 @@
 use crate::bstr::BStr;
-use crate::{config, dirwalk, Repository};
+use crate::{config, dirwalk, AttributeStack, Pathspec, Repository};
 use std::path::PathBuf;
 
 /// The error returned by [dirwalk()](Repository::dirwalk()).
@@ -20,6 +20,19 @@ pub enum Error {
     FilesystemOptions(#[from] config::boolean::Error),
 }
 
+/// The outcome of the [dirwalk()](Repository::dirwalk).
+pub struct Outcome<'repo> {
+    /// The excludes stack used for the dirwalk, for access of `.gitignore` information.
+    pub excludes: AttributeStack<'repo>,
+    /// The pathspecs used to guide the operation,
+    pub pathspec: Pathspec<'repo>,
+    /// The root actually being used for the traversal, and useful to transform the paths returned for the user.
+    /// It's always within the [`work-dir`](Repository::work_dir).
+    pub traversal_root: PathBuf,
+    /// The actual result of the dirwalk.
+    pub dirwalk: gix_dir::walk::Outcome,
+}
+
 impl Repository {
     /// Return default options suitable for performing a directory walk on this repository.
     ///
@@ -42,54 +55,61 @@ impl Repository {
         patterns: impl IntoIterator<Item = impl AsRef<BStr>>,
         options: dirwalk::Options,
         delegate: &mut dyn gix_dir::walk::Delegate,
-    ) -> Result<(gix_dir::walk::Outcome, PathBuf), Error> {
+    ) -> Result<Outcome<'_>, Error> {
         let _span = gix_trace::coarse!("gix::dirwalk");
         let workdir = self.work_dir().ok_or(Error::MissinWorkDir)?;
-        let mut excludes = self
-            .excludes(
-                index,
-                None,
-                crate::worktree::stack::state::ignore::Source::WorktreeThenIdMappingIfNotSkipped,
-            )?
-            .detach();
-        let (mut pathspec, mut maybe_attributes) = self
-            .pathspec(
-                patterns,
-                true, /* inherit ignore case */
-                index,
-                crate::worktree::stack::state::attributes::Source::WorktreeThenIdMapping,
-            )?
-            .into_parts();
-        gix_trace::debug!(patterns = ?pathspec.patterns().map(|p| p.path()).collect::<Vec<_>>());
+        let mut excludes = self.excludes(
+            index,
+            None,
+            crate::worktree::stack::state::ignore::Source::WorktreeThenIdMappingIfNotSkipped,
+        )?;
+        let mut pathspec = self.pathspec(
+            patterns,
+            true, /* inherit ignore case */
+            index,
+            crate::worktree::stack::state::attributes::Source::WorktreeThenIdMapping,
+        )?;
+        gix_trace::debug!(
+            longest_prefix = ?pathspec.search.longest_common_directory(),
+            prefix_dir = ?pathspec.search.prefix_directory(),
+            patterns = ?pathspec.search.patterns().map(gix_pathspec::Pattern::path).collect::<Vec<_>>()
+        );
 
         let git_dir_realpath =
             crate::path::realpath_opts(self.git_dir(), self.current_dir(), crate::path::realpath::MAX_SYMLINKS)?;
         let fs_caps = self.filesystem_options()?;
         let accelerate_lookup = fs_caps.ignore_case.then(|| index.prepare_icase_backing());
-        gix_dir::walk(
+        let (outcome, traversal_root) = gix_dir::walk(
             workdir,
             gix_dir::walk::Context {
                 git_dir_realpath: git_dir_realpath.as_ref(),
                 current_dir: self.current_dir(),
                 index,
                 ignore_case_index_lookup: accelerate_lookup.as_ref(),
-                pathspec: &mut pathspec,
+                pathspec: &mut pathspec.search,
                 pathspec_attributes: &mut |relative_path, case, is_dir, out| {
-                    let stack = maybe_attributes
+                    let stack = pathspec
+                        .stack
                         .as_mut()
                         .expect("can only be called if attributes are used in patterns");
                     stack
                         .set_case(case)
                         .at_entry(relative_path, Some(is_dir), &self.objects)
                         .map_or(false, |platform| platform.matching_attributes(out))
                 },
-                excludes: Some(&mut excludes),
+                excludes: Some(&mut excludes.inner),
                 objects: &self.objects,
-                explicit_traversal_root: None,
+                explicit_traversal_root: (!options.use_prefix).then_some(workdir),
             },
             options.into(),
             delegate,
-        )
-        .map_err(Into::into)
+        )?;
+
+        Ok(Outcome {
+            dirwalk: outcome,
+            traversal_root,
+            excludes,
+            pathspec,
+        })
     }
 }