Print the root path relative to the initial root

Author: 9999years

man/page

@@ -37,6 +37,9 @@ Show folders and files alike
 \fB\-\-show\-root\-fs\fR
 Show filesystem info on top
 .TP
+\fB\-\-root\-relative\-path\fR
+Show the root path relative to the launch directory
+.TP
 \fB\-g\fR, \fB\-\-show\-git\-info\fR
 Show git statuses on files and stats on repo
 .TP

src/app/app_context.rs

@@ -34,6 +34,9 @@ pub struct AppContext {
     /// Initial tree options
     pub initial_tree_options: TreeOptions,
 
+    /// Initial working directory. This is where `broot` is launched, not the root path!
+    pub initial_working_dir: PathBuf,
+
     /// where's the config file we're using
     /// This vec can't be empty
     pub config_paths: Vec<PathBuf>,
@@ -159,6 +162,7 @@ impl AppContext {
             initial_root,
             initial_file,
             initial_tree_options,
+            initial_working_dir: std::env::current_dir()?,
             config_paths,
             launch_args,
             verb_store,

src/app/panel_state.rs

@@ -390,6 +390,21 @@ pub trait PanelState {
 					con,
 				)
             }
+            Internal::toggle_root_relative => {
+                self.with_new_options(
+					screen,
+					&|o| {
+						o.relative_root ^= true;
+                        if o.relative_root {
+                            "*displaying root relative to launch dir*"
+                        } else {
+                            "*displaying root as absolute path*"
+                        }
+					},
+					bang,
+					con,
+				)
+            }
             Internal::toggle_git_ignore => {
                 self.with_new_options(
 					screen,

src/browser/browser_state.rs

@@ -708,7 +708,7 @@ impl PanelState for BrowserState {
         disc: &DisplayContext,
     ) -> Result<(), ProgramError> {
         let dp = DisplayableTree {
-            app_state: Some(disc.app_state),
+            display_context: Some(disc),
             tree: self.displayed_tree(),
             skin: &disc.panel_skin.styles,
             ext_colors: &disc.con.ext_colors,

src/cli/args.rs

@@ -44,6 +44,10 @@ pub struct Args {
     #[arg(long)]
     pub show_root_fs: bool,
 
+    /// Show the root path relative to the launch directory.
+    #[arg(long)]
+    pub root_relative_path: bool,
+
     /// Show git statuses on files and stats on repo
     #[arg(short='g', long)]
     pub show_git_info: bool,

src/conf/conf.rs

@@ -107,6 +107,9 @@ pub struct Conf {
 
     #[serde(alias="content-search-max-file-size", deserialize_with="file_size::deserialize", default)]
     pub content_search_max_file_size: Option<u64>,
+
+    #[serde(alias="root-relative-path")]
+    pub root_relative_path: Option<bool>,
 }
 
 impl Conf {
@@ -187,6 +190,7 @@ impl Conf {
         overwrite!(self, max_staged_count, conf);
         overwrite!(self, show_matching_characters_on_path_searches, conf);
         overwrite!(self, content_search_max_file_size, conf);
+        overwrite!(self, root_relative_path, conf);
         self.verbs.append(&mut conf.verbs);
         // the following maps are "additive": we can add entries from several
         // config files and they still make sense

src/display/displayable_tree.rs

@@ -1,3 +1,6 @@
+use crate::app::DisplayContext;
+use crate::path::relativize_path;
+
 use {
     super::{
         cond_bg,
@@ -9,7 +12,6 @@ use {
         SPACE_FILLING, BRANCH_FILLING,
     },
     crate::{
-        app::AppState,
         content_search::ContentMatch,
         errors::ProgramError,
         file_sum::FileSum,
@@ -37,7 +39,7 @@ use {
 ///  - a scrollbar may be drawn
 ///  - the empty lines will be erased
 pub struct DisplayableTree<'a, 's, 't> {
-    pub app_state: Option<&'a AppState>,
+    pub display_context: Option<&'a DisplayContext<'a>>,
     pub tree: &'t Tree,
     pub skin: &'s StyleMap,
     pub area: termimad::Area,
@@ -55,7 +57,7 @@ impl<'a, 's, 't> DisplayableTree<'a, 's, 't> {
         height: u16,
     ) -> DisplayableTree<'a, 's, 't> {
         DisplayableTree {
-            app_state: None,
+            display_context: None,
             tree,
             skin,
             ext_colors,
@@ -413,8 +415,15 @@ impl<'a, 's, 't> DisplayableTree<'a, 's, 't> {
                 )?;
             }
         }
-        let title = line.path.to_string_lossy();
-        cw.queue_str(style, &title)?;
+        match self.display_context {
+            Some(context) if self.tree.options.relative_root => {
+                cw.queue_str(style, &relativize_path(&line.path, context.con)?)?;
+            },
+            _ => {
+                cw.queue_str(style, &line.path.to_string_lossy())?;
+            },
+        }
+        
         if self.in_app && !cw.is_full() {
             if let ComputationResult::Done(git_status) = &self.tree.git_status {
                 let git_status_display = GitStatusDisplay::from(
@@ -486,7 +495,7 @@ impl<'a, 's, 't> DisplayableTree<'a, 's, 't> {
             .options
             .cols_order
             .iter()
-            .filter(|col| col.is_visible(tree, self.app_state))
+            .filter(|col| col.is_visible(tree, self.display_context.map(|con| con.app_state)))
             .cloned()
             .collect();
 
@@ -536,8 +545,8 @@ impl<'a, 's, 't> DisplayableTree<'a, 's, 't> {
                 if visible_cols[0].needs_left_margin() {
                     cw.queue_char(space_style, ' ')?;
                 }
-                let staged = self.app_state
-                    .map_or(false, |a| a.stage.contains(&line.path));
+                let staged = self.display_context
+                    .map_or(false, |a| a.app_state.stage.contains(&line.path));
                 for col in &visible_cols {
                     let void_len = match col {
 

src/path/mod.rs

@@ -4,6 +4,7 @@ mod closest;
 mod from;
 mod normalize;
 mod special_path;
+mod relative;
 
 pub use {
     anchor::*,
@@ -12,4 +13,5 @@ pub use {
     from::*,
     normalize::*,
     special_path::*,
+    relative::*,
 };

src/path/relative.rs

@@ -0,0 +1,23 @@
+use std::io;
+use std::path::Path;
+
+use crate::app::AppContext;
+
+pub fn relativize_path(path: &Path, con: &AppContext) -> io::Result<String> {
+    let relative_path = match pathdiff::diff_paths(path, &con.initial_working_dir) {
+        None => {
+            return Err(io::Error::new(
+                io::ErrorKind::Other,
+                format!("Cannot relativize {path:?}"), // does this happen ? how ?
+            ));
+        }
+        Some(p) => p,
+    };
+    Ok(
+        if relative_path.components().next().is_some() {
+            relative_path.to_string_lossy().to_string()
+        } else {
+            ".".to_string()
+        }
+    )
+}

src/preview/dir_view.rs

@@ -67,7 +67,7 @@ impl DirView {
             self.page_height = Some(page_height);
         }
         let dp = DisplayableTree {
-            app_state: None,
+            display_context: None,
             tree: &self.tree,
             skin: &disc.panel_skin.styles,
             ext_colors: &disc.con.ext_colors,