Merge pull request #2807 from Oliver-Looney/2783-setting-terminal-title

2783 setting terminal title

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Features
 
+- Set terminal title to file names when Paging is not Paging::Never #2807 (@Oliver-Looney)
+
 ## Bugfixes
 
 - Fix long file name wrapping in header, see #2835 (@FilipRazek)

doc/long-help.txt

@@ -160,6 +160,9 @@ Options:
       --acknowledgements
           Show acknowledgements.
 
+      --set-terminal-title
+          Sets terminal title to filenames when using a pager.
+
   -h, --help
           Print help (see a summary with '-h')
 

src/bin/bat/app.rs

@@ -289,6 +289,7 @@ impl App {
             use_custom_assets: !self.matches.get_flag("no-custom-assets"),
             #[cfg(feature = "lessopen")]
             use_lessopen: self.matches.get_flag("lessopen"),
+            set_terminal_title: self.matches.get_flag("set-terminal-title"),
         })
     }
 

src/bin/bat/clap_app.rs

@@ -567,6 +567,13 @@ pub fn build_app(interactive_output: bool) -> Command {
                 .action(ArgAction::SetTrue)
                 .hide_short_help(true)
                 .help("Show acknowledgements."),
+        )
+        .arg(
+            Arg::new("set-terminal-title")
+                .long("set-terminal-title")
+                .action(ArgAction::SetTrue)
+                .hide_short_help(true)
+                .help("Sets terminal title to filenames when using a pager."),
         );
 
     // Check if the current directory contains a file name cache. Otherwise,

src/bin/bat/main.rs

@@ -229,9 +229,33 @@ pub fn list_themes(cfg: &Config, config_dir: &Path, cache_dir: &Path) -> Result<
     Ok(())
 }
 
+fn set_terminal_title_to(new_terminal_title: String) {
+    let osc_command_for_setting_terminal_title = "\x1b]0;";
+    let osc_end_command = "\x07";
+    print!(
+        "{}{}{}",
+        osc_command_for_setting_terminal_title, new_terminal_title, osc_end_command
+    );
+    io::stdout().flush().unwrap();
+}
+
+fn get_new_terminal_title(inputs: &Vec<Input>) -> String {
+    let mut new_terminal_title = "bat: ".to_string();
+    for (index, input) in inputs.iter().enumerate() {
+        new_terminal_title += input.description().title();
+        if index < inputs.len() - 1 {
+            new_terminal_title += ", ";
+        }
+    }
+    new_terminal_title
+}
+
 fn run_controller(inputs: Vec<Input>, config: &Config, cache_dir: &Path) -> Result<bool> {
     let assets = assets_from_cache_or_binary(config.use_custom_assets, cache_dir)?;
     let controller = Controller::new(config, &assets);
+    if config.paging_mode != PagingMode::Never && config.set_terminal_title {
+        set_terminal_title_to(get_new_terminal_title(&inputs));
+    }
     controller.run(inputs, None)
 }
 

src/config.rs

@@ -94,6 +94,9 @@ pub struct Config<'a> {
     // Whether or not to use $LESSOPEN if set
     #[cfg(feature = "lessopen")]
     pub use_lessopen: bool,
+
+    // Weather or not to set terminal title when using a pager
+    pub set_terminal_title: bool,
 }
 
 #[cfg(all(feature = "minimal-application", feature = "paging"))]

tests/integration_tests.rs

@@ -936,6 +936,18 @@ fn env_var_bat_paging() {
     });
 }
 
+#[test]
+fn basic_set_terminal_title() {
+    bat()
+        .arg("--paging=always")
+        .arg("--set-terminal-title")
+        .arg("test.txt")
+        .assert()
+        .success()
+        .stdout("\u{1b}]0;bat: test.txt\x07hello world\n")
+        .stderr("");
+}
+
 #[test]
 fn diagnostic_sanity_check() {
     bat()