src/main.rs

   1 // error-pattern:yummy
   2 #![feature(box_syntax)]
   3 #![feature(rustc_private)]
   4
   5 #![allow(unknown_lints, missing_docs_in_private_items)]
   6
   7 extern crate clippy_lints;
   8 extern crate getopts;
   9 extern crate rustc;
  10 extern crate rustc_driver;
  11 extern crate rustc_errors;
  12 extern crate rustc_plugin;
  13 extern crate syntax;
  14
  15 use rustc_driver::{driver, CompilerCalls, RustcDefaultCalls, Compilation};
  16 use rustc::session::{config, Session, CompileIncomplete};
  17 use rustc::session::config::{Input, ErrorOutputType};
  18 use std::path::PathBuf;
  19 use std::process::{self, Command};
  20 use syntax::ast;
  21 use std::io::{self, Write};
  22
  23 extern crate cargo_metadata;
  24
  25 struct ClippyCompilerCalls {
  26     default: RustcDefaultCalls,
  27     run_lints: bool,
  28 }
  29
  30 impl ClippyCompilerCalls {
  31     fn new(run_lints: bool) -> Self {
  32         ClippyCompilerCalls {
  33             default: RustcDefaultCalls,
  34             run_lints: run_lints,
  35         }
  36     }
  37 }
  38
  39 impl<'a> CompilerCalls<'a> for ClippyCompilerCalls {
  40     fn early_callback(
  41         &mut self,
  42         matches: &getopts::Matches,
  43         sopts: &config::Options,
  44         cfg: &ast::CrateConfig,
  45         descriptions: &rustc_errors::registry::Registry,
  46         output: ErrorOutputType,
  47     ) -> Compilation {
  48         self.default
  49             .early_callback(matches, sopts, cfg, descriptions, output)
  50     }
  51     fn no_input(
  52         &mut self,
  53         matches: &getopts::Matches,
  54         sopts: &config::Options,
  55         cfg: &ast::CrateConfig,
  56         odir: &Option<PathBuf>,
  57         ofile: &Option<PathBuf>,
  58         descriptions: &rustc_errors::registry::Registry,
  59     ) -> Option<(Input, Option<PathBuf>)> {
  60         self.default
  61             .no_input(matches, sopts, cfg, odir, ofile, descriptions)
  62     }
  63     fn late_callback(
  64         &mut self,
  65         matches: &getopts::Matches,
  66         sess: &Session,
  67         input: &Input,
  68         odir: &Option<PathBuf>,
  69         ofile: &Option<PathBuf>,
  70     ) -> Compilation {
  71         self.default
  72             .late_callback(matches, sess, input, odir, ofile)
  73     }
  74     fn build_controller(&mut self, sess: &Session, matches: &getopts::Matches) -> driver::CompileController<'a> {
  75         let mut control = self.default.build_controller(sess, matches);
  76
  77         if self.run_lints {
  78             let old = std::mem::replace(&mut control.after_parse.callback, box |_| {});
  79             control.after_parse.callback = Box::new(move |state| {
  80                 {
  81                     let mut registry = rustc_plugin::registry::Registry::new(state.session,
  82                                                                              state
  83                                                                                  .krate
  84                                                                                  .as_ref()
  85                                                                                  .expect("at this compilation stage \
  86                                                                                           the krate must be parsed")
  87                                                                                  .span);
  88                     registry.args_hidden = Some(Vec::new());
  89                     clippy_lints::register_plugins(&mut registry);
  90
  91                     let rustc_plugin::registry::Registry {
  92                         early_lint_passes,
  93                         late_lint_passes,
  94                         lint_groups,
  95                         llvm_passes,
  96                         attributes,
  97                         ..
  98                     } = registry;
  99                     let sess = &state.session;
 100                     let mut ls = sess.lint_store.borrow_mut();
 101                     for pass in early_lint_passes {
 102                         ls.register_early_pass(Some(sess), true, pass);
 103                     }
 104                     for pass in late_lint_passes {
 105                         ls.register_late_pass(Some(sess), true, pass);
 106                     }
 107
 108                     for (name, to) in lint_groups {
 109                         ls.register_group(Some(sess), true, name, to);
 110                     }
 111
 112                     sess.plugin_llvm_passes.borrow_mut().extend(llvm_passes);
 113                     sess.plugin_attributes.borrow_mut().extend(attributes);
 114                 }
 115                 old(state);
 116             });
 117         }
 118
 119         control
 120     }
 121 }
 122
 123 use std::path::Path;
 124
 125 const CARGO_CLIPPY_HELP: &str = r#"Checks a package to catch common mistakes and improve your Rust code.
 126
 127 Usage:
 128     cargo clippy [options] [--] [<opts>...]
 129
 130 Common options:
 131     -h, --help               Print this message
 132     --features               Features to compile for the package
 133     -V, --version            Print version info and exit
 134
 135 Other options are the same as `cargo rustc`.
 136
 137 To allow or deny a lint from the command line you can use `cargo clippy --`
 138 with:
 139
 140     -W --warn OPT       Set lint warnings
 141     -A --allow OPT      Set lint allowed
 142     -D --deny OPT       Set lint denied
 143     -F --forbid OPT     Set lint forbidden
 144
 145 The feature `cargo-clippy` is automatically defined for convenience. You can use
 146 it to allow or deny lints from the code, eg.:
 147
 148     #[cfg_attr(feature = "cargo-clippy", allow(needless_lifetimes))]
 149 "#;
 150
 151 #[allow(print_stdout)]
 152 fn show_help() {
 153     println!("{}", CARGO_CLIPPY_HELP);
 154 }
 155
 156 #[allow(print_stdout)]
 157 fn show_version() {
 158     println!("{}", env!("CARGO_PKG_VERSION"));
 159 }
 160
 161 pub fn main() {
 162     use std::env;
 163
 164     if env::var("CLIPPY_DOGFOOD").map(|_| true).unwrap_or(false) {
 165         panic!("yummy");
 166     }
 167
 168     // Check for version and help flags even when invoked as 'cargo-clippy'
 169     if std::env::args().any(|a| a == "--help" || a == "-h") {
 170         show_help();
 171         return;
 172     }
 173     if std::env::args().any(|a| a == "--version" || a == "-V") {
 174         show_version();
 175         return;
 176     }
 177
 178     if let Some("clippy") = std::env::args().nth(1).as_ref().map(AsRef::as_ref) {
 179         // this arm is executed on the initial call to `cargo clippy`
 180
 181         let manifest_path_arg = std::env::args()
 182             .skip(2)
 183             .find(|val| val.starts_with("--manifest-path="));
 184
 185         let mut metadata =
 186             if let Ok(metadata) = cargo_metadata::metadata(manifest_path_arg.as_ref().map(AsRef::as_ref)) {
 187                 metadata
 188             } else {
 189                 let _ = io::stderr().write_fmt(format_args!("error: Could not obtain cargo metadata.\n"));
 190                 process::exit(101);
 191             };
 192
 193         let manifest_path = manifest_path_arg.map(|arg| PathBuf::from(Path::new(&arg["--manifest-path=".len()..])));
 194
 195         let current_dir = std::env::current_dir();
 196
 197         let package_index = metadata
 198             .packages
 199             .iter()
 200             .position(|package| {
 201                 let package_manifest_path = Path::new(&package.manifest_path);
 202                 if let Some(ref manifest_path) = manifest_path {
 203                     package_manifest_path == manifest_path
 204                 } else {
 205                     let current_dir = current_dir
 206                         .as_ref()
 207                         .expect("could not read current directory");
 208                     let package_manifest_directory = package_manifest_path
 209                         .parent()
 210                         .expect("could not find parent directory of package manifest");
 211                     package_manifest_directory == current_dir
 212                 }
 213             })
 214             .expect("could not find matching package");
 215         let package = metadata.packages.remove(package_index);
 216         for target in package.targets {
 217             let args = std::env::args().skip(2);
 218             if let Some(first) = target.kind.get(0) {
 219                 if target.kind.len() > 1 || first.ends_with("lib") {
 220                     if let Err(code) = process(std::iter::once("--lib".to_owned()).chain(args)) {
 221                         std::process::exit(code);
 222                     }
 223                 } else if ["bin", "example", "test", "bench"].contains(&&**first) {
 224                     if let Err(code) = process(vec![format!("--{}", first), target.name]
 225                                                    .into_iter()
 226                                                    .chain(args)) {
 227                         std::process::exit(code);
 228                     }
 229                 }
 230             } else {
 231                 panic!("badly formatted cargo metadata: target::kind is an empty array");
 232             }
 233         }
 234     } else {
 235         // this arm is executed when cargo-clippy runs `cargo rustc` with the `RUSTC`
 236         // env var set to itself
 237
 238         let home = option_env!("RUSTUP_HOME").or(option_env!("MULTIRUST_HOME"));
 239         let toolchain = option_env!("RUSTUP_TOOLCHAIN").or(option_env!("MULTIRUST_TOOLCHAIN"));
 240         let sys_root = if let (Some(home), Some(toolchain)) = (home, toolchain) {
 241             format!("{}/toolchains/{}", home, toolchain)
 242         } else {
 243             option_env!("SYSROOT")
 244                 .map(|s| s.to_owned())
 245                 .or_else(|| {
 246                     Command::new("rustc")
 247                         .arg("--print")
 248                         .arg("sysroot")
 249                         .output()
 250                         .ok()
 251                         .and_then(|out| String::from_utf8(out.stdout).ok())
 252                         .map(|s| s.trim().to_owned())
 253                 })
 254                 .expect("need to specify SYSROOT env var during clippy compilation, or use rustup or multirust")
 255         };
 256
 257         rustc_driver::in_rustc_thread(|| {
 258             // this conditional check for the --sysroot flag is there so users can call
 259             // `cargo-clippy` directly
 260             // without having to pass --sysroot or anything
 261             let mut args: Vec<String> = if env::args().any(|s| s == "--sysroot") {
 262                 env::args().collect()
 263             } else {
 264                 env::args()
 265                     .chain(Some("--sysroot".to_owned()))
 266                     .chain(Some(sys_root))
 267                     .collect()
 268             };
 269
 270             // this check ensures that dependencies are built but not linted and the final
 271             // crate is
 272             // linted but not built
 273             let clippy_enabled = env::args().any(|s| s == "--emit=metadata");
 274
 275             if clippy_enabled {
 276                 args.extend_from_slice(&["--cfg".to_owned(), r#"feature="cargo-clippy""#.to_owned()]);
 277             }
 278
 279             let mut ccc = ClippyCompilerCalls::new(clippy_enabled);
 280             let (result, _) = rustc_driver::run_compiler(&args, &mut ccc, None, None);
 281             if let Err(CompileIncomplete::Errored(_)) = result {
 282                 std::process::exit(1);
 283             }
 284         })
 285                 .expect("rustc_thread failed");
 286     }
 287 }
 288
 289 fn process<I>(old_args: I) -> Result<(), i32>
 290     where I: Iterator<Item = String>
 291 {
 292
 293     let mut args = vec!["rustc".to_owned()];
 294
 295     let mut found_dashes = false;
 296     for arg in old_args {
 297         found_dashes |= arg == "--";
 298         args.push(arg);
 299     }
 300     if !found_dashes {
 301         args.push("--".to_owned());
 302     }
 303     args.push("--emit=metadata".to_owned());
 304     args.push("--cfg".to_owned());
 305     args.push(r#"feature="cargo-clippy""#.to_owned());
 306
 307     let path = std::env::current_exe().expect("current executable path invalid");
 308     let exit_status = std::process::Command::new("cargo")
 309         .args(&args)
 310         .env("RUSTC", path)
 311         .spawn()
 312         .expect("could not run cargo")
 313         .wait()
 314         .expect("failed to wait for cargo?");
 315
 316     if exit_status.success() {
 317         Ok(())
 318     } else {
 319         Err(exit_status.code().unwrap_or(-1))
 320     }
 321 }