src/driver.rs

   1 // error-pattern:yummy
   2 #![feature(box_syntax)]
   3 #![feature(rustc_private)]
   4 #![feature(tool_lints)]
   5 #![allow(unknown_lints, clippy::missing_docs_in_private_items)]
   6
   7 // FIXME: switch to something more ergonomic here, once available.
   8 // (currently there is no way to opt into sysroot crates w/o `extern crate`)
   9 #[allow(unused_extern_crates)]
  10 extern crate rustc_driver;
  11 #[allow(unused_extern_crates)]
  12 extern crate rustc_plugin;
  13 use self::rustc_driver::{driver::CompileController, Compilation};
  14
  15 use std::path::Path;
  16 use std::process::{exit, Command};
  17
  18 #[allow(clippy::print_stdout)]
  19 fn show_version() {
  20     println!(env!("CARGO_PKG_VERSION"));
  21 }
  22
  23 pub fn main() {
  24     rustc_driver::init_rustc_env_logger();
  25     exit(rustc_driver::run(move || {
  26         use std::env;
  27
  28         if std::env::args().any(|a| a == "--version" || a == "-V") {
  29             show_version();
  30             exit(0);
  31         }
  32
  33         let sys_root = option_env!("SYSROOT")
  34             .map(String::from)
  35             .or_else(|| std::env::var("SYSROOT").ok())
  36             .or_else(|| {
  37                 let home = option_env!("RUSTUP_HOME").or(option_env!("MULTIRUST_HOME"));
  38                 let toolchain = option_env!("RUSTUP_TOOLCHAIN").or(option_env!("MULTIRUST_TOOLCHAIN"));
  39                 home.and_then(|home| toolchain.map(|toolchain| format!("{}/toolchains/{}", home, toolchain)))
  40             })
  41             .or_else(|| {
  42                 Command::new("rustc")
  43                     .arg("--print")
  44                     .arg("sysroot")
  45                     .output()
  46                     .ok()
  47                     .and_then(|out| String::from_utf8(out.stdout).ok())
  48                     .map(|s| s.trim().to_owned())
  49             })
  50             .expect("need to specify SYSROOT env var during clippy compilation, or use rustup or multirust");
  51
  52         // Setting RUSTC_WRAPPER causes Cargo to pass 'rustc' as the first argument.
  53         // We're invoking the compiler programmatically, so we ignore this/
  54         let mut orig_args: Vec<String> = env::args().collect();
  55         if orig_args.len() <= 1 {
  56             std::process::exit(1);
  57         }
  58         if Path::new(&orig_args[1]).file_stem() == Some("rustc".as_ref()) {
  59             // we still want to be able to invoke it normally though
  60             orig_args.remove(1);
  61         }
  62         // this conditional check for the --sysroot flag is there so users can call
  63         // `clippy_driver` directly
  64         // without having to pass --sysroot or anything
  65         let mut args: Vec<String> = if orig_args.iter().any(|s| s == "--sysroot") {
  66             orig_args.clone()
  67         } else {
  68             orig_args
  69                 .clone()
  70                 .into_iter()
  71                 .chain(Some("--sysroot".to_owned()))
  72                 .chain(Some(sys_root))
  73                 .collect()
  74         };
  75
  76         // this check ensures that dependencies are built but not linted and the final
  77         // crate is
  78         // linted but not built
  79         let clippy_enabled = env::var("CLIPPY_TESTS").ok().map_or(false, |val| val == "true")
  80             || orig_args.iter().any(|s| s == "--emit=dep-info,metadata");
  81
  82         if clippy_enabled {
  83             args.extend_from_slice(&["--cfg".to_owned(), r#"feature="cargo-clippy""#.to_owned()]);
  84             if let Ok(extra_args) = env::var("CLIPPY_ARGS") {
  85                 args.extend(
  86                     extra_args
  87                         .split("__CLIPPY_HACKERY__")
  88                         .filter_map(|s| if s.is_empty() {
  89                             None
  90                         } else {
  91                             Some(s.to_string())
  92                         })
  93                 );
  94             }
  95         }
  96
  97         let mut controller = CompileController::basic();
  98         if clippy_enabled {
  99             controller.after_parse.callback = Box::new(move |state| {
 100                 let mut registry = rustc_plugin::registry::Registry::new(
 101                     state.session,
 102                     state
 103                         .krate
 104                         .as_ref()
 105                         .expect(
 106                             "at this compilation stage \
 107                             the crate must be parsed",
 108                         )
 109                         .span,
 110                 );
 111                 registry.args_hidden = Some(Vec::new());
 112
 113                 let conf = clippy_lints::read_conf(&registry);
 114                 clippy_lints::register_plugins(&mut registry, &conf);
 115
 116                 let rustc_plugin::registry::Registry {
 117                     early_lint_passes,
 118                     late_lint_passes,
 119                     lint_groups,
 120                     llvm_passes,
 121                     attributes,
 122                     ..
 123                 } = registry;
 124                 let sess = &state.session;
 125                 let mut ls = sess.lint_store.borrow_mut();
 126                 for pass in early_lint_passes {
 127                     ls.register_early_pass(Some(sess), true, pass);
 128                 }
 129                 for pass in late_lint_passes {
 130                     ls.register_late_pass(Some(sess), true, pass);
 131                 }
 132
 133                 for (name, (to, deprecated_name)) in lint_groups {
 134                     ls.register_group(Some(sess), true, name, deprecated_name, to);
 135                 }
 136                 clippy_lints::register_pre_expansion_lints(sess, &mut ls, &conf);
 137
 138                 sess.plugin_llvm_passes.borrow_mut().extend(llvm_passes);
 139                 sess.plugin_attributes.borrow_mut().extend(attributes);
 140             });
 141         }
 142         controller.compilation_done.stop = Compilation::Stop;
 143
 144         let args = args;
 145         rustc_driver::run_compiler(&args, Box::new(controller), None, None)
 146     }) as i32)
 147 }