1 #![feature(type_macros)]
2 #![feature(plugin_registrar, box_syntax)]
3 #![feature(rustc_private, collections)]
4 #![feature(iter_arith)]
5 #![feature(custom_attribute)]
6 #![feature(slice_patterns)]
7 #![feature(question_mark)]
8 #![feature(stmt_expr_attributes)]
9 #![allow(indexing_slicing, shadow_reuse, unknown_lints)]
11 extern crate rustc_driver;
14 use rustc_driver::{driver, CompilerCalls, RustcDefaultCalls, Compilation};
15 use rustc::session::{config, Session};
16 use rustc::session::config::{Input, ErrorOutputType};
17 use syntax::diagnostics;
18 use std::path::PathBuf;
19 use std::process::Command;
21 struct ClippyCompilerCalls(RustcDefaultCalls);
23 impl std::default::Default for ClippyCompilerCalls {
24 fn default() -> Self {
29 impl ClippyCompilerCalls {
31 ClippyCompilerCalls(RustcDefaultCalls)
35 impl<'a> CompilerCalls<'a> for ClippyCompilerCalls {
36 fn early_callback(&mut self,
37 matches: &getopts::Matches,
38 sopts: &config::Options,
39 descriptions: &diagnostics::registry::Registry,
40 output: ErrorOutputType)
42 self.0.early_callback(matches, sopts, descriptions, output)
44 fn no_input(&mut self,
45 matches: &getopts::Matches,
46 sopts: &config::Options,
47 odir: &Option<PathBuf>,
48 ofile: &Option<PathBuf>,
49 descriptions: &diagnostics::registry::Registry)
50 -> Option<(Input, Option<PathBuf>)> {
51 self.0.no_input(matches, sopts, odir, ofile, descriptions)
53 fn late_callback(&mut self,
54 matches: &getopts::Matches,
57 odir: &Option<PathBuf>,
58 ofile: &Option<PathBuf>)
60 self.0.late_callback(matches, sess, input, odir, ofile)
62 fn build_controller(&mut self, sess: &Session, matches: &getopts::Matches) -> driver::CompileController<'a> {
63 let mut control = self.0.build_controller(sess, matches);
65 let old = std::mem::replace(&mut control.after_parse.callback, box |_| {});
66 control.after_parse.callback = Box::new(move |state| {
68 let mut registry = rustc_plugin::registry::Registry::new(state.session, state.krate.as_ref().expect("at this compilation stage the krate must be parsed"));
69 registry.args_hidden = Some(Vec::new());
70 plugin_registrar(&mut registry);
72 let rustc_plugin::registry::Registry { early_lint_passes, late_lint_passes, lint_groups, llvm_passes, attributes, mir_passes, .. } = registry;
73 let sess = &state.session;
74 let mut ls = sess.lint_store.borrow_mut();
75 for pass in early_lint_passes {
76 ls.register_early_pass(Some(sess), true, pass);
78 for pass in late_lint_passes {
79 ls.register_late_pass(Some(sess), true, pass);
82 for (name, to) in lint_groups {
83 ls.register_group(Some(sess), true, name, to);
86 sess.plugin_llvm_passes.borrow_mut().extend(llvm_passes);
87 sess.mir_passes.borrow_mut().extend(mir_passes);
88 sess.plugin_attributes.borrow_mut().extend(attributes);
102 if env::var("CLIPPY_DOGFOOD").map(|_| true).unwrap_or(false) {
106 let dep_path = env::current_dir().expect("current dir is not readable").join("target").join("debug").join("deps");
108 let home = option_env!("RUSTUP_HOME").or(option_env!("MULTIRUST_HOME"));
109 let toolchain = option_env!("RUSTUP_TOOLCHAIN").or(option_env!("MULTIRUST_TOOLCHAIN"));
110 let sys_root = match (home, toolchain) {
111 (Some(home), Some(toolchain)) => format!("{}/toolchains/{}", home, toolchain),
112 _ => option_env!("SYSROOT").map(|s| s.to_owned())
113 .or(Command::new("rustc").arg("--print")
116 .and_then(|out| String::from_utf8(out.stdout).ok())
117 .map(|s| s.trim().to_owned())
119 .expect("need to specify SYSROOT env var during clippy compilation, or use rustup or multirust"),
122 if let Some("clippy") = std::env::args().nth(1).as_ref().map(AsRef::as_ref) {
123 let args = wrap_args(std::env::args().skip(2), dep_path, sys_root);
124 let path = std::env::current_exe().expect("current executable path invalid");
125 let run = std::process::Command::new("cargo")
128 .spawn().expect("could not run cargo")
129 .wait().expect("failed to wait for cargo?")
131 assert!(run, "cargo rustc failed");
133 let args: Vec<String> = if env::args().any(|s| s == "--sysroot") {
134 env::args().collect()
136 env::args().chain(Some("--sysroot".to_owned())).chain(Some(sys_root)).collect()
138 rustc_driver::run_compiler(&args, &mut ClippyCompilerCalls::new());
142 fn wrap_args<P, I>(old_args: I, dep_path: P, sysroot: String) -> Vec<String>
143 where P: AsRef<Path>, I: Iterator<Item=String> {
145 let mut args = vec!["rustc".to_owned()];
147 let mut found_dashes = false;
148 for arg in old_args {
149 found_dashes |= arg == "--";
153 args.push("--".to_owned());
155 args.push("-L".to_owned());
156 args.push(dep_path.as_ref().to_string_lossy().into_owned());
157 args.push(String::from("--sysroot"));
159 args.push("-Zno-trans".to_owned());
170 // Only for the compile time checking of paths
172 extern crate collections;
174 // for unicode nfc normalization
175 extern crate unicode_normalization;
177 // for semver check in attrs.rs
180 // for regex checking
181 extern crate regex_syntax;
183 // for finding minimal boolean expressions
184 extern crate quine_mc_cluskey;
186 extern crate rustc_plugin;
187 extern crate rustc_const_eval;
188 extern crate rustc_const_math;
189 use rustc_plugin::Registry;
191 macro_rules! declare_restriction_lint {
192 { pub $name:tt, $description:tt } => {
193 declare_lint! { pub $name, Allow, $description }
201 // begin lints modules, do not remove this comment, it’s used in `update_lints`
202 pub mod approx_const;
204 pub mod array_indexing;
208 pub mod blacklisted_name;
209 pub mod block_in_if_condition;
211 pub mod collapsible_if;
213 pub mod cyclomatic_complexity;
219 pub mod enum_glob_use;
220 pub mod enum_variants;
223 pub mod eta_reduction;
229 pub mod items_after_statements;
241 pub mod mut_reference;
242 pub mod mutex_atomic;
243 pub mod needless_bool;
244 pub mod needless_borrow;
245 pub mod needless_update;
246 pub mod neg_multiply;
247 pub mod new_without_default;
249 pub mod non_expressive_names;
250 pub mod open_options;
251 pub mod overflow_check_conditional;
262 pub mod temporary_assignment;
266 pub mod unsafe_removed_from_name;
267 pub mod unused_label;
269 pub mod zero_div_zero;
270 // end lints modules, do not remove this comment, it’s used in `update_lints`
273 pub use syntax::ast::{Name, NodeId};
277 #[cfg_attr(rustfmt, rustfmt_skip)]
278 pub fn plugin_registrar(reg: &mut Registry) {
279 let conf = match utils::conf::conf_file(reg.args()) {
281 // if the user specified a file, it must exist, otherwise default to `clippy.toml` but
282 // do not require the file to exist
283 let (ref file_name, must_exist) = if let Some(ref file_name) = file_name {
286 ("clippy.toml", false)
289 let (conf, errors) = utils::conf::read_conf(file_name, must_exist);
291 // all conf errors are non-fatal, we just use the default conf in case of error
292 for error in errors {
293 reg.sess.struct_err(&format!("error reading Clippy's configuration file: {}", error)).emit();
298 Err((err, span)) => {
299 reg.sess.struct_span_err(span, err)
300 .span_note(span, "Clippy will use default configuration")
302 utils::conf::Conf::default()
306 let mut store = reg.sess.lint_store.borrow_mut();
307 store.register_removed("unstable_as_slice", "`Vec::as_slice` has been stabilized in 1.7");
308 store.register_removed("unstable_as_mut_slice", "`Vec::as_mut_slice` has been stabilized in 1.7");
309 store.register_removed("str_to_string", "using `str::to_string` is common even today and specialization will likely happen soon");
310 store.register_removed("string_to_string", "using `string::to_string` is common even today and specialization will likely happen soon");
311 // end deprecated lints, do not remove this comment, it’s used in `update_lints`
313 reg.register_late_lint_pass(box types::TypePass);
314 reg.register_late_lint_pass(box booleans::NonminimalBool);
315 reg.register_late_lint_pass(box misc::TopLevelRefPass);
316 reg.register_late_lint_pass(box misc::CmpNan);
317 reg.register_late_lint_pass(box eq_op::EqOp);
318 reg.register_early_lint_pass(box enum_variants::EnumVariantNames);
319 reg.register_late_lint_pass(box enum_glob_use::EnumGlobUse);
320 reg.register_late_lint_pass(box enum_clike::EnumClikeUnportableVariant);
321 reg.register_late_lint_pass(box bit_mask::BitMask);
322 reg.register_late_lint_pass(box ptr_arg::PtrArg);
323 reg.register_late_lint_pass(box needless_bool::NeedlessBool);
324 reg.register_late_lint_pass(box needless_bool::BoolComparison);
325 reg.register_late_lint_pass(box approx_const::ApproxConstant);
326 reg.register_late_lint_pass(box misc::FloatCmp);
327 reg.register_early_lint_pass(box precedence::Precedence);
328 reg.register_late_lint_pass(box eta_reduction::EtaPass);
329 reg.register_late_lint_pass(box identity_op::IdentityOp);
330 reg.register_early_lint_pass(box items_after_statements::ItemsAfterStatements);
331 reg.register_late_lint_pass(box mut_mut::MutMut);
332 reg.register_late_lint_pass(box mut_reference::UnnecessaryMutPassed);
333 reg.register_late_lint_pass(box len_zero::LenZero);
334 reg.register_late_lint_pass(box misc::CmpOwned);
335 reg.register_late_lint_pass(box attrs::AttrPass);
336 reg.register_late_lint_pass(box collapsible_if::CollapsibleIf);
337 reg.register_late_lint_pass(box block_in_if_condition::BlockInIfCondition);
338 reg.register_late_lint_pass(box misc::ModuloOne);
339 reg.register_late_lint_pass(box unicode::Unicode);
340 reg.register_late_lint_pass(box strings::StringAdd);
341 reg.register_early_lint_pass(box returns::ReturnPass);
342 reg.register_late_lint_pass(box methods::MethodsPass);
343 reg.register_late_lint_pass(box shadow::ShadowPass);
344 reg.register_late_lint_pass(box types::LetPass);
345 reg.register_late_lint_pass(box types::UnitCmp);
346 reg.register_late_lint_pass(box loops::LoopsPass);
347 reg.register_late_lint_pass(box lifetimes::LifetimePass);
348 reg.register_late_lint_pass(box entry::HashMapLint);
349 reg.register_late_lint_pass(box ranges::StepByZero);
350 reg.register_late_lint_pass(box types::CastPass);
351 reg.register_late_lint_pass(box types::TypeComplexityPass::new(conf.type_complexity_threshold));
352 reg.register_late_lint_pass(box matches::MatchPass);
353 reg.register_late_lint_pass(box misc::PatternPass);
354 reg.register_late_lint_pass(box minmax::MinMaxPass);
355 reg.register_late_lint_pass(box open_options::NonSensicalOpenOptions);
356 reg.register_late_lint_pass(box zero_div_zero::ZeroDivZeroPass);
357 reg.register_late_lint_pass(box mutex_atomic::MutexAtomic);
358 reg.register_late_lint_pass(box needless_update::NeedlessUpdatePass);
359 reg.register_late_lint_pass(box needless_borrow::NeedlessBorrow);
360 reg.register_late_lint_pass(box no_effect::NoEffectPass);
361 reg.register_late_lint_pass(box map_clone::MapClonePass);
362 reg.register_late_lint_pass(box temporary_assignment::TemporaryAssignmentPass);
363 reg.register_late_lint_pass(box transmute::Transmute);
364 reg.register_late_lint_pass(box cyclomatic_complexity::CyclomaticComplexity::new(conf.cyclomatic_complexity_threshold));
365 reg.register_late_lint_pass(box escape::EscapePass);
366 reg.register_early_lint_pass(box misc_early::MiscEarly);
367 reg.register_late_lint_pass(box misc::UsedUnderscoreBinding);
368 reg.register_late_lint_pass(box array_indexing::ArrayIndexing);
369 reg.register_late_lint_pass(box panic::PanicPass);
370 reg.register_late_lint_pass(box strings::StringLitAsBytes);
371 reg.register_late_lint_pass(box derive::Derive);
372 reg.register_late_lint_pass(box types::CharLitAsU8);
373 reg.register_late_lint_pass(box print::PrintLint);
374 reg.register_late_lint_pass(box vec::UselessVec);
375 reg.register_early_lint_pass(box non_expressive_names::NonExpressiveNames {
376 max_single_char_names: conf.max_single_char_names,
378 reg.register_late_lint_pass(box drop_ref::DropRefPass);
379 reg.register_late_lint_pass(box types::AbsurdExtremeComparisons);
380 reg.register_late_lint_pass(box types::InvalidUpcastComparisons);
381 reg.register_late_lint_pass(box regex::RegexPass::default());
382 reg.register_late_lint_pass(box copies::CopyAndPaste);
383 reg.register_late_lint_pass(box format::FormatMacLint);
384 reg.register_early_lint_pass(box formatting::Formatting);
385 reg.register_late_lint_pass(box swap::Swap);
386 reg.register_early_lint_pass(box if_not_else::IfNotElse);
387 reg.register_late_lint_pass(box overflow_check_conditional::OverflowCheckConditional);
388 reg.register_late_lint_pass(box unused_label::UnusedLabel);
389 reg.register_late_lint_pass(box new_without_default::NewWithoutDefault);
390 reg.register_late_lint_pass(box blacklisted_name::BlackListedName::new(conf.blacklisted_names));
391 reg.register_late_lint_pass(box functions::Functions::new(conf.too_many_arguments_threshold));
392 reg.register_early_lint_pass(box doc::Doc::new(conf.doc_valid_idents));
393 reg.register_late_lint_pass(box neg_multiply::NegMultiply);
394 reg.register_late_lint_pass(box unsafe_removed_from_name::UnsafeNameRemoval);
395 reg.register_late_lint_pass(box mem_forget::MemForget);
396 reg.register_late_lint_pass(box arithmetic::Arithmetic::default());
397 reg.register_late_lint_pass(box assign_ops::AssignOps);
399 reg.register_lint_group("clippy_restrictions", vec![
400 arithmetic::FLOAT_ARITHMETIC,
401 arithmetic::INTEGER_ARITHMETIC,
402 assign_ops::ASSIGN_OPS,
405 reg.register_lint_group("clippy_pedantic", vec![
406 array_indexing::INDEXING_SLICING,
407 booleans::NONMINIMAL_BOOL,
408 enum_glob_use::ENUM_GLOB_USE,
409 if_not_else::IF_NOT_ELSE,
410 items_after_statements::ITEMS_AFTER_STATEMENTS,
411 matches::SINGLE_MATCH_ELSE,
412 mem_forget::MEM_FORGET,
413 methods::OPTION_UNWRAP_USED,
414 methods::RESULT_UNWRAP_USED,
415 methods::WRONG_PUB_SELF_CONVENTION,
417 mutex_atomic::MUTEX_INTEGER,
418 non_expressive_names::SIMILAR_NAMES,
421 shadow::SHADOW_REUSE,
423 shadow::SHADOW_UNRELATED,
425 strings::STRING_ADD_ASSIGN,
426 types::CAST_POSSIBLE_TRUNCATION,
427 types::CAST_POSSIBLE_WRAP,
428 types::CAST_PRECISION_LOSS,
429 types::CAST_SIGN_LOSS,
430 types::INVALID_UPCAST_COMPARISONS,
431 unicode::NON_ASCII_LITERAL,
432 unicode::UNICODE_NOT_NFC,
435 reg.register_lint_group("clippy", vec![
436 approx_const::APPROX_CONSTANT,
437 array_indexing::OUT_OF_BOUNDS_INDEXING,
438 assign_ops::ASSIGN_OP_PATTERN,
439 attrs::DEPRECATED_SEMVER,
440 attrs::INLINE_ALWAYS,
441 bit_mask::BAD_BIT_MASK,
442 bit_mask::INEFFECTIVE_BIT_MASK,
443 blacklisted_name::BLACKLISTED_NAME,
444 block_in_if_condition::BLOCK_IN_IF_CONDITION_EXPR,
445 block_in_if_condition::BLOCK_IN_IF_CONDITION_STMT,
447 collapsible_if::COLLAPSIBLE_IF,
448 copies::IF_SAME_THEN_ELSE,
449 copies::IFS_SAME_COND,
450 copies::MATCH_SAME_ARMS,
451 cyclomatic_complexity::CYCLOMATIC_COMPLEXITY,
452 derive::DERIVE_HASH_XOR_EQ,
453 derive::EXPL_IMPL_CLONE_ON_COPY,
457 enum_clike::ENUM_CLIKE_UNPORTABLE_VARIANT,
458 enum_variants::ENUM_VARIANT_NAMES,
461 eta_reduction::REDUNDANT_CLOSURE,
462 format::USELESS_FORMAT,
463 formatting::SUSPICIOUS_ASSIGNMENT_FORMATTING,
464 formatting::SUSPICIOUS_ELSE_FORMATTING,
465 functions::TOO_MANY_ARGUMENTS,
466 identity_op::IDENTITY_OP,
467 len_zero::LEN_WITHOUT_IS_EMPTY,
469 lifetimes::NEEDLESS_LIFETIMES,
470 lifetimes::UNUSED_LIFETIMES,
472 loops::EXPLICIT_COUNTER_LOOP,
473 loops::EXPLICIT_ITER_LOOP,
475 loops::FOR_LOOP_OVER_OPTION,
476 loops::FOR_LOOP_OVER_RESULT,
477 loops::ITER_NEXT_LOOP,
478 loops::NEEDLESS_RANGE_LOOP,
479 loops::REVERSE_RANGE_LOOP,
480 loops::UNUSED_COLLECT,
481 loops::WHILE_LET_LOOP,
482 loops::WHILE_LET_ON_ITERATOR,
483 map_clone::MAP_CLONE,
485 matches::MATCH_OVERLAPPING_ARM,
486 matches::MATCH_REF_PATS,
487 matches::SINGLE_MATCH,
488 methods::CHARS_NEXT_CMP,
489 methods::CLONE_DOUBLE_REF,
490 methods::CLONE_ON_COPY,
491 methods::EXTEND_FROM_SLICE,
492 methods::FILTER_NEXT,
493 methods::NEW_RET_NO_SELF,
495 methods::OPTION_MAP_UNWRAP_OR,
496 methods::OPTION_MAP_UNWRAP_OR_ELSE,
497 methods::OR_FUN_CALL,
498 methods::SEARCH_IS_SOME,
499 methods::SHOULD_IMPLEMENT_TRAIT,
500 methods::SINGLE_CHAR_PATTERN,
501 methods::TEMPORARY_CSTRING_AS_PTR,
502 methods::WRONG_SELF_CONVENTION,
508 misc::REDUNDANT_PATTERN,
509 misc::TOPLEVEL_REF_ARG,
510 misc::USED_UNDERSCORE_BINDING,
511 misc_early::DUPLICATE_UNDERSCORE_ARGUMENT,
512 misc_early::REDUNDANT_CLOSURE_CALL,
513 misc_early::UNNEEDED_FIELD_PATTERN,
514 mut_reference::UNNECESSARY_MUT_PASSED,
515 mutex_atomic::MUTEX_ATOMIC,
516 needless_bool::BOOL_COMPARISON,
517 needless_bool::NEEDLESS_BOOL,
518 needless_borrow::NEEDLESS_BORROW,
519 needless_update::NEEDLESS_UPDATE,
520 neg_multiply::NEG_MULTIPLY,
521 new_without_default::NEW_WITHOUT_DEFAULT,
522 no_effect::NO_EFFECT,
523 no_effect::UNNECESSARY_OPERATION,
524 non_expressive_names::MANY_SINGLE_CHAR_NAMES,
525 open_options::NONSENSICAL_OPEN_OPTIONS,
526 overflow_check_conditional::OVERFLOW_CHECK_CONDITIONAL,
528 precedence::PRECEDENCE,
530 ranges::RANGE_STEP_BY_ZERO,
531 ranges::RANGE_ZIP_WITH_LEN,
532 regex::INVALID_REGEX,
534 regex::TRIVIAL_REGEX,
535 returns::LET_AND_RETURN,
536 returns::NEEDLESS_RETURN,
537 strings::STRING_LIT_AS_BYTES,
538 swap::ALMOST_SWAPPED,
540 temporary_assignment::TEMPORARY_ASSIGNMENT,
541 transmute::CROSSPOINTER_TRANSMUTE,
542 transmute::TRANSMUTE_PTR_TO_REF,
543 transmute::USELESS_TRANSMUTE,
544 types::ABSURD_EXTREME_COMPARISONS,
546 types::CHAR_LIT_AS_U8,
547 types::LET_UNIT_VALUE,
549 types::TYPE_COMPLEXITY,
551 unicode::ZERO_WIDTH_SPACE,
552 unsafe_removed_from_name::UNSAFE_REMOVED_FROM_NAME,
553 unused_label::UNUSED_LABEL,
555 zero_div_zero::ZERO_DIVIDED_BY_ZERO,