]> git.lizzy.rs Git - rust.git/blobdiff - src/driver.rs
Feed the dog
[rust.git] / src / driver.rs
index 395d96a28e8cd320bf903b20fad85275b3b7e7cf..fda304afcbe184a3bc18d764e70f3ade2fc46df0 100644 (file)
@@ -1,18 +1,26 @@
+#![cfg_attr(feature = "deny-warnings", deny(warnings))]
+#![feature(result_map_or)]
 #![feature(rustc_private)]
 
 // FIXME: switch to something more ergonomic here, once available.
 // (Currently there is no way to opt into sysroot crates without `extern crate`.)
 #[allow(unused_extern_crates)]
+extern crate rustc;
+#[allow(unused_extern_crates)]
 extern crate rustc_driver;
 #[allow(unused_extern_crates)]
-extern crate rustc_interface;
+extern crate rustc_errors;
 #[allow(unused_extern_crates)]
-extern crate rustc_plugin;
+extern crate rustc_interface;
 
+use rustc::ty::TyCtxt;
 use rustc_interface::interface;
 use rustc_tools_util::*;
 
-use std::path::Path;
+use lazy_static::lazy_static;
+use std::borrow::Cow;
+use std::panic;
+use std::path::{Path, PathBuf};
 use std::process::{exit, Command};
 
 mod lintlist;
@@ -62,56 +70,33 @@ fn test_arg_value() {
 struct ClippyCallbacks;
 
 impl rustc_driver::Callbacks for ClippyCallbacks {
-    fn after_parsing(&mut self, compiler: &interface::Compiler) -> bool {
-        let sess = compiler.session();
-        let mut registry = rustc_plugin::registry::Registry::new(
-            sess,
-            compiler
-                .parse()
-                .expect(
-                    "at this compilation stage \
-                     the crate must be parsed",
-                )
-                .peek()
-                .span,
-        );
-        registry.args_hidden = Some(Vec::new());
-
-        let conf = clippy_lints::read_conf(&registry);
-        clippy_lints::register_plugins(&mut registry, &conf);
-
-        let rustc_plugin::registry::Registry {
-            early_lint_passes,
-            late_lint_passes,
-            lint_groups,
-            llvm_passes,
-            attributes,
-            ..
-        } = registry;
-        let mut ls = sess.lint_store.borrow_mut();
-        for pass in early_lint_passes {
-            ls.register_early_pass(Some(sess), true, false, pass);
-        }
-        for pass in late_lint_passes {
-            ls.register_late_pass(Some(sess), true, false, false, pass);
-        }
-
-        for (name, (to, deprecated_name)) in lint_groups {
-            ls.register_group(Some(sess), true, name, deprecated_name, to);
-        }
-        clippy_lints::register_pre_expansion_lints(sess, &mut ls, &conf);
-        clippy_lints::register_renamed(&mut ls);
-
-        sess.plugin_llvm_passes.borrow_mut().extend(llvm_passes);
-        sess.plugin_attributes.borrow_mut().extend(attributes);
+    fn config(&mut self, config: &mut interface::Config) {
+        let previous = config.register_lints.take();
+        config.register_lints = Some(Box::new(move |sess, mut lint_store| {
+            // technically we're ~guaranteed that this is none but might as well call anything that
+            // is there already. Certainly it can't hurt.
+            if let Some(previous) = &previous {
+                (previous)(sess, lint_store);
+            }
 
-        // Continue execution
-        true
+            let conf = clippy_lints::read_conf(&[], &sess);
+            clippy_lints::register_plugins(&mut lint_store, &sess, &conf);
+            clippy_lints::register_pre_expansion_lints(&mut lint_store, &conf);
+            clippy_lints::register_renamed(&mut lint_store);
+        }));
+
+        // FIXME: #4825; This is required, because Clippy lints that are based on MIR have to be
+        // run on the unoptimized MIR. On the other hand this results in some false negatives. If
+        // MIR passes can be enabled / disabled separately, we should figure out, what passes to
+        // use for Clippy.
+        config.opts.debugging_opts.mir_opt_level = 0;
     }
 }
 
+#[allow(clippy::find_map, clippy::filter_map)]
 fn describe_lints() {
     use lintlist::*;
+    use std::collections::HashSet;
 
     println!(
         "
@@ -124,11 +109,23 @@ fn describe_lints() {
 "
     );
 
+    let lint_level = |lint: &Lint| {
+        LINT_LEVELS
+            .iter()
+            .find(|level_mapping| level_mapping.0 == lint.group)
+            .map(|(_, level)| match level {
+                Level::Allow => "allow",
+                Level::Warn => "warn",
+                Level::Deny => "deny",
+            })
+            .unwrap()
+    };
+
     let mut lints: Vec<_> = ALL_LINTS.iter().collect();
     // The sort doesn't case-fold but it's doubtful we care.
-    lints.sort_by_cached_key(|x: &&Lint| ("unknown", x.name));
+    lints.sort_by_cached_key(|x: &&Lint| (lint_level(x), x.name));
 
-    let max_name_len = lints
+    let max_lint_name_len = lints
         .iter()
         .map(|lint| lint.name.len())
         .map(|len| len + "clippy::".len())
@@ -136,77 +133,71 @@ fn describe_lints() {
         .unwrap_or(0);
 
     let padded = |x: &str| {
-        let mut s = " ".repeat(max_name_len - x.chars().count());
+        let mut s = " ".repeat(max_lint_name_len - x.chars().count());
         s.push_str(x);
         s
     };
 
     let scoped = |x: &str| format!("clippy::{}", x);
 
+    let lint_groups: HashSet<_> = lints.iter().map(|lint| lint.group).collect();
+
     println!("Lint checks provided by clippy:\n");
     println!("    {}  {:7.7}  meaning", padded("name"), "default");
     println!("    {}  {:7.7}  -------", padded("----"), "-------");
 
-    let print_lints = |lints: Vec<&Lint>| {
+    let print_lints = |lints: &[&Lint]| {
         for lint in lints {
             let name = lint.name.replace("_", "-");
-            println!("    {}  {:7.7}  {}", padded(&scoped(&name)), "unknown", lint.desc);
+            println!(
+                "    {}  {:7.7}  {}",
+                padded(&scoped(&name)),
+                lint_level(lint),
+                lint.desc
+            );
+        }
+        println!("\n");
+    };
+
+    print_lints(&lints);
+
+    let max_group_name_len = std::cmp::max(
+        "clippy::all".len(),
+        lint_groups
+            .iter()
+            .map(|group| group.len())
+            .map(|len| len + "clippy::".len())
+            .max()
+            .unwrap_or(0),
+    );
+
+    let padded_group = |x: &str| {
+        let mut s = " ".repeat(max_group_name_len - x.chars().count());
+        s.push_str(x);
+        s
+    };
+
+    println!("Lint groups provided by clippy:\n");
+    println!("    {}  sub-lints", padded_group("name"));
+    println!("    {}  ---------", padded_group("----"));
+    println!("    {}  the set of all clippy lints", padded_group("clippy::all"));
+
+    let print_lint_groups = || {
+        for group in lint_groups {
+            let name = group.to_lowercase().replace("_", "-");
+            let desc = lints
+                .iter()
+                .filter(|&lint| lint.group == group)
+                .map(|lint| lint.name)
+                .map(|name| name.replace("_", "-"))
+                .collect::<Vec<String>>()
+                .join(", ");
+            println!("    {}  {}", padded_group(&scoped(&name)), desc);
         }
         println!("\n");
     };
 
-    print_lints(lints);
-
-    // let max_name_len = max("warnings".len(),
-    //                        plugin_groups.iter()
-    //                                     .chain(&builtin_groups)
-    //                                     .map(|&(s, _)| s.chars().count())
-    //                                     .max()
-    //                                     .unwrap_or(0));
-
-    // let padded = |x: &str| {
-    //     let mut s = " ".repeat(max_name_len - x.chars().count());
-    //     s.push_str(x);
-    //     s
-    // };
-
-    // println!("Lint groups provided by rustc:\n");
-    // println!("    {}  {}", padded("name"), "sub-lints");
-    // println!("    {}  {}", padded("----"), "---------");
-    // println!("    {}  {}", padded("warnings"), "all lints that are set to issue warnings");
-
-    // let print_lint_groups = |lints: Vec<(&'static str, Vec<lint::LintId>)>| {
-    //     for (name, to) in lints {
-    //         let name = name.to_lowercase().replace("_", "-");
-    //         let desc = to.into_iter()
-    //                      .map(|x| x.to_string().replace("_", "-"))
-    //                      .collect::<Vec<String>>()
-    //                      .join(", ");
-    //         println!("    {}  {}", padded(&name), desc);
-    //     }
-    //     println!("\n");
-    // };
-
-    // print_lint_groups(builtin_groups);
-
-    // match (loaded_plugins, plugin.len(), plugin_groups.len()) {
-    //     (false, 0, _) | (false, _, 0) => {
-    //         println!("Compiler plugins can provide additional lints and lint groups. To see a \
-    //                   listing of these, re-run `rustc -W help` with a crate filename.");
-    //     }
-    //     (false, ..) => panic!("didn't load lint plugins but got them anyway!"),
-    //     (true, 0, 0) => println!("This crate does not load any lint plugins or lint groups."),
-    //     (true, l, g) => {
-    //         if l > 0 {
-    //             println!("Lint checks provided by plugins loaded by this crate:\n");
-    //             print_lints(plugin);
-    //         }
-    //         if g > 0 {
-    //             println!("Lint groups provided by plugins loaded by this crate:\n");
-    //             print_lint_groups(plugin_groups);
-    //         }
-    //     }
-    // }
+    print_lint_groups();
 }
 
 fn display_help() {
@@ -238,10 +229,66 @@ fn display_help() {
     );
 }
 
+const BUG_REPORT_URL: &str = "https://github.com/rust-lang/rust-clippy/issues/new";
+
+lazy_static! {
+    static ref ICE_HOOK: Box<dyn Fn(&panic::PanicInfo<'_>) + Sync + Send + 'static> = {
+        let hook = panic::take_hook();
+        panic::set_hook(Box::new(|info| report_clippy_ice(info, BUG_REPORT_URL)));
+        hook
+    };
+}
+
+fn report_clippy_ice(info: &panic::PanicInfo<'_>, bug_report_url: &str) {
+    // Invoke our ICE handler, which prints the actual panic message and optionally a backtrace
+    (*ICE_HOOK)(info);
+
+    // Separate the output with an empty line
+    eprintln!();
+
+    let emitter = Box::new(rustc_errors::emitter::EmitterWriter::stderr(
+        rustc_errors::ColorConfig::Auto,
+        None,
+        false,
+        false,
+        None,
+        false,
+    ));
+    let handler = rustc_errors::Handler::with_emitter(true, None, emitter);
+
+    // a .span_bug or .bug call has already printed what
+    // it wants to print.
+    if !info.payload().is::<rustc_errors::ExplicitBug>() {
+        let d = rustc_errors::Diagnostic::new(rustc_errors::Level::Bug, "unexpected panic");
+        handler.emit_diagnostic(&d);
+        handler.abort_if_errors_and_should_abort();
+    }
+
+    let version_info = rustc_tools_util::get_version_info!();
+
+    let xs: Vec<Cow<'static, str>> = vec![
+        "the compiler unexpectedly panicked. this is a bug.".into(),
+        format!("we would appreciate a bug report: {}", bug_report_url).into(),
+        format!("Clippy version: {}", version_info).into(),
+    ];
+
+    for note in &xs {
+        handler.note_without_error(&note);
+    }
+
+    // If backtraces are enabled, also print the query stack
+    let backtrace = std::env::var_os("RUST_BACKTRACE").map_or(false, |x| &x != "0");
+
+    if backtrace {
+        TyCtxt::try_print_query_stack(&handler);
+    }
+}
+
 pub fn main() {
     rustc_driver::init_rustc_env_logger();
+    lazy_static::initialize(&ICE_HOOK);
     exit(
-        rustc_driver::report_ices_to_stderr_if_any(move || {
+        rustc_driver::catch_fatal_errors(move || {
             use std::env;
 
             if std::env::args().any(|a| a == "--version" || a == "-V") {
@@ -262,12 +309,19 @@ pub fn main() {
             let sys_root_arg = arg_value(&orig_args, "--sysroot", |_| true);
             let have_sys_root_arg = sys_root_arg.is_some();
             let sys_root = sys_root_arg
-                .map(std::string::ToString::to_string)
-                .or_else(|| std::env::var("SYSROOT").ok())
+                .map(PathBuf::from)
+                .or_else(|| std::env::var("SYSROOT").ok().map(PathBuf::from))
                 .or_else(|| {
                     let home = option_env!("RUSTUP_HOME").or(option_env!("MULTIRUST_HOME"));
                     let toolchain = option_env!("RUSTUP_TOOLCHAIN").or(option_env!("MULTIRUST_TOOLCHAIN"));
-                    home.and_then(|home| toolchain.map(|toolchain| format!("{}/toolchains/{}", home, toolchain)))
+                    home.and_then(|home| {
+                        toolchain.map(|toolchain| {
+                            let mut path = PathBuf::from(home);
+                            path.push("toolchains");
+                            path.push(toolchain);
+                            path
+                        })
+                    })
                 })
                 .or_else(|| {
                     Command::new("rustc")
@@ -276,36 +330,38 @@ pub fn main() {
                         .output()
                         .ok()
                         .and_then(|out| String::from_utf8(out.stdout).ok())
-                        .map(|s| s.trim().to_owned())
+                        .map(|s| PathBuf::from(s.trim()))
                 })
-                .or_else(|| option_env!("SYSROOT").map(String::from))
+                .or_else(|| option_env!("SYSROOT").map(PathBuf::from))
+                .map(|pb| pb.to_string_lossy().to_string())
                 .expect("need to specify SYSROOT env var during clippy compilation, or use rustup or multirust");
 
             // Setting RUSTC_WRAPPER causes Cargo to pass 'rustc' as the first argument.
             // We're invoking the compiler programmatically, so we ignore this/
-            let wrapper_mode = Path::new(&orig_args[1]).file_stem() == Some("rustc".as_ref());
+            let wrapper_mode = orig_args.get(1).map(Path::new).and_then(Path::file_stem) == Some("rustc".as_ref());
 
             if wrapper_mode {
                 // we still want to be able to invoke it normally though
                 orig_args.remove(1);
             }
 
-            if !wrapper_mode && std::env::args().any(|a| a == "--help" || a == "-h") {
+            if !wrapper_mode && (orig_args.iter().any(|a| a == "--help" || a == "-h") || orig_args.len() == 1) {
                 display_help();
                 exit(0);
             }
 
-            let args: Vec<_> = std::env::args().collect();
-
-            if !wrapper_mode
-                && args.windows(2).any(|args| {
+            let should_describe_lints = || {
+                let args: Vec<_> = std::env::args().collect();
+                args.windows(2).any(|args| {
                     args[1] == "help"
                         && match args[0].as_str() {
                             "-W" | "-A" | "-D" | "-F" => true,
                             _ => false,
                         }
                 })
-            {
+            };
+
+            if !wrapper_mode && should_describe_lints() {
                 describe_lints();
                 exit(0);
             }
@@ -325,10 +381,9 @@ pub fn main() {
             };
 
             // this check ensures that dependencies are built but not linted and the final
-            // crate is
-            // linted but not built
-            let clippy_enabled = env::var("CLIPPY_TESTS").ok().map_or(false, |val| val == "true")
-                || arg_value(&orig_args, "--emit", |val| val.split(',').any(|e| e == "metadata")).is_some();
+            // crate is linted but not built
+            let clippy_enabled = env::var("CLIPPY_TESTS").map_or(false, |val| val == "true")
+                || arg_value(&orig_args, "--cap-lints", |val| val == "allow").is_none();
 
             if clippy_enabled {
                 args.extend_from_slice(&["--cfg".to_owned(), r#"feature="cargo-clippy""#.to_owned()]);