2 #![feature(box_syntax)]
3 #![feature(rustc_private)]
4 #![feature(static_in_const)]
6 #![allow(unknown_lints, missing_docs_in_private_items)]
8 extern crate clippy_lints;
11 extern crate rustc_driver;
12 extern crate rustc_errors;
13 extern crate rustc_plugin;
16 use rustc_driver::{driver, CompilerCalls, RustcDefaultCalls, Compilation};
17 use rustc::session::{config, Session};
18 use rustc::session::config::{Input, ErrorOutputType};
19 use std::path::PathBuf;
20 use std::process::{self, Command};
22 use std::io::{self, Write};
24 use clippy_lints::utils::cargo;
26 struct ClippyCompilerCalls {
27 default: RustcDefaultCalls,
31 impl ClippyCompilerCalls {
32 fn new(run_lints: bool) -> Self {
34 default: RustcDefaultCalls,
40 impl<'a> CompilerCalls<'a> for ClippyCompilerCalls {
41 fn early_callback(&mut self,
42 matches: &getopts::Matches,
43 sopts: &config::Options,
44 cfg: &ast::CrateConfig,
45 descriptions: &rustc_errors::registry::Registry,
46 output: ErrorOutputType)
48 self.default.early_callback(matches, sopts, cfg, descriptions, output)
50 fn no_input(&mut self,
51 matches: &getopts::Matches,
52 sopts: &config::Options,
53 cfg: &ast::CrateConfig,
54 odir: &Option<PathBuf>,
55 ofile: &Option<PathBuf>,
56 descriptions: &rustc_errors::registry::Registry)
57 -> Option<(Input, Option<PathBuf>)> {
58 self.default.no_input(matches, sopts, cfg, odir, ofile, descriptions)
60 fn late_callback(&mut self,
61 matches: &getopts::Matches,
64 odir: &Option<PathBuf>,
65 ofile: &Option<PathBuf>)
67 self.default.late_callback(matches, sess, input, odir, ofile)
69 fn build_controller(&mut self, sess: &Session, matches: &getopts::Matches) -> driver::CompileController<'a> {
70 let mut control = self.default.build_controller(sess, matches);
73 let old = std::mem::replace(&mut control.after_parse.callback, box |_| {});
74 control.after_parse.callback = Box::new(move |state| {
76 let mut registry = rustc_plugin::registry::Registry::new(state.session, state.krate.as_ref().expect("at this compilation stage the krate must be parsed").span);
77 registry.args_hidden = Some(Vec::new());
78 clippy_lints::register_plugins(&mut registry);
80 let rustc_plugin::registry::Registry { early_lint_passes,
87 let sess = &state.session;
88 let mut ls = sess.lint_store.borrow_mut();
89 for pass in early_lint_passes {
90 ls.register_early_pass(Some(sess), true, pass);
92 for pass in late_lint_passes {
93 ls.register_late_pass(Some(sess), true, pass);
96 for (name, to) in lint_groups {
97 ls.register_group(Some(sess), true, name, to);
100 sess.plugin_llvm_passes.borrow_mut().extend(llvm_passes);
101 sess.mir_passes.borrow_mut().extend(mir_passes);
102 sess.plugin_attributes.borrow_mut().extend(attributes);
114 const CARGO_CLIPPY_HELP: &str = r#"Checks a package to catch common mistakes and improve your Rust code.
117 cargo clippy [options] [--] [<opts>...]
120 -h, --help Print this message
121 --features Features to compile for the package
122 -V, --version Print version info and exit
124 Other options are the same as `cargo rustc`.
126 To allow or deny a lint from the command line you can use `cargo clippy --`
129 -W --warn OPT Set lint warnings
130 -A --allow OPT Set lint allowed
131 -D --deny OPT Set lint denied
132 -F --forbid OPT Set lint forbidden
134 The feature `cargo-clippy` is automatically defined for convenience. You can use
135 it to allow or deny lints from the code, eg.:
137 #[cfg_attr(feature = "cargo-clippy", allow(needless_lifetimes))]
140 #[allow(print_stdout)]
142 println!("{}", CARGO_CLIPPY_HELP);
145 #[allow(print_stdout)]
147 println!("{}", env!("CARGO_PKG_VERSION"));
153 if env::var("CLIPPY_DOGFOOD").map(|_| true).unwrap_or(false) {
157 // Check for version and help flags even when invoked as 'cargo-clippy'
158 if std::env::args().any(|a| a == "--help" || a == "-h") {
162 if std::env::args().any(|a| a == "--version" || a == "-V") {
167 let dep_path = env::current_dir().expect("current dir is not readable").join("target").join("debug").join("deps");
169 if let Some("clippy") = std::env::args().nth(1).as_ref().map(AsRef::as_ref) {
170 // this arm is executed on the initial call to `cargo clippy`
172 let manifest_path_arg = std::env::args().skip(2).find(|val| val.starts_with("--manifest-path="));
174 let mut metadata = if let Ok(metadata) = cargo::metadata(manifest_path_arg.as_ref().map(AsRef::as_ref)) {
177 let _ = io::stderr().write_fmt(format_args!("error: Could not obtain cargo metadata."));
181 assert_eq!(metadata.version, 1);
183 let manifest_path = manifest_path_arg.map(|arg| PathBuf::from(Path::new(&arg["--manifest-path=".len()..])));
185 let current_dir = std::env::current_dir();
187 let package_index = metadata.packages.iter()
188 .position(|package| {
189 let package_manifest_path = Path::new(&package.manifest_path);
190 if let Some(ref manifest_path) = manifest_path {
191 package_manifest_path == manifest_path
193 let current_dir = current_dir.as_ref().expect("could not read current directory");
194 let package_manifest_directory = package_manifest_path.parent().expect("could not find parent directory of package manifest");
195 package_manifest_directory == current_dir
198 .expect("could not find matching package");
199 let package = metadata.packages.remove(package_index);
200 for target in package.targets {
201 let args = std::env::args().skip(2);
202 if let Some(first) = target.kind.get(0) {
203 if target.kind.len() > 1 || first.ends_with("lib") {
204 if let Err(code) = process(std::iter::once("--lib".to_owned()).chain(args), &dep_path) {
205 std::process::exit(code);
207 } else if ["bin", "example", "test", "bench"].contains(&&**first) {
208 if let Err(code) = process(vec![format!("--{}", first), target.name].into_iter().chain(args), &dep_path) {
209 std::process::exit(code);
213 panic!("badly formatted cargo metadata: target::kind is an empty array");
217 // this arm is executed when cargo-clippy runs `cargo rustc` with the `RUSTC` env var set to itself
219 let home = option_env!("RUSTUP_HOME").or(option_env!("MULTIRUST_HOME"));
220 let toolchain = option_env!("RUSTUP_TOOLCHAIN").or(option_env!("MULTIRUST_TOOLCHAIN"));
221 let sys_root = if let (Some(home), Some(toolchain)) = (home, toolchain) {
222 format!("{}/toolchains/{}", home, toolchain)
224 option_env!("SYSROOT")
225 .map(|s| s.to_owned())
226 .or(Command::new("rustc")
231 .and_then(|out| String::from_utf8(out.stdout).ok())
232 .map(|s| s.trim().to_owned()))
233 .expect("need to specify SYSROOT env var during clippy compilation, or use rustup or multirust")
236 // this conditional check for the --sysroot flag is there so users can call `cargo-clippy` directly
237 // without having to pass --sysroot or anything
238 let mut args: Vec<String> = if env::args().any(|s| s == "--sysroot") {
239 env::args().collect()
241 env::args().chain(Some("--sysroot".to_owned())).chain(Some(sys_root)).collect()
244 // this check ensures that dependencies are built but not linted and the final crate is
245 // linted but not built
246 args.extend_from_slice(&["--cfg".to_owned(), r#"feature="cargo-clippy""#.to_owned()]);
248 let mut ccc = ClippyCompilerCalls::new(env::args().any(|s| s == "-Zno-trans"));
249 let (result, _) = rustc_driver::run_compiler(&args, &mut ccc, None, None);
251 if let Err(err_count) = result {
253 std::process::exit(1);
259 fn process<P, I>(old_args: I, dep_path: P) -> Result<(), i32>
260 where P: AsRef<Path>,
261 I: Iterator<Item = String>
264 let mut args = vec!["rustc".to_owned()];
266 let mut found_dashes = false;
267 for arg in old_args {
268 found_dashes |= arg == "--";
272 args.push("--".to_owned());
274 args.push("-L".to_owned());
275 args.push(dep_path.as_ref().to_string_lossy().into_owned());
276 args.push("-Zno-trans".to_owned());
277 args.push("--cfg".to_owned());
278 args.push(r#"feature="cargo-clippy""#.to_owned());
280 let path = std::env::current_exe().expect("current executable path invalid");
281 let exit_status = std::process::Command::new("cargo")
284 .spawn().expect("could not run cargo")
285 .wait().expect("failed to wait for cargo?");
287 if exit_status.success() {
290 Err(exit_status.code().unwrap_or(-1))