Emit ansi color codes in the rendered field of json diagnostics

oli-obk · oli-obk · commit 96404ee8443c · 2019-04-02T16:14:58.000+02:00
diff --git a/src/librustc/session/config.rs b/src/librustc/session/config.rs
@@ -205,7 +205,12 @@ impl OutputType {
 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
 pub enum ErrorOutputType {
     HumanReadable(ColorConfig),
-    Json(bool),
+    Json {
+        /// Render the json in a human readable way (with indents and newlines)
+        pretty: bool,
+        /// The `rendered` field with the command line diagnostics include color codes
+        colorful_rendered: bool,
+    },
     Short(ColorConfig),
 }
 
@@ -1345,6 +1350,8 @@ options! {DebuggingOptions, DebuggingSetter, basic_debugging_options,
         "print some statistics about AST and HIR"),
     always_encode_mir: bool = (false, parse_bool, [TRACKED],
         "encode MIR of all functions into the crate metadata"),
+    colorful_json: bool = (false, parse_bool, [UNTRACKED],
+        "encode color codes in the `rendered` field of json diagnostics"),
     unleash_the_miri_inside_of_you: bool = (false, parse_bool, [TRACKED],
         "take the breaks off const evaluation. NOTE: this is unsound"),
     osx_rpath_install_name: bool = (false, parse_bool, [TRACKED],
@@ -1798,6 +1805,12 @@ pub fn rustc_optgroups() -> Vec<RustcOptGroup> {
             "How errors and other messages are produced",
             "human|json|short",
         ),
+        opt::opt(
+            "",
+            "colorful-json",
+            "Emit ansi color codes to the `rendered` field of json diagnostics",
+            "TYPE",
+        ),
         opt::opt_s(
             "",
             "color",
@@ -1938,6 +1951,7 @@ pub fn build_session_options_and_crate_config(
         )
     }
 
+    let colorful_rendered = matches.opt_present("colorful-json");
 
     // We need the opts_present check because the driver will send us Matches
     // with only stable options if no unstable options are used. Since error-format
@@ -1946,8 +1960,8 @@ pub fn build_session_options_and_crate_config(
     let error_format = if matches.opts_present(&["error-format".to_owned()]) {
         match matches.opt_str("error-format").as_ref().map(|s| &s[..]) {
             Some("human") => ErrorOutputType::HumanReadable(color),
-            Some("json") => ErrorOutputType::Json(false),
-            Some("pretty-json") => ErrorOutputType::Json(true),
+            Some("json") => ErrorOutputType::Json { pretty: false, colorful_rendered },
+            Some("pretty-json") => ErrorOutputType::Json { pretty: true, colorful_rendered },
             Some("short") => ErrorOutputType::Short(color),
             None => ErrorOutputType::HumanReadable(color),
 
@@ -1973,11 +1987,16 @@ pub fn build_session_options_and_crate_config(
 
     let mut debugging_opts = build_debugging_options(matches, error_format);
 
-    if !debugging_opts.unstable_options && error_format == ErrorOutputType::Json(true) {
-        early_error(
-            ErrorOutputType::Json(false),
-            "--error-format=pretty-json is unstable",
-        );
+    if !debugging_opts.unstable_options {
+        if colorful_rendered {
+            early_error(error_format, "--colorful-json=true is unstable");
+        }
+        if let ErrorOutputType::Json { pretty: true, .. } = error_format {
+            early_error(
+                ErrorOutputType::Json { pretty: false, colorful_rendered: false },
+                "--error-format=pretty-json is unstable",
+            );
+        }
     }
 
     if debugging_opts.pgo_gen.is_some() && !debugging_opts.pgo_use.is_empty() {
diff --git a/src/librustc/session/mod.rs b/src/librustc/session/mod.rs
@@ -1046,29 +1046,34 @@ fn default_emitter(
             ).ui_testing(sopts.debugging_opts.ui_testing),
         ),
         (config::ErrorOutputType::HumanReadable(_), Some(dst)) => Box::new(
-            EmitterWriter::new(dst, Some(source_map.clone()), false, false)
-                .ui_testing(sopts.debugging_opts.ui_testing),
+            EmitterWriter::new(
+                dst, Some(source_map.clone()), false, false, sopts.debugging_opts.colorful_json,
+            ).ui_testing(sopts.debugging_opts.ui_testing),
         ),
-        (config::ErrorOutputType::Json(pretty), None) => Box::new(
+        (config::ErrorOutputType::Json { pretty, colorful_rendered }, None) => Box::new(
             JsonEmitter::stderr(
                 Some(registry),
                 source_map.clone(),
                 pretty,
+                colorful_rendered,
             ).ui_testing(sopts.debugging_opts.ui_testing),
         ),
-        (config::ErrorOutputType::Json(pretty), Some(dst)) => Box::new(
+        (config::ErrorOutputType::Json { pretty, colorful_rendered }, Some(dst)) => Box::new(
             JsonEmitter::new(
                 dst,
                 Some(registry),
                 source_map.clone(),
                 pretty,
+                colorful_rendered,
             ).ui_testing(sopts.debugging_opts.ui_testing),
         ),
         (config::ErrorOutputType::Short(color_config), None) => Box::new(
             EmitterWriter::stderr(color_config, Some(source_map.clone()), true, false),
         ),
         (config::ErrorOutputType::Short(_), Some(dst)) => {
-            Box::new(EmitterWriter::new(dst, Some(source_map.clone()), true, false))
+            Box::new(EmitterWriter::new(
+                dst, Some(source_map.clone()), true, false, sopts.debugging_opts.colorful_json,
+            ))
         }
     }
 }
@@ -1317,7 +1322,8 @@ pub fn early_error(output: config::ErrorOutputType, msg: &str) -> ! {
         config::ErrorOutputType::HumanReadable(color_config) => {
             Box::new(EmitterWriter::stderr(color_config, None, false, false))
         }
-        config::ErrorOutputType::Json(pretty) => Box::new(JsonEmitter::basic(pretty)),
+        config::ErrorOutputType::Json { pretty, colorful_rendered } =>
+            Box::new(JsonEmitter::basic(pretty, colorful_rendered)),
         config::ErrorOutputType::Short(color_config) => {
             Box::new(EmitterWriter::stderr(color_config, None, true, false))
         }
@@ -1332,7 +1338,8 @@ pub fn early_warn(output: config::ErrorOutputType, msg: &str) {
         config::ErrorOutputType::HumanReadable(color_config) => {
             Box::new(EmitterWriter::stderr(color_config, None, false, false))
         }
-        config::ErrorOutputType::Json(pretty) => Box::new(JsonEmitter::basic(pretty)),
+        config::ErrorOutputType::Json { pretty, colorful_rendered } =>
+            Box::new(JsonEmitter::basic(pretty, colorful_rendered)),
         config::ErrorOutputType::Short(color_config) => {
             Box::new(EmitterWriter::stderr(color_config, None, true, false))
         }
diff --git a/src/librustc_errors/emitter.rs b/src/librustc_errors/emitter.rs
@@ -16,7 +16,7 @@ use std::borrow::Cow;
 use std::io::prelude::*;
 use std::io;
 use std::cmp::{min, Reverse};
-use termcolor::{StandardStream, ColorChoice, ColorSpec, BufferWriter};
+use termcolor::{StandardStream, ColorChoice, ColorSpec, BufferWriter, Ansi};
 use termcolor::{WriteColor, Color, Buffer};
 
 const ANONYMIZED_LINE_NUM: &str = "LL";
@@ -152,13 +152,15 @@ impl EmitterWriter {
         }
     }
 
-    pub fn new(dst: Box<dyn Write + Send>,
-               source_map: Option<Lrc<SourceMapperDyn>>,
-               short_message: bool,
-               teach: bool)
-               -> EmitterWriter {
+    pub fn new(
+        dst: Box<dyn Write + Send>,
+        source_map: Option<Lrc<SourceMapperDyn>>,
+        short_message: bool,
+        teach: bool,
+        colored: bool,
+    ) -> EmitterWriter {
         EmitterWriter {
-            dst: Raw(dst),
+            dst: Raw(dst, colored),
             sm: source_map,
             short_message,
             teach,
@@ -1538,13 +1540,14 @@ fn emit_to_destination(rendered_buffer: &[Vec<StyledString>],
 pub enum Destination {
     Terminal(StandardStream),
     Buffered(BufferWriter),
-    Raw(Box<dyn Write + Send>),
+    Raw(Box<(dyn Write + Send)>, bool),
 }
 
 pub enum WritableDst<'a> {
     Terminal(&'a mut StandardStream),
     Buffered(&'a mut BufferWriter, Buffer),
-    Raw(&'a mut Box<dyn Write + Send>),
+    Raw(&'a mut (dyn Write + Send)),
+    ColoredRaw(Ansi<&'a mut (dyn Write + Send)>),
 }
 
 impl Destination {
@@ -1570,7 +1573,8 @@ impl Destination {
                 let buf = t.buffer();
                 WritableDst::Buffered(t, buf)
             }
-            Destination::Raw(ref mut t) => WritableDst::Raw(t),
+            Destination::Raw(ref mut t, false) => WritableDst::Raw(t),
+            Destination::Raw(ref mut t, true) => WritableDst::ColoredRaw(Ansi::new(t)),
         }
     }
 }
@@ -1628,6 +1632,7 @@ impl<'a> WritableDst<'a> {
         match *self {
             WritableDst::Terminal(ref mut t) => t.set_color(color),
             WritableDst::Buffered(_, ref mut t) => t.set_color(color),
+            WritableDst::ColoredRaw(ref mut t) => t.set_color(color),
             WritableDst::Raw(_) => Ok(())
         }
     }
@@ -1636,6 +1641,7 @@ impl<'a> WritableDst<'a> {
         match *self {
             WritableDst::Terminal(ref mut t) => t.reset(),
             WritableDst::Buffered(_, ref mut t) => t.reset(),
+            WritableDst::ColoredRaw(ref mut t) => t.reset(),
             WritableDst::Raw(_) => Ok(()),
         }
     }
@@ -1647,6 +1653,7 @@ impl<'a> Write for WritableDst<'a> {
             WritableDst::Terminal(ref mut t) => t.write(bytes),
             WritableDst::Buffered(_, ref mut buf) => buf.write(bytes),
             WritableDst::Raw(ref mut w) => w.write(bytes),
+            WritableDst::ColoredRaw(ref mut t) => t.write(bytes),
         }
     }
 
@@ -1655,6 +1662,7 @@ impl<'a> Write for WritableDst<'a> {
             WritableDst::Terminal(ref mut t) => t.flush(),
             WritableDst::Buffered(_, ref mut buf) => buf.flush(),
             WritableDst::Raw(ref mut w) => w.flush(),
+            WritableDst::ColoredRaw(ref mut w) => w.flush(),
         }
     }
 }
diff --git a/src/libsyntax/json.rs b/src/libsyntax/json.rs
@@ -30,37 +30,46 @@ pub struct JsonEmitter {
     sm: Lrc<dyn SourceMapper + sync::Send + sync::Sync>,
     pretty: bool,
     ui_testing: bool,
+    colorful_rendered: bool,
 }
 
 impl JsonEmitter {
-    pub fn stderr(registry: Option<Registry>,
-                  source_map: Lrc<SourceMap>,
-                  pretty: bool) -> JsonEmitter {
+    pub fn stderr(
+        registry: Option<Registry>,
+        source_map: Lrc<SourceMap>,
+        pretty: bool,
+        colorful_rendered: bool,
+    ) -> JsonEmitter {
         JsonEmitter {
             dst: Box::new(io::stderr()),
             registry,
             sm: source_map,
             pretty,
             ui_testing: false,
+            colorful_rendered,
         }
     }
 
-    pub fn basic(pretty: bool) -> JsonEmitter {
+    pub fn basic(pretty: bool, colorful_rendered: bool) -> JsonEmitter {
         let file_path_mapping = FilePathMapping::empty();
         JsonEmitter::stderr(None, Lrc::new(SourceMap::new(file_path_mapping)),
-                            pretty)
+                            pretty, colorful_rendered)
     }
 
-    pub fn new(dst: Box<dyn Write + Send>,
-               registry: Option<Registry>,
-               source_map: Lrc<SourceMap>,
-               pretty: bool) -> JsonEmitter {
+    pub fn new(
+        dst: Box<dyn Write + Send>,
+        registry: Option<Registry>,
+        source_map: Lrc<SourceMap>,
+        pretty: bool,
+        colorful_rendered: bool,
+    ) -> JsonEmitter {
         JsonEmitter {
             dst,
             registry,
             sm: source_map,
             pretty,
             ui_testing: false,
+            colorful_rendered,
         }
     }
 
@@ -190,7 +199,7 @@ impl Diagnostic {
         }
         let buf = BufWriter::default();
         let output = buf.clone();
-        EmitterWriter::new(Box::new(buf), Some(je.sm.clone()), false, false)
+        EmitterWriter::new(Box::new(buf), Some(je.sm.clone()), false, false, je.colorful_rendered)
             .ui_testing(je.ui_testing).emit(db);
         let output = Arc::try_unwrap(output.0).unwrap().into_inner().unwrap();
         let output = String::from_utf8(output).unwrap();
diff --git a/src/test/ui/lint/use_suggestion_json.rs b/src/test/ui/lint/use_suggestion_json.rs
@@ -1,5 +1,5 @@
 // ignore-cloudabi
-// compile-flags: --error-format pretty-json -Zunstable-options
+// compile-flags: --error-format pretty-json -Zunstable-options --colorful-json=true
 
 // The output for humans should just highlight the whole span without showing
 // the suggested replacement, but we also want to test that suggested
diff --git a/src/test/ui/lint/use_suggestion_json.stderr b/src/test/ui/lint/use_suggestion_json.stderr

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ use std::borrow::Cow;`
`16`	`16`	`use std::io::prelude::*;`
`17`	`17`	`use std::io;`
`18`	`18`	`use std::cmp::{min, Reverse};`
`19`		`-use termcolor::{StandardStream, ColorChoice, ColorSpec, BufferWriter};`
	`19`	`+use termcolor::{StandardStream, ColorChoice, ColorSpec, BufferWriter, Ansi};`
`20`	`20`	`use termcolor::{WriteColor, Color, Buffer};`
`21`	`21`
`22`	`22`	`const ANONYMIZED_LINE_NUM: &str = "LL";`
`@@ -152,13 +152,15 @@ impl EmitterWriter {`
`152`	`152`	`}`
`153`	`153`	`}`
`154`	`154`
`155`		`- pub fn new(dst: Box<dyn Write + Send>,`
`156`		`- source_map: Option<Lrc<SourceMapperDyn>>,`
`157`		`- short_message: bool,`
`158`		`- teach: bool)`
`159`		`- -> EmitterWriter {`
	`155`	`+ pub fn new(`
	`156`	`+ dst: Box<dyn Write + Send>,`
	`157`	`+ source_map: Option<Lrc<SourceMapperDyn>>,`
	`158`	`+ short_message: bool,`
	`159`	`+ teach: bool,`
	`160`	`+ colored: bool,`
	`161`	`+ ) -> EmitterWriter {`
`160`	`162`	`EmitterWriter {`
`161`		`- dst: Raw(dst),`
	`163`	`+ dst: Raw(dst, colored),`
`162`	`164`	`sm: source_map,`
`163`	`165`	`short_message,`
`164`	`166`	`teach,`
`@@ -1538,13 +1540,14 @@ fn emit_to_destination(rendered_buffer: &[Vec<StyledString>],`
`1538`	`1540`	`pub enum Destination {`
`1539`	`1541`	`Terminal(StandardStream),`
`1540`	`1542`	`Buffered(BufferWriter),`
`1541`		`- Raw(Box<dyn Write + Send>),`
	`1543`	`+ Raw(Box<(dyn Write + Send)>, bool),`
`1542`	`1544`	`}`
`1543`	`1545`
`1544`	`1546`	`pub enum WritableDst<'a> {`
`1545`	`1547`	`Terminal(&'a mut StandardStream),`
`1546`	`1548`	`Buffered(&'a mut BufferWriter, Buffer),`
`1547`		`- Raw(&'a mut Box<dyn Write + Send>),`
	`1549`	`+ Raw(&'a mut (dyn Write + Send)),`
	`1550`	`+ ColoredRaw(Ansi<&'a mut (dyn Write + Send)>),`
`1548`	`1551`	`}`
`1549`	`1552`
`1550`	`1553`	`impl Destination {`
`@@ -1570,7 +1573,8 @@ impl Destination {`
`1570`	`1573`	`let buf = t.buffer();`
`1571`	`1574`	`WritableDst::Buffered(t, buf)`
`1572`	`1575`	`}`
`1573`		`- Destination::Raw(ref mut t) => WritableDst::Raw(t),`
	`1576`	`+ Destination::Raw(ref mut t, false) => WritableDst::Raw(t),`
	`1577`	`+ Destination::Raw(ref mut t, true) => WritableDst::ColoredRaw(Ansi::new(t)),`
`1574`	`1578`	`}`
`1575`	`1579`	`}`
`1576`	`1580`	`}`
`@@ -1628,6 +1632,7 @@ impl<'a> WritableDst<'a> {`
`1628`	`1632`	`match *self {`
`1629`	`1633`	`WritableDst::Terminal(ref mut t) => t.set_color(color),`
`1630`	`1634`	`WritableDst::Buffered(_, ref mut t) => t.set_color(color),`
	`1635`	`+ WritableDst::ColoredRaw(ref mut t) => t.set_color(color),`
`1631`	`1636`	`WritableDst::Raw(_) => Ok(())`
`1632`	`1637`	`}`
`1633`	`1638`	`}`
`@@ -1636,6 +1641,7 @@ impl<'a> WritableDst<'a> {`
`1636`	`1641`	`match *self {`
`1637`	`1642`	`WritableDst::Terminal(ref mut t) => t.reset(),`
`1638`	`1643`	`WritableDst::Buffered(_, ref mut t) => t.reset(),`
	`1644`	`+ WritableDst::ColoredRaw(ref mut t) => t.reset(),`
`1639`	`1645`	`WritableDst::Raw(_) => Ok(()),`
`1640`	`1646`	`}`
`1641`	`1647`	`}`
`@@ -1647,6 +1653,7 @@ impl<'a> Write for WritableDst<'a> {`
`1647`	`1653`	`WritableDst::Terminal(ref mut t) => t.write(bytes),`
`1648`	`1654`	`WritableDst::Buffered(_, ref mut buf) => buf.write(bytes),`
`1649`	`1655`	`WritableDst::Raw(ref mut w) => w.write(bytes),`
	`1656`	`+ WritableDst::ColoredRaw(ref mut t) => t.write(bytes),`
`1650`	`1657`	`}`
`1651`	`1658`	`}`
`1652`	`1659`
`@@ -1655,6 +1662,7 @@ impl<'a> Write for WritableDst<'a> {`
`1655`	`1662`	`WritableDst::Terminal(ref mut t) => t.flush(),`
`1656`	`1663`	`WritableDst::Buffered(_, ref mut buf) => buf.flush(),`
`1657`	`1664`	`WritableDst::Raw(ref mut w) => w.flush(),`
	`1665`	`+ WritableDst::ColoredRaw(ref mut w) => w.flush(),`
`1658`	`1666`	`}`
`1659`	`1667`	`}`
`1660`	`1668`	`}`