Remove printer from emitter trait

rust-lang · MarcusGrass · Feb 23, 2024 · Feb 23, 2024 · Feb 25, 2024 · Feb 25, 2024
commit e10204d5f818f12c19f90560075951302aae9bae
diff --git a/src/emitter.rs b/src/emitter.rs
@@ -33,7 +33,6 @@ pub(crate) trait Emitter {
     fn emit_formatted_file(
         &mut self,
         output: &mut dyn Write,
-        printer: &Printer,
         formatted_file: FormattedFile<'_>,
     ) -> Result<EmitterResult, io::Error>;
 

diff --git a/src/emitter/checkstyle.rs b/src/emitter/checkstyle.rs
@@ -21,7 +21,6 @@ impl Emitter for CheckstyleEmitter {
     fn emit_formatted_file(
         &mut self,
         output: &mut dyn Write,
-        _printer: &Printer,
         FormattedFile {
             filename,
             original_text,
@@ -101,7 +100,6 @@ mod tests {
         let _ = emitter
             .emit_formatted_file(
                 &mut writer,
-                &Printer::no_color(),
                 FormattedFile {
                     filename: &FileName::Real(PathBuf::from(bin_file)),
                     original_text: &bin_original.join("\n"),
@@ -112,7 +110,6 @@ mod tests {
         let _ = emitter
             .emit_formatted_file(
                 &mut writer,
-                &Printer::no_color(),
                 FormattedFile {
                     filename: &FileName::Real(PathBuf::from(lib_file)),
                     original_text: &lib_original.join("\n"),

diff --git a/src/emitter/diff.rs b/src/emitter/diff.rs
@@ -2,21 +2,21 @@ use super::*;
 use crate::config::Config;
 use crate::rustfmt_diff::{make_diff, print_diff};
 
-pub(crate) struct DiffEmitter {
+pub(crate) struct DiffEmitter<'a> {
     config: Config,
+    printer: &'a Printer,
 }
 
-impl DiffEmitter {
-    pub(crate) fn new(config: Config) -> Self {
-        Self { config }
+impl<'a> DiffEmitter<'a> {
+    pub(crate) fn new(config: Config, printer: &'a Printer) -> Self {
+        Self { config, printer }
     }
 }
 
-impl Emitter for DiffEmitter {
+impl<'a> Emitter for DiffEmitter<'a> {
     fn emit_formatted_file(
         &mut self,
         output: &mut dyn Write,
-        printer: &Printer,
         FormattedFile {
             filename,
             original_text,
@@ -35,7 +35,7 @@ impl Emitter for DiffEmitter {
                     mismatch,
                     |line_num| format!("Diff in {}:{}:", filename, line_num),
                     &self.config,
-                    printer,
+                    self.printer,
                 );
             }
         } else if original_text != formatted_text {
@@ -59,11 +59,11 @@ mod tests {
     fn does_not_print_when_no_files_reformatted() {
         let mut writer = Vec::new();
         let config = Config::default();
-        let mut emitter = DiffEmitter::new(config);
+        let printer = Printer::no_color();
+        let mut emitter = DiffEmitter::new(config, &printer);
         let result = emitter
             .emit_formatted_file(
                 &mut writer,
-                &Printer::no_color(),
                 FormattedFile {
                     filename: &FileName::Real(PathBuf::from("src/lib.rs")),
                     original_text: "fn empty() {}\n",
@@ -87,11 +87,11 @@ mod tests {
         let mut writer = Vec::new();
         let mut config = Config::default();
         config.set().print_misformatted_file_names(true);
-        let mut emitter = DiffEmitter::new(config);
+        let printer = Printer::no_color();
+        let mut emitter = DiffEmitter::new(config, &printer);
         let _ = emitter
             .emit_formatted_file(
                 &mut writer,
-                &Printer::no_color(),
                 FormattedFile {
                     filename: &FileName::Real(PathBuf::from(bin_file)),
                     original_text: bin_original,
@@ -102,7 +102,6 @@ mod tests {
         let _ = emitter
             .emit_formatted_file(
                 &mut writer,
-                &Printer::no_color(),
                 FormattedFile {
                     filename: &FileName::Real(PathBuf::from(lib_file)),
                     original_text: lib_original,
@@ -121,11 +120,11 @@ mod tests {
     fn prints_newline_message_with_only_newline_style_diff() {
         let mut writer = Vec::new();
         let config = Config::default();
-        let mut emitter = DiffEmitter::new(config);
+        let printer = Printer::no_color();
+        let mut emitter = DiffEmitter::new(config, &printer);
         let _ = emitter
             .emit_formatted_file(
                 &mut writer,
-                &Printer::no_color(),
                 FormattedFile {
                     filename: &FileName::Real(PathBuf::from("src/lib.rs")),
                     original_text: "fn empty() {}\n",

diff --git a/src/emitter/files.rs b/src/emitter/files.rs
@@ -2,24 +2,23 @@ use super::*;
 use crate::buf_println;
 use std::fs;
 
-#[derive(Debug, Default)]
-pub(crate) struct FilesEmitter {
-    print_misformatted_file_names: bool,
+#[derive(Default)]
+pub(crate) struct FilesEmitter<'a> {
+    print_misformatted_file_names: Option<&'a Printer>,
 }
 
-impl FilesEmitter {
-    pub(crate) fn new(print_misformatted_file_names: bool) -> Self {
+impl<'a> FilesEmitter<'a> {
+    pub(crate) fn new(print_misformatted_file_names: Option<&'a Printer>) -> Self {
         Self {
             print_misformatted_file_names,
         }
     }
 }
 
-impl Emitter for FilesEmitter {
+impl<'a> Emitter for FilesEmitter<'a> {
     fn emit_formatted_file(
         &mut self,
         _output: &mut dyn Write,
-        printer: &Printer,
         FormattedFile {
             filename,
             original_text,
@@ -30,7 +29,7 @@ impl Emitter for FilesEmitter {
         let filename = ensure_real_path(filename);
         if original_text != formatted_text {
             fs::write(filename, formatted_text)?;
-            if self.print_misformatted_file_names {
+            if let Some(printer) = self.print_misformatted_file_names {
                 buf_println!(printer, "{}", filename.display());
             }
         }

diff --git a/src/emitter/files_with_backup.rs b/src/emitter/files_with_backup.rs
@@ -8,7 +8,6 @@ impl Emitter for FilesWithBackupEmitter {
     fn emit_formatted_file(
         &mut self,
         _output: &mut dyn Write,
-        _printer: &Printer,
         FormattedFile {
             filename,
             original_text,

diff --git a/src/emitter/json.rs b/src/emitter/json.rs
@@ -32,7 +32,6 @@ impl Emitter for JsonEmitter {
     fn emit_formatted_file(
         &mut self,
         _output: &mut dyn Write,
-        _printer: &Printer,
         FormattedFile {
             filename,
             original_text,
@@ -198,7 +197,6 @@ mod tests {
         let result = emitter
             .emit_formatted_file(
                 &mut writer,
-                &Printer::no_color(),
                 FormattedFile {
                     filename: &FileName::Real(PathBuf::from("src/lib.rs")),
                     original_text: "fn empty() {}\n",
@@ -246,7 +244,6 @@ mod tests {
         let result = emitter
             .emit_formatted_file(
                 &mut writer,
-                &Printer::no_color(),
                 FormattedFile {
                     filename: &FileName::Real(PathBuf::from(file_name)),
                     original_text: &original.join("\n"),
@@ -299,7 +296,6 @@ mod tests {
         let _ = emitter
             .emit_formatted_file(
                 &mut writer,
-                &Printer::no_color(),
                 FormattedFile {
                     filename: &FileName::Real(PathBuf::from(bin_file)),
                     original_text: &bin_original.join("\n"),
@@ -310,7 +306,6 @@ mod tests {
         let _ = emitter
             .emit_formatted_file(
                 &mut writer,
-                &Printer::no_color(),
                 FormattedFile {
                     filename: &FileName::Real(PathBuf::from(lib_file)),
                     original_text: &lib_original.join("\n"),

diff --git a/src/emitter/modified_lines.rs b/src/emitter/modified_lines.rs
@@ -8,7 +8,6 @@ impl Emitter for ModifiedLinesEmitter {
     fn emit_formatted_file(
         &mut self,
         output: &mut dyn Write,
-        _printer: &Printer,
         FormattedFile {
             original_text,
             formatted_text,

diff --git a/src/emitter/stdout.rs b/src/emitter/stdout.rs
@@ -16,7 +16,6 @@ impl Emitter for IntoOutputEmitter {
     fn emit_formatted_file(
         &mut self,
         output: &mut dyn Write,
-        _printer: &Printer,
         FormattedFile {
             filename,
             formatted_text,

diff --git a/src/formatting.rs b/src/formatting.rs
@@ -305,7 +305,6 @@ impl<'b, T: Write + 'b> FormatHandler for Session<'b, T> {
                 out,
                 &mut *self.emitter,
                 self.config.newline_style(),
-                self.printer,
             ) {
                 Ok(ref result) if result.has_diff => report.add_diff(),
                 Err(e) => {

diff --git a/src/lib.rs b/src/lib.rs
@@ -452,7 +452,7 @@ pub struct Session<'b, T: Write> {
 
 impl<'b, T: Write + 'b> Session<'b, T> {
     pub fn new(config: Config, mut out: Option<&'b mut T>, printer: &'b Printer) -> Session<'b, T> {
-        let emitter = create_emitter(&config);
+        let emitter = create_emitter(&config, printer);
 
         if let Some(ref mut out) = out {
             let _ = emitter.emit_header(out);
@@ -523,21 +523,21 @@ impl<'b, T: Write + 'b> Session<'b, T> {
     }
 }
 
-pub(crate) fn create_emitter<'a>(config: &Config) -> Box<dyn Emitter + 'a> {
+pub(crate) fn create_emitter<'a>(config: &Config, printer: &'a Printer) -> Box<dyn Emitter + 'a> {
     match config.emit_mode() {
         EmitMode::Files if config.make_backup() => {
             Box::new(emitter::FilesWithBackupEmitter::default())
         }
         EmitMode::Files => Box::new(emitter::FilesEmitter::new(
-            config.print_misformatted_file_names(),
+            config.print_misformatted_file_names().then_some(printer),
         )),
         EmitMode::Stdout | EmitMode::Coverage => {
             Box::new(emitter::IntoOutputEmitter::new(config.verbose()))
         }
         EmitMode::Json => Box::new(emitter::JsonEmitter::default()),
         EmitMode::ModifiedLines => Box::new(emitter::ModifiedLinesEmitter::default()),
         EmitMode::Checkstyle => Box::new(emitter::CheckstyleEmitter::default()),
-        EmitMode::Diff => Box::new(emitter::DiffEmitter::new(config.clone())),
+        EmitMode::Diff => Box::new(emitter::DiffEmitter::new(config.clone(), printer)),
     }
 }
 

diff --git a/src/source_file.rs b/src/source_file.rs
@@ -14,7 +14,6 @@ use crate::create_emitter;
 #[cfg(test)]
 use crate::formatting::FileRecord;
 
-use crate::print::Printer;
 use rustc_data_structures::sync::Lrc;
 
 // Append a newline to the end of each file.
@@ -31,7 +30,8 @@ pub(crate) fn write_all_files<T>(
 where
     T: Write,
 {
-    let mut emitter = create_emitter(config);
+    let printer = crate::print::Printer::no_color();
+    let mut emitter = create_emitter(config, &printer);
 
     emitter.emit_header(out)?;
     for (filename, text) in source_file {
@@ -42,7 +42,6 @@ where
             out,
             &mut *emitter,
             config.newline_style(),
-            &Printer::no_color(),
         )?;
     }
     emitter.emit_footer(out)?;
@@ -57,7 +56,6 @@ pub(crate) fn write_file<T>(
     out: &mut T,
     emitter: &mut dyn Emitter,
     newline_style: NewlineStyle,
-    printer: &Printer,
 ) -> Result<emitter::EmitterResult, io::Error>
 where
     T: Write,
@@ -104,5 +102,5 @@ where
         formatted_text,
     };
 
-    emitter.emit_formatted_file(out, printer, formatted_file)
+    emitter.emit_formatted_file(out, formatted_file)
 }