src/driver.rs

   1 // error-pattern:yummy
   2 #![feature(box_syntax)]
   3 #![feature(rustc_private)]
   4 #![allow(clippy::missing_docs_in_private_items)]
   5
   6 // FIXME: switch to something more ergonomic here, once available.
   7 // (currently there is no way to opt into sysroot crates w/o `extern crate`)
   8 #[allow(unused_extern_crates)]
   9 extern crate rustc_driver;
  10 #[allow(unused_extern_crates)]
  11 extern crate rustc_plugin;
  12 #[allow(unused_extern_crates)]
  13 extern crate rustc_interface;
  14
  15 use rustc_interface::interface;
  16 use std::path::Path;
  17 use std::process::{exit, Command};
  18
  19 fn show_version() {
  20     println!(env!("CARGO_PKG_VERSION"));
  21 }
  22
  23 /// If a command-line option matches `find_arg`, then apply the predicate `pred` on its value. If
  24 /// true, then return it. The parameter is assumed to be either `--arg=value` or `--arg value`.
  25 fn arg_value<'a>(
  26     args: impl IntoIterator<Item = &'a String>,
  27     find_arg: &str,
  28     pred: impl Fn(&str) -> bool,
  29 ) -> Option<&'a str> {
  30     let mut args = args.into_iter().map(String::as_str);
  31
  32     while let Some(arg) = args.next() {
  33         let arg: Vec<_> = arg.splitn(2, '=').collect();
  34         if arg.get(0) != Some(&find_arg) {
  35             continue;
  36         }
  37
  38         let value = arg.get(1).cloned().or_else(|| args.next());
  39         if value.as_ref().map_or(false, |p| pred(p)) {
  40             return value;
  41         }
  42     }
  43     None
  44 }
  45
  46 #[test]
  47 fn test_arg_value() {
  48     let args: Vec<_> = ["--bar=bar", "--foobar", "123", "--foo"]
  49         .iter()
  50         .map(std::string::ToString::to_string)
  51         .collect();
  52
  53     assert_eq!(arg_value(None, "--foobar", |_| true), None);
  54     assert_eq!(arg_value(&args, "--bar", |_| false), None);
  55     assert_eq!(arg_value(&args, "--bar", |_| true), Some("bar"));
  56     assert_eq!(arg_value(&args, "--bar", |p| p == "bar"), Some("bar"));
  57     assert_eq!(arg_value(&args, "--bar", |p| p == "foo"), None);
  58     assert_eq!(arg_value(&args, "--foobar", |p| p == "foo"), None);
  59     assert_eq!(arg_value(&args, "--foobar", |p| p == "123"), Some("123"));
  60     assert_eq!(arg_value(&args, "--foo", |_| true), None);
  61 }
  62
  63 #[allow(clippy::too_many_lines)]
  64
  65 struct ClippyCallbacks;
  66
  67 impl rustc_driver::Callbacks for ClippyCallbacks {
  68     fn after_parsing(&mut self, compiler: &interface::Compiler) -> bool {
  69         let sess = compiler.session();
  70         let mut registry = rustc_plugin::registry::Registry::new(
  71             sess,
  72             compiler.parse().expect(
  73                 "at this compilation stage \
  74                     the crate must be parsed",
  75             ).peek().span,
  76         );
  77         registry.args_hidden = Some(Vec::new());
  78
  79         let conf = clippy_lints::read_conf(&registry);
  80         clippy_lints::register_plugins(&mut registry, &conf);
  81
  82         let rustc_plugin::registry::Registry {
  83             early_lint_passes,
  84             late_lint_passes,
  85             lint_groups,
  86             llvm_passes,
  87             attributes,
  88             ..
  89         } = registry;
  90         let mut ls = sess.lint_store.borrow_mut();
  91         for pass in early_lint_passes {
  92             ls.register_early_pass(Some(sess), true, false, pass);
  93         }
  94         for pass in late_lint_passes {
  95             ls.register_late_pass(Some(sess), true, pass);
  96         }
  97
  98         for (name, (to, deprecated_name)) in lint_groups {
  99             ls.register_group(Some(sess), true, name, deprecated_name, to);
 100         }
 101         clippy_lints::register_pre_expansion_lints(sess, &mut ls, &conf);
 102         clippy_lints::register_renamed(&mut ls);
 103
 104         sess.plugin_llvm_passes.borrow_mut().extend(llvm_passes);
 105         sess.plugin_attributes.borrow_mut().extend(attributes);
 106
 107         // Continue execution
 108         true
 109     }
 110 }
 111
 112 pub fn main() {
 113     rustc_driver::init_rustc_env_logger();
 114     exit(
 115         rustc_driver::report_ices_to_stderr_if_any(move || {
 116             use std::env;
 117
 118             if std::env::args().any(|a| a == "--version" || a == "-V") {
 119                 show_version();
 120                 exit(0);
 121             }
 122
 123             let mut orig_args: Vec<String> = env::args().collect();
 124
 125             // Get the sysroot, looking from most specific to this invocation to the least:
 126             // - command line
 127             // - runtime environment
 128             //    - SYSROOT
 129             //    - RUSTUP_HOME, MULTIRUST_HOME, RUSTUP_TOOLCHAIN, MULTIRUST_TOOLCHAIN
 130             // - sysroot from rustc in the path
 131             // - compile-time environment
 132             let sys_root_arg = arg_value(&orig_args, "--sysroot", |_| true);
 133             let have_sys_root_arg = sys_root_arg.is_some();
 134             let sys_root = sys_root_arg
 135                 .map(std::string::ToString::to_string)
 136                 .or_else(|| std::env::var("SYSROOT").ok())
 137                 .or_else(|| {
 138                     let home = option_env!("RUSTUP_HOME").or(option_env!("MULTIRUST_HOME"));
 139                     let toolchain = option_env!("RUSTUP_TOOLCHAIN").or(option_env!("MULTIRUST_TOOLCHAIN"));
 140                     home.and_then(|home| toolchain.map(|toolchain| format!("{}/toolchains/{}", home, toolchain)))
 141                 })
 142                 .or_else(|| {
 143                     Command::new("rustc")
 144                         .arg("--print")
 145                         .arg("sysroot")
 146                         .output()
 147                         .ok()
 148                         .and_then(|out| String::from_utf8(out.stdout).ok())
 149                         .map(|s| s.trim().to_owned())
 150                 })
 151                 .or_else(|| option_env!("SYSROOT").map(String::from))
 152                 .expect("need to specify SYSROOT env var during clippy compilation, or use rustup or multirust");
 153
 154             // Setting RUSTC_WRAPPER causes Cargo to pass 'rustc' as the first argument.
 155             // We're invoking the compiler programmatically, so we ignore this/
 156             if orig_args.len() <= 1 {
 157                 std::process::exit(1);
 158             }
 159             if Path::new(&orig_args[1]).file_stem() == Some("rustc".as_ref()) {
 160                 // we still want to be able to invoke it normally though
 161                 orig_args.remove(1);
 162             }
 163             // this conditional check for the --sysroot flag is there so users can call
 164             // `clippy_driver` directly
 165             // without having to pass --sysroot or anything
 166             let mut args: Vec<String> = if have_sys_root_arg {
 167                 orig_args.clone()
 168             } else {
 169                 orig_args
 170                     .clone()
 171                     .into_iter()
 172                     .chain(Some("--sysroot".to_owned()))
 173                     .chain(Some(sys_root))
 174                     .collect()
 175             };
 176
 177             // this check ensures that dependencies are built but not linted and the final
 178             // crate is
 179             // linted but not built
 180             let clippy_enabled = env::var("CLIPPY_TESTS").ok().map_or(false, |val| val == "true")
 181                 || arg_value(&orig_args, "--emit", |val| val.split(',').any(|e| e == "metadata")).is_some();
 182
 183             if clippy_enabled {
 184                 args.extend_from_slice(&["--cfg".to_owned(), r#"feature="cargo-clippy""#.to_owned()]);
 185                 if let Ok(extra_args) = env::var("CLIPPY_ARGS") {
 186                     args.extend(extra_args.split("__CLIPPY_HACKERY__").filter_map(|s| {
 187                         if s.is_empty() {
 188                             None
 189                         } else {
 190                             Some(s.to_string())
 191                         }
 192                     }));
 193                 }
 194             }
 195
 196             let mut clippy = ClippyCallbacks;
 197             let mut default = rustc_driver::DefaultCallbacks;
 198             let callbacks: &mut (dyn rustc_driver::Callbacks + Send) = if clippy_enabled {
 199                 &mut clippy
 200             } else {
 201                 &mut default
 202             };
 203             let args = args;
 204             rustc_driver::run_compiler(&args, callbacks, None, None)
 205         }).and_then(|result| result).is_err() as i32
 206     )
 207 }