Moved user_provided_filename to be contained within OrdinaryFile struct

Author: Kyle Criddle

examples/cat.rs

@@ -1,7 +1,7 @@
 /// A very simple colorized `cat` clone, using `bat` as a library.
 /// See `src/bin/bat` for the full `bat` application.
 use bat::{
-    config::{Config, InputFile, StyleComponent, StyleComponents},
+    config::{Config, InputFile, OrdinaryFile, StyleComponent, StyleComponents},
     Controller, HighlightingAssets,
 };
 use console::Term;
@@ -24,7 +24,10 @@ fn main() {
             StyleComponent::Grid,
             StyleComponent::Numbers,
         ]),
-        files: files.iter().map(|file| InputFile::Ordinary(file)).collect(),
+        files: files
+            .iter()
+            .map(|file| InputFile::Ordinary(OrdinaryFile::new(file, None)))
+            .collect(),
         ..Default::default()
     };
     let assets = HighlightingAssets::from_binary();

examples/simple.rs

@@ -1,6 +1,6 @@
 /// A simple program that prints its own source code using the bat library
 use bat::{
-    config::{Config, InputFile},
+    config::{Config, InputFile, OrdinaryFile},
     Controller, HighlightingAssets,
 };
 use std::ffi::OsStr;
@@ -9,7 +9,10 @@ fn main() {
     let path_to_this_file = OsStr::new(file!());
 
     let config = Config {
-        files: vec![InputFile::Ordinary(path_to_this_file)],
+        files: vec![InputFile::Ordinary(OrdinaryFile::new(
+            path_to_this_file,
+            None,
+        ))],
         colored_output: true,
         true_color: true,
         ..Default::default()

src/assets.rs

@@ -177,14 +177,13 @@ impl HighlightingAssets {
         &self,
         language: Option<&str>,
         file: InputFile,
-        file_name: Option<&str>,
         reader: &mut InputFileReader,
         mapping: &SyntaxMapping,
     ) -> &SyntaxReference {
-        let syntax = match (language, file, file_name) {
-            (Some(language), _, _) => self.syntax_set.find_syntax_by_token(language),
-            (None, InputFile::Ordinary(file), _) => {
-                let path = Path::new(file);
+        let syntax = match (language, file) {
+            (Some(language), _) => self.syntax_set.find_syntax_by_token(language),
+            (None, InputFile::Ordinary(ofile)) => {
+                let path = Path::new(ofile.filename());
 
                 let file_name = path.file_name().and_then(|n| n.to_str()).unwrap_or("");
                 let extension = path.extension().and_then(|x| x.to_str()).unwrap_or("");
@@ -208,12 +207,12 @@ impl HighlightingAssets {
                     None => ext_syntax.or(line_syntax),
                 }
             }
-            (None, InputFile::StdIn, None) => String::from_utf8(reader.first_line.clone())
+            (None, InputFile::StdIn(None)) => String::from_utf8(reader.first_line.clone())
                 .ok()
                 .and_then(|l| self.syntax_set.find_syntax_by_first_line(&l)),
-            (None, InputFile::StdIn, Some(file_name)) => self
+            (None, InputFile::StdIn(Some(file_name))) => self
                 .syntax_set
-                .find_syntax_by_extension(&file_name)
+                .find_syntax_by_extension(file_name.to_str().unwrap())
                 .or_else(|| {
                     self.syntax_set.find_syntax_by_extension(
                         Path::new(file_name)
@@ -225,7 +224,7 @@ impl HighlightingAssets {
                 .or(String::from_utf8(reader.first_line.clone())
                     .ok()
                     .and_then(|l| self.syntax_set.find_syntax_by_first_line(&l))),
-            (_, InputFile::ThemePreviewFile, _) => self.syntax_set.find_syntax_by_name("Rust"),
+            (_, InputFile::ThemePreviewFile) => self.syntax_set.find_syntax_by_name("Rust"),
         };
 
         syntax.unwrap_or_else(|| self.syntax_set.find_syntax_plain_text())
@@ -242,7 +241,7 @@ mod tests {
     use tempdir::TempDir;
 
     use crate::assets::HighlightingAssets;
-    use crate::inputfile::InputFile;
+    use crate::inputfile::{InputFile, OrdinaryFile};
     use crate::syntax_mapping::{MappingTarget, SyntaxMapping};
 
     struct SyntaxDetectionTest<'a> {
@@ -261,28 +260,17 @@ mod tests {
             }
         }
 
-        fn syntax_for_file_with_content(
-            &self,
-            file_name: &str,
-            first_line: &str,
-            as_stdin: bool,
-        ) -> String {
+        fn syntax_for_file_with_content(&self, file_name: &str, first_line: &str) -> String {
             let file_path = self.temp_dir.path().join(file_name);
             {
                 let mut temp_file = File::create(&file_path).unwrap();
                 writeln!(temp_file, "{}", first_line).unwrap();
             }
 
-            let input_file = InputFile::Ordinary(OsStr::new(&file_path));
-            let (file, file_name) = if as_stdin {
-                (InputFile::StdIn, Some(file_name))
-            } else {
-                (input_file, None)
-            };
+            let input_file = InputFile::Ordinary(OrdinaryFile::new(OsStr::new(&file_path), None));
             let syntax = self.assets.get_syntax(
                 None,
-                file,
-                file_name,
+                input_file,
                 &mut input_file.get_reader(&io::stdin()).unwrap(),
                 &self.syntax_mapping,
             );
@@ -291,7 +279,7 @@ mod tests {
         }
 
         fn syntax_for_file(&self, file_name: &str) -> String {
-            self.syntax_for_file_with_content(file_name, "", false)
+            self.syntax_for_file_with_content(file_name, "")
         }
     }
 
@@ -325,15 +313,15 @@ mod tests {
         let test = SyntaxDetectionTest::new();
 
         assert_eq!(
-            test.syntax_for_file_with_content("my_script", "#!/bin/bash", false),
+            test.syntax_for_file_with_content("my_script", "#!/bin/bash"),
             "Bourne Again Shell (bash)"
         );
         assert_eq!(
-            test.syntax_for_file_with_content("build", "#!/bin/bash", false),
+            test.syntax_for_file_with_content("build", "#!/bin/bash"),
             "Bourne Again Shell (bash)"
         );
         assert_eq!(
-            test.syntax_for_file_with_content("my_script", "<?php", false),
+            test.syntax_for_file_with_content("my_script", "<?php"),
             "PHP"
         );
     }
@@ -365,13 +353,10 @@ mod tests {
         let test = SyntaxDetectionTest::new();
 
         // from file extension
-        assert_eq!(
-            test.syntax_for_file_with_content("test.cpp", "", true),
-            "C++"
-        );
+        assert_eq!(test.syntax_for_file_with_content("test.cpp", ""), "C++");
         // from first line (fallback)
         assert_eq!(
-            test.syntax_for_file_with_content("my_script", "#!/bin/bash", true),
+            test.syntax_for_file_with_content("my_script", "#!/bin/bash"),
             "Bourne Again Shell (bash)"
         );
     }

src/bin/bat/app.rs

@@ -1,5 +1,6 @@
 use std::collections::HashSet;
 use std::env;
+use std::ffi::OsStr;
 use std::str::FromStr;
 
 use atty::{self, Stream};
@@ -18,8 +19,8 @@ use ansi_term;
 
 use bat::{
     config::{
-        Config, HighlightedLineRanges, InputFile, LineRange, LineRanges, MappingTarget, OutputWrap,
-        PagingMode, StyleComponent, StyleComponents, SyntaxMapping,
+        Config, HighlightedLineRanges, InputFile, LineRange, LineRanges, MappingTarget,
+        OrdinaryFile, OutputWrap, PagingMode, StyleComponent, StyleComponents, SyntaxMapping,
     },
     errors::*,
     HighlightingAssets,
@@ -77,7 +78,7 @@ impl App {
     }
 
     pub fn config(&self) -> Result<Config> {
-        let files = self.files();
+        let files = self.files()?;
         let style_components = self.style_components()?;
 
         let paging_mode = match self.matches.value_of("paging") {
@@ -87,7 +88,7 @@ impl App {
                 if self.matches.occurrences_of("plain") > 1 {
                     // If we have -pp as an option when in auto mode, the pager should be disabled.
                     PagingMode::Never
-                } else if files.contains(&InputFile::StdIn) {
+                } else if files.contains(&InputFile::StdIn(None)) {
                     // If we are reading from stdin, only enable paging if we write to an
                     // interactive terminal and if we do not *read* from an interactive
                     // terminal.
@@ -136,13 +137,6 @@ impl App {
             }
         });
 
-        match self.matches.values_of("file-name") {
-            Some(filenames) if filenames.len() != files.len() => {
-                return Err(format!("{} {}", filenames.len(), files.len()).into());
-            }
-            _ => {}
-        }
-
         Ok(Config {
             true_color: is_truecolor_terminal(),
             language: self.matches.value_of("language").or_else(|| {
@@ -229,28 +223,59 @@ impl App {
                 .map(LineRanges::from)
                 .map(|lr| HighlightedLineRanges(lr))
                 .unwrap_or_default(),
-            filenames: self
-                .matches
-                .values_of("file-name")
-                .map(|values| values.collect()),
         })
     }
 
-    fn files(&self) -> Vec<InputFile> {
-        self.matches
+    fn files(&self) -> Result<Vec<InputFile>> {
+        // verify equal length of file-names and input FILEs
+        match self.matches.values_of("file-name") {
+            Some(filenames)
+                if self.matches.values_of_os("FILE").is_some()
+                    && filenames.len() != self.matches.values_of_os("FILE").unwrap().len() =>
+            {
+                return Err("Must be one file name per input type.".into());
+            }
+            _ => {}
+        }
+        let filenames: Option<Vec<&str>> = self
+            .matches
+            .values_of("file-name")
+            .map(|values| values.collect());
+
+        let mut filenames_or_none: Box<dyn Iterator<Item = _>> = match filenames {
+            Some(ref filenames) => {
+                Box::new(filenames.into_iter().map(|name| Some(OsStr::new(*name))))
+            }
+            None => Box::new(std::iter::repeat(None)),
+        };
+        let files: Option<Vec<&str>> = self
+            .matches
             .values_of_os("FILE")
-            .map(|values| {
-                values
-                    .map(|filename| {
-                        if filename == "-" {
-                            InputFile::StdIn
-                        } else {
-                            InputFile::Ordinary(filename)
-                        }
-                    })
-                    .collect()
-            })
-            .unwrap_or_else(|| vec![InputFile::StdIn])
+            .map(|values| values.map(|fname| fname.to_str()).collect())
+            .unwrap_or(None);
+
+        if files.is_none() {
+            return Ok(vec![InputFile::StdIn(filenames_or_none.nth(0).unwrap())]);
+        }
+        let files_or_none: Box<dyn Iterator<Item = _>> = match files {
+            Some(ref files) => Box::new(files.into_iter().map(|name| Some(OsStr::new(*name)))),
+            None => Box::new(std::iter::repeat(None)),
+        };
+
+        let mut file_input = Vec::new();
+        for (input, name) in files_or_none.zip(filenames_or_none) {
+            match input {
+                Some(input) => {
+                    if input.to_str().unwrap() == "-" {
+                        file_input.push(InputFile::StdIn(name));
+                    } else {
+                        file_input.push(InputFile::Ordinary(OrdinaryFile::new(input, name)))
+                    }
+                }
+                None => {}
+            }
+        }
+        return Ok(file_input);
     }
 
     fn style_components(&self) -> Result<StyleComponents> {

src/bin/bat/main.rs

@@ -28,7 +28,7 @@ use bat::Controller;
 use directories::PROJECT_DIRS;
 
 use bat::{
-    config::{Config, InputFile, StyleComponent, StyleComponents},
+    config::{Config, InputFile, OrdinaryFile, StyleComponent, StyleComponents},
     errors::*,
     HighlightingAssets,
 };
@@ -169,7 +169,10 @@ fn run() -> Result<bool> {
                 Ok(true)
             } else {
                 let mut config = app.config()?;
-                config.files = vec![InputFile::Ordinary(OsStr::new("cache"))];
+                config.files = vec![InputFile::Ordinary(OrdinaryFile::new(
+                    OsStr::new("cache"),
+                    None,
+                ))];
 
                 run_controller(&config)
             }

src/config.rs

@@ -1,4 +1,5 @@
 pub use crate::inputfile::InputFile;
+pub use crate::inputfile::OrdinaryFile;
 pub use crate::line_range::{HighlightedLineRanges, LineRange, LineRanges};
 pub use crate::style::{StyleComponent, StyleComponents};
 pub use crate::syntax_mapping::{MappingTarget, SyntaxMapping};
@@ -70,9 +71,8 @@ pub struct Config<'a> {
 
     /// Ranges of lines which should be highlighted with a special background color
     pub highlighted_lines: HighlightedLineRanges,
-
-    /// Names of files to display when printing
-    pub filenames: Option<Vec<&'a str>>,
+    ///// Names of files to display when printing
+    // pub filenames: Option<Vec<&'a str>>,
 }
 
 #[test]

src/controller.rs

@@ -28,8 +28,8 @@ impl<'b> Controller<'b> {
         let mut paging_mode = self.config.paging_mode;
         if self.config.paging_mode != PagingMode::Never {
             let call_pager = self.config.files.iter().any(|file| {
-                if let InputFile::Ordinary(path) = file {
-                    return Path::new(path).exists();
+                if let InputFile::Ordinary(ofile) = file {
+                    return Path::new(ofile.filename()).exists();
                 } else {
                     return true;
                 }
@@ -45,12 +45,7 @@ impl<'b> Controller<'b> {
 
         let stdin = io::stdin();
 
-        let filenames: Box<dyn Iterator<Item = _>> = match self.config.filenames {
-            Some(ref filenames) => Box::new(filenames.into_iter().map(|name| Some(*name))),
-            None => Box::new(std::iter::repeat(None)),
-        };
-
-        for (input_file, file_name) in self.config.files.iter().zip(filenames) {
+        for input_file in self.config.files.iter() {
             match input_file.get_reader(&stdin) {
                 Err(error) => {
                     handle_error(&error);
@@ -59,16 +54,15 @@ impl<'b> Controller<'b> {
                 Ok(mut reader) => {
                     let result = if self.config.loop_through {
                         let mut printer = SimplePrinter::new();
-                        self.print_file(reader, &mut printer, writer, *input_file, file_name)
+                        self.print_file(reader, &mut printer, writer, *input_file)
                     } else {
                         let mut printer = InteractivePrinter::new(
                             &self.config,
                             &self.assets,
                             *input_file,
-                            file_name,
                             &mut reader,
                         );
-                        self.print_file(reader, &mut printer, writer, *input_file, file_name)
+                        self.print_file(reader, &mut printer, writer, *input_file)
                     };
 
                     if let Err(error) = result {
@@ -88,10 +82,9 @@ impl<'b> Controller<'b> {
         printer: &mut P,
         writer: &mut dyn Write,
         input_file: InputFile<'a>,
-        file_name: Option<&str>,
     ) -> Result<()> {
         if !reader.first_line.is_empty() || self.config.style_components.header() {
-            printer.print_header(writer, input_file, file_name)?;
+            printer.print_header(writer, input_file)?;
         }
 
         if !reader.first_line.is_empty() {