src/driver.rs

   1 // error-pattern:yummy
   2 #![feature(box_syntax)]
   3 #![feature(rustc_private)]
   4 #![allow(unknown_lints, missing_docs_in_private_items)]
   5
   6 extern crate clippy_lints;
   7 extern crate getopts;
   8 extern crate rustc;
   9 extern crate rustc_codegen_utils;
  10 extern crate rustc_driver;
  11 extern crate rustc_errors;
  12 extern crate rustc_plugin;
  13 extern crate syntax;
  14
  15 use rustc::session::config::{ErrorOutputType, Input};
  16 use rustc::session::{config, Session};
  17 use rustc_codegen_utils::codegen_backend::CodegenBackend;
  18 use rustc_driver::{driver, Compilation, CompilerCalls, RustcDefaultCalls};
  19 use std::path::PathBuf;
  20 use std::process::Command;
  21 use syntax::ast;
  22
  23 struct ClippyCompilerCalls {
  24     default: RustcDefaultCalls,
  25     run_lints: bool,
  26 }
  27
  28 impl ClippyCompilerCalls {
  29     fn new(run_lints: bool) -> Self {
  30         Self {
  31             default: RustcDefaultCalls,
  32             run_lints,
  33         }
  34     }
  35 }
  36
  37 impl<'a> CompilerCalls<'a> for ClippyCompilerCalls {
  38     fn early_callback(
  39         &mut self,
  40         matches: &getopts::Matches,
  41         sopts: &config::Options,
  42         cfg: &ast::CrateConfig,
  43         descriptions: &rustc_errors::registry::Registry,
  44         output: ErrorOutputType,
  45     ) -> Compilation {
  46         self.default.early_callback(matches, sopts, cfg, descriptions, output)
  47     }
  48     fn no_input(
  49         &mut self,
  50         matches: &getopts::Matches,
  51         sopts: &config::Options,
  52         cfg: &ast::CrateConfig,
  53         odir: &Option<PathBuf>,
  54         ofile: &Option<PathBuf>,
  55         descriptions: &rustc_errors::registry::Registry,
  56     ) -> Option<(Input, Option<PathBuf>)> {
  57         self.default.no_input(matches, sopts, cfg, odir, ofile, descriptions)
  58     }
  59     fn late_callback(
  60         &mut self,
  61         trans_crate: &CodegenBackend,
  62         matches: &getopts::Matches,
  63         sess: &Session,
  64         crate_stores: &rustc::middle::cstore::CrateStore,
  65         input: &Input,
  66         odir: &Option<PathBuf>,
  67         ofile: &Option<PathBuf>,
  68     ) -> Compilation {
  69         self.default
  70             .late_callback(trans_crate, matches, sess, crate_stores, input, odir, ofile)
  71     }
  72     fn build_controller(&mut self, sess: &Session, matches: &getopts::Matches) -> driver::CompileController<'a> {
  73         let mut control = self.default.build_controller(sess, matches);
  74
  75         if self.run_lints {
  76             let old = std::mem::replace(&mut control.after_parse.callback, box |_| {});
  77             control.after_parse.callback = Box::new(move |state| {
  78                 {
  79                     let mut registry = rustc_plugin::registry::Registry::new(
  80                         state.session,
  81                         state
  82                             .krate
  83                             .as_ref()
  84                             .expect(
  85                                 "at this compilation stage \
  86                                  the crate must be parsed",
  87                             )
  88                             .span,
  89                     );
  90                     registry.args_hidden = Some(Vec::new());
  91                     clippy_lints::register_plugins(&mut registry);
  92
  93                     let rustc_plugin::registry::Registry {
  94                         early_lint_passes,
  95                         late_lint_passes,
  96                         lint_groups,
  97                         llvm_passes,
  98                         attributes,
  99                         ..
 100                     } = registry;
 101                     let sess = &state.session;
 102                     let mut ls = sess.lint_store.borrow_mut();
 103                     for pass in early_lint_passes {
 104                         ls.register_early_pass(Some(sess), true, pass);
 105                     }
 106                     for pass in late_lint_passes {
 107                         ls.register_late_pass(Some(sess), true, pass);
 108                     }
 109
 110                     for (name, to) in lint_groups {
 111                         ls.register_group(Some(sess), true, name, to);
 112                     }
 113
 114                     sess.plugin_llvm_passes.borrow_mut().extend(llvm_passes);
 115                     sess.plugin_attributes.borrow_mut().extend(attributes);
 116                 }
 117                 old(state);
 118             });
 119
 120             control.compilation_done.stop = Compilation::Stop;
 121         }
 122
 123         control
 124     }
 125 }
 126
 127 #[allow(print_stdout)]
 128 fn show_version() {
 129     println!(env!("CARGO_PKG_VERSION"));
 130 }
 131
 132 pub fn main() {
 133     use std::env;
 134
 135     if std::env::args().any(|a| a == "--version" || a == "-V") {
 136         show_version();
 137         return;
 138     }
 139
 140     let sys_root = option_env!("SYSROOT")
 141         .map(String::from)
 142         .or_else(|| std::env::var("SYSROOT").ok())
 143         .or_else(|| {
 144             let home = option_env!("RUSTUP_HOME").or(option_env!("MULTIRUST_HOME"));
 145             let toolchain = option_env!("RUSTUP_TOOLCHAIN").or(option_env!("MULTIRUST_TOOLCHAIN"));
 146             home.and_then(|home| toolchain.map(|toolchain| format!("{}/toolchains/{}", home, toolchain)))
 147         })
 148         .or_else(|| {
 149             Command::new("rustc")
 150                 .arg("--print")
 151                 .arg("sysroot")
 152                 .output()
 153                 .ok()
 154                 .and_then(|out| String::from_utf8(out.stdout).ok())
 155                 .map(|s| s.trim().to_owned())
 156         })
 157         .expect("need to specify SYSROOT env var during clippy compilation, or use rustup or multirust");
 158
 159     // Setting RUSTC_WRAPPER causes Cargo to pass 'rustc' as the first argument.
 160     // We're invoking the compiler programmatically, so we ignore this/
 161     let mut orig_args: Vec<String> = env::args().collect();
 162     if orig_args.len() <= 1 {
 163         std::process::exit(1);
 164     }
 165     if orig_args[1] == "rustc" {
 166         // we still want to be able to invoke it normally though
 167         orig_args.remove(1);
 168     }
 169     // this conditional check for the --sysroot flag is there so users can call
 170     // `clippy_driver` directly
 171     // without having to pass --sysroot or anything
 172     let mut args: Vec<String> = if orig_args.iter().any(|s| s == "--sysroot") {
 173         orig_args.clone()
 174     } else {
 175         orig_args
 176             .clone()
 177             .into_iter()
 178             .chain(Some("--sysroot".to_owned()))
 179             .chain(Some(sys_root))
 180             .collect()
 181     };
 182
 183     // this check ensures that dependencies are built but not linted and the final
 184     // crate is
 185     // linted but not built
 186     let clippy_enabled = env::var("CLIPPY_TESTS").ok().map_or(false, |val| val == "true")
 187         || orig_args.iter().any(|s| s == "--emit=dep-info,metadata");
 188
 189     if clippy_enabled {
 190         args.extend_from_slice(&["--cfg".to_owned(), r#"feature="cargo-clippy""#.to_owned()]);
 191         if let Ok(extra_args) = env::var("CLIPPY_ARGS") {
 192             args.extend(
 193                 extra_args
 194                     .split("__CLIPPY_HACKERY__")
 195                     .filter(|s| !s.is_empty())
 196                     .map(str::to_owned),
 197             );
 198         }
 199     }
 200
 201     let mut ccc = ClippyCompilerCalls::new(clippy_enabled);
 202     rustc_driver::run(move || rustc_driver::run_compiler(&args, &mut ccc, None, None));
 203 }