clippy_lints/src/lib.rs

   1 // error-pattern:cargo-clippy
   2
   3 #![feature(box_syntax)]
   4 #![feature(collections)]
   5 #![feature(custom_attribute)]
   6 #![feature(dotdot_in_tuple_patterns)]
   7 #![feature(question_mark)]
   8 #![feature(rustc_private)]
   9 #![feature(slice_patterns)]
  10 #![feature(stmt_expr_attributes)]
  11
  12 #![allow(indexing_slicing, shadow_reuse, unknown_lints, missing_docs_in_private_items)]
  13
  14 #[macro_use]
  15 extern crate syntax;
  16 #[macro_use]
  17 extern crate rustc;
  18
  19 extern crate toml;
  20
  21 // Only for the compile time checking of paths
  22 extern crate core;
  23 extern crate collections;
  24
  25 // for unicode nfc normalization
  26 extern crate unicode_normalization;
  27
  28 // for semver check in attrs.rs
  29 extern crate semver;
  30
  31 // for regex checking
  32 extern crate regex_syntax;
  33
  34 // for finding minimal boolean expressions
  35 extern crate quine_mc_cluskey;
  36
  37 extern crate rustc_serialize;
  38
  39 extern crate rustc_errors;
  40 extern crate rustc_plugin;
  41 extern crate rustc_const_eval;
  42 extern crate rustc_const_math;
  43
  44 #[macro_use]
  45 extern crate matches as matches_macro;
  46
  47 macro_rules! declare_restriction_lint {
  48     { pub $name:tt, $description:tt } => {
  49         declare_lint! { pub $name, Allow, $description }
  50     };
  51 }
  52
  53 pub mod consts;
  54 #[macro_use]
  55 pub mod utils;
  56
  57 // begin lints modules, do not remove this comment, it’s used in `update_lints`
  58 pub mod approx_const;
  59 pub mod arithmetic;
  60 pub mod array_indexing;
  61 pub mod assign_ops;
  62 pub mod attrs;
  63 pub mod bit_mask;
  64 pub mod blacklisted_name;
  65 pub mod block_in_if_condition;
  66 pub mod booleans;
  67 pub mod collapsible_if;
  68 pub mod copies;
  69 pub mod cyclomatic_complexity;
  70 pub mod derive;
  71 pub mod doc;
  72 pub mod drop_ref;
  73 pub mod entry;
  74 pub mod enum_clike;
  75 pub mod enum_glob_use;
  76 pub mod enum_variants;
  77 pub mod eq_op;
  78 pub mod escape;
  79 pub mod eta_reduction;
  80 pub mod eval_order_dependence;
  81 pub mod format;
  82 pub mod formatting;
  83 pub mod functions;
  84 pub mod identity_op;
  85 pub mod if_not_else;
  86 pub mod items_after_statements;
  87 pub mod len_zero;
  88 pub mod let_if_seq;
  89 pub mod lifetimes;
  90 pub mod loops;
  91 pub mod map_clone;
  92 pub mod matches;
  93 pub mod mem_forget;
  94 pub mod methods;
  95 pub mod minmax;
  96 pub mod misc;
  97 pub mod misc_early;
  98 pub mod missing_doc;
  99 pub mod mut_mut;
 100 pub mod mut_reference;
 101 pub mod mutex_atomic;
 102 pub mod needless_bool;
 103 pub mod needless_borrow;
 104 pub mod needless_update;
 105 pub mod neg_multiply;
 106 pub mod new_without_default;
 107 pub mod no_effect;
 108 pub mod non_expressive_names;
 109 pub mod ok_if_let;
 110 pub mod open_options;
 111 pub mod overflow_check_conditional;
 112 pub mod panic;
 113 pub mod precedence;
 114 pub mod print;
 115 pub mod ptr;
 116 pub mod ranges;
 117 pub mod regex;
 118 pub mod returns;
 119 pub mod serde;
 120 pub mod shadow;
 121 pub mod strings;
 122 pub mod swap;
 123 pub mod temporary_assignment;
 124 pub mod transmute;
 125 pub mod types;
 126 pub mod unicode;
 127 pub mod unsafe_removed_from_name;
 128 pub mod unused_label;
 129 pub mod vec;
 130 pub mod zero_div_zero;
 131 // end lints modules, do not remove this comment, it’s used in `update_lints`
 132
 133 mod reexport {
 134     pub use syntax::ast::{Name, NodeId};
 135 }
 136
 137 #[cfg_attr(rustfmt, rustfmt_skip)]
 138 pub fn register_plugins(reg: &mut rustc_plugin::Registry) {
 139     let conf = match utils::conf::file(reg.args()) {
 140         Ok(file_name) => {
 141             // if the user specified a file, it must exist, otherwise default to `clippy.toml` but
 142             // do not require the file to exist
 143             let (file_name, must_exist) = if let Some(ref file_name) = file_name {
 144                 (&**file_name, true)
 145             } else {
 146                 ("clippy.toml", false)
 147             };
 148
 149             let (conf, errors) = utils::conf::read(file_name, must_exist);
 150
 151             // all conf errors are non-fatal, we just use the default conf in case of error
 152             for error in errors {
 153                 reg.sess.struct_err(&format!("error reading Clippy's configuration file: {}", error)).emit();
 154             }
 155
 156             conf
 157         }
 158         Err((err, span)) => {
 159             reg.sess.struct_span_err(span, err)
 160                     .span_note(span, "Clippy will use default configuration")
 161                     .emit();
 162             utils::conf::Conf::default()
 163         }
 164     };
 165
 166     let mut store = reg.sess.lint_store.borrow_mut();
 167     store.register_removed("unstable_as_slice", "`Vec::as_slice` has been stabilized in 1.7");
 168     store.register_removed("unstable_as_mut_slice", "`Vec::as_mut_slice` has been stabilized in 1.7");
 169     store.register_removed("str_to_string", "using `str::to_string` is common even today and specialization will likely happen soon");
 170     store.register_removed("string_to_string", "using `string::to_string` is common even today and specialization will likely happen soon");
 171     // end deprecated lints, do not remove this comment, it’s used in `update_lints`
 172
 173     reg.register_late_lint_pass(box serde::Serde);
 174     reg.register_early_lint_pass(box utils::internal_lints::Clippy);
 175     reg.register_late_lint_pass(box utils::internal_lints::LintWithoutLintPass::default());
 176     reg.register_late_lint_pass(box types::TypePass);
 177     reg.register_late_lint_pass(box booleans::NonminimalBool);
 178     reg.register_late_lint_pass(box eq_op::EqOp);
 179     reg.register_early_lint_pass(box enum_variants::EnumVariantNames::new(conf.enum_variant_name_threshold));
 180     reg.register_late_lint_pass(box enum_glob_use::EnumGlobUse);
 181     reg.register_late_lint_pass(box enum_clike::UnportableVariant);
 182     reg.register_late_lint_pass(box bit_mask::BitMask);
 183     reg.register_late_lint_pass(box ptr::PointerPass);
 184     reg.register_late_lint_pass(box needless_bool::NeedlessBool);
 185     reg.register_late_lint_pass(box needless_bool::BoolComparison);
 186     reg.register_late_lint_pass(box approx_const::Pass);
 187     reg.register_late_lint_pass(box misc::Pass);
 188     reg.register_early_lint_pass(box precedence::Precedence);
 189     reg.register_late_lint_pass(box eta_reduction::EtaPass);
 190     reg.register_late_lint_pass(box identity_op::IdentityOp);
 191     reg.register_early_lint_pass(box items_after_statements::ItemsAfterStatements);
 192     reg.register_late_lint_pass(box mut_mut::MutMut);
 193     reg.register_late_lint_pass(box mut_reference::UnnecessaryMutPassed);
 194     reg.register_late_lint_pass(box len_zero::LenZero);
 195     reg.register_late_lint_pass(box attrs::AttrPass);
 196     reg.register_early_lint_pass(box collapsible_if::CollapsibleIf);
 197     reg.register_late_lint_pass(box block_in_if_condition::BlockInIfCondition);
 198     reg.register_late_lint_pass(box unicode::Unicode);
 199     reg.register_late_lint_pass(box strings::StringAdd);
 200     reg.register_early_lint_pass(box returns::ReturnPass);
 201     reg.register_late_lint_pass(box methods::Pass);
 202     reg.register_late_lint_pass(box shadow::Pass);
 203     reg.register_late_lint_pass(box types::LetPass);
 204     reg.register_late_lint_pass(box types::UnitCmp);
 205     reg.register_late_lint_pass(box loops::Pass);
 206     reg.register_late_lint_pass(box lifetimes::LifetimePass);
 207     reg.register_late_lint_pass(box entry::HashMapLint);
 208     reg.register_late_lint_pass(box ranges::StepByZero);
 209     reg.register_late_lint_pass(box types::CastPass);
 210     reg.register_late_lint_pass(box types::TypeComplexityPass::new(conf.type_complexity_threshold));
 211     reg.register_late_lint_pass(box matches::MatchPass);
 212     reg.register_late_lint_pass(box minmax::MinMaxPass);
 213     reg.register_late_lint_pass(box open_options::NonSensical);
 214     reg.register_late_lint_pass(box zero_div_zero::Pass);
 215     reg.register_late_lint_pass(box mutex_atomic::MutexAtomic);
 216     reg.register_late_lint_pass(box needless_update::Pass);
 217     reg.register_late_lint_pass(box needless_borrow::NeedlessBorrow);
 218     reg.register_late_lint_pass(box no_effect::Pass);
 219     reg.register_late_lint_pass(box map_clone::Pass);
 220     reg.register_late_lint_pass(box temporary_assignment::Pass);
 221     reg.register_late_lint_pass(box transmute::Transmute);
 222     reg.register_late_lint_pass(box cyclomatic_complexity::CyclomaticComplexity::new(conf.cyclomatic_complexity_threshold));
 223     reg.register_late_lint_pass(box escape::Pass{too_large_for_stack: conf.too_large_for_stack});
 224     reg.register_early_lint_pass(box misc_early::MiscEarly);
 225     reg.register_late_lint_pass(box array_indexing::ArrayIndexing);
 226     reg.register_late_lint_pass(box panic::Pass);
 227     reg.register_late_lint_pass(box strings::StringLitAsBytes);
 228     reg.register_late_lint_pass(box derive::Derive);
 229     reg.register_late_lint_pass(box types::CharLitAsU8);
 230     reg.register_late_lint_pass(box print::Pass);
 231     reg.register_late_lint_pass(box vec::Pass);
 232     reg.register_early_lint_pass(box non_expressive_names::NonExpressiveNames {
 233         max_single_char_names: conf.max_single_char_names,
 234     });
 235     reg.register_late_lint_pass(box drop_ref::Pass);
 236     reg.register_late_lint_pass(box types::AbsurdExtremeComparisons);
 237     reg.register_late_lint_pass(box types::InvalidUpcastComparisons);
 238     reg.register_late_lint_pass(box regex::Pass::default());
 239     reg.register_late_lint_pass(box copies::CopyAndPaste);
 240     reg.register_late_lint_pass(box format::Pass);
 241     reg.register_early_lint_pass(box formatting::Formatting);
 242     reg.register_late_lint_pass(box swap::Swap);
 243     reg.register_early_lint_pass(box if_not_else::IfNotElse);
 244     reg.register_late_lint_pass(box overflow_check_conditional::OverflowCheckConditional);
 245     reg.register_late_lint_pass(box unused_label::UnusedLabel);
 246     reg.register_late_lint_pass(box new_without_default::NewWithoutDefault);
 247     reg.register_late_lint_pass(box blacklisted_name::BlackListedName::new(conf.blacklisted_names));
 248     reg.register_late_lint_pass(box functions::Functions::new(conf.too_many_arguments_threshold));
 249     reg.register_early_lint_pass(box doc::Doc::new(conf.doc_valid_idents));
 250     reg.register_late_lint_pass(box neg_multiply::NegMultiply);
 251     reg.register_late_lint_pass(box unsafe_removed_from_name::UnsafeNameRemoval);
 252     reg.register_late_lint_pass(box mem_forget::MemForget);
 253     reg.register_late_lint_pass(box arithmetic::Arithmetic::default());
 254     reg.register_late_lint_pass(box assign_ops::AssignOps);
 255     reg.register_late_lint_pass(box let_if_seq::LetIfSeq);
 256     reg.register_late_lint_pass(box eval_order_dependence::EvalOrderDependence);
 257     reg.register_late_lint_pass(box missing_doc::MissingDoc::new());
 258     reg.register_late_lint_pass(box ok_if_let::OkIfLetPass);
 259
 260     reg.register_lint_group("clippy_restrictions", vec![
 261         arithmetic::FLOAT_ARITHMETIC,
 262         arithmetic::INTEGER_ARITHMETIC,
 263         array_indexing::INDEXING_SLICING,
 264         assign_ops::ASSIGN_OPS,
 265     ]);
 266
 267     reg.register_lint_group("clippy_pedantic", vec![
 268         booleans::NONMINIMAL_BOOL,
 269         enum_glob_use::ENUM_GLOB_USE,
 270         enum_variants::STUTTER,
 271         if_not_else::IF_NOT_ELSE,
 272         items_after_statements::ITEMS_AFTER_STATEMENTS,
 273         matches::SINGLE_MATCH_ELSE,
 274         mem_forget::MEM_FORGET,
 275         methods::FILTER_MAP,
 276         methods::OPTION_UNWRAP_USED,
 277         methods::RESULT_UNWRAP_USED,
 278         methods::WRONG_PUB_SELF_CONVENTION,
 279         misc::USED_UNDERSCORE_BINDING,
 280         misc_early::UNSEPARATED_LITERAL_SUFFIX,
 281         missing_doc::MISSING_DOCS_IN_PRIVATE_ITEMS,
 282         mut_mut::MUT_MUT,
 283         mutex_atomic::MUTEX_INTEGER,
 284         non_expressive_names::SIMILAR_NAMES,
 285         print::PRINT_STDOUT,
 286         print::USE_DEBUG,
 287         shadow::SHADOW_REUSE,
 288         shadow::SHADOW_SAME,
 289         shadow::SHADOW_UNRELATED,
 290         strings::STRING_ADD,
 291         strings::STRING_ADD_ASSIGN,
 292         types::CAST_POSSIBLE_TRUNCATION,
 293         types::CAST_POSSIBLE_WRAP,
 294         types::CAST_PRECISION_LOSS,
 295         types::CAST_SIGN_LOSS,
 296         types::INVALID_UPCAST_COMPARISONS,
 297         unicode::NON_ASCII_LITERAL,
 298         unicode::UNICODE_NOT_NFC,
 299     ]);
 300
 301     reg.register_lint_group("clippy_internal", vec![
 302         utils::internal_lints::CLIPPY_LINTS_INTERNAL,
 303         utils::internal_lints::LINT_WITHOUT_LINT_PASS,
 304     ]);
 305
 306     reg.register_lint_group("clippy", vec![
 307         approx_const::APPROX_CONSTANT,
 308         array_indexing::OUT_OF_BOUNDS_INDEXING,
 309         assign_ops::ASSIGN_OP_PATTERN,
 310         assign_ops::MISREFACTORED_ASSIGN_OP,
 311         attrs::DEPRECATED_SEMVER,
 312         attrs::INLINE_ALWAYS,
 313         attrs::USELESS_ATTRIBUTE,
 314         bit_mask::BAD_BIT_MASK,
 315         bit_mask::INEFFECTIVE_BIT_MASK,
 316         blacklisted_name::BLACKLISTED_NAME,
 317         block_in_if_condition::BLOCK_IN_IF_CONDITION_EXPR,
 318         block_in_if_condition::BLOCK_IN_IF_CONDITION_STMT,
 319         booleans::LOGIC_BUG,
 320         collapsible_if::COLLAPSIBLE_IF,
 321         copies::IF_SAME_THEN_ELSE,
 322         copies::IFS_SAME_COND,
 323         copies::MATCH_SAME_ARMS,
 324         cyclomatic_complexity::CYCLOMATIC_COMPLEXITY,
 325         derive::DERIVE_HASH_XOR_EQ,
 326         derive::EXPL_IMPL_CLONE_ON_COPY,
 327         doc::DOC_MARKDOWN,
 328         drop_ref::DROP_REF,
 329         entry::MAP_ENTRY,
 330         enum_clike::ENUM_CLIKE_UNPORTABLE_VARIANT,
 331         enum_variants::ENUM_VARIANT_NAMES,
 332         enum_variants::MODULE_INCEPTION,
 333         eq_op::EQ_OP,
 334         escape::BOXED_LOCAL,
 335         eta_reduction::REDUNDANT_CLOSURE,
 336         eval_order_dependence::DIVERGING_SUB_EXPRESSION,
 337         eval_order_dependence::EVAL_ORDER_DEPENDENCE,
 338         format::USELESS_FORMAT,
 339         formatting::SUSPICIOUS_ASSIGNMENT_FORMATTING,
 340         formatting::SUSPICIOUS_ELSE_FORMATTING,
 341         functions::NOT_UNSAFE_PTR_ARG_DEREF,
 342         functions::TOO_MANY_ARGUMENTS,
 343         identity_op::IDENTITY_OP,
 344         len_zero::LEN_WITHOUT_IS_EMPTY,
 345         len_zero::LEN_ZERO,
 346         let_if_seq::USELESS_LET_IF_SEQ,
 347         lifetimes::NEEDLESS_LIFETIMES,
 348         lifetimes::UNUSED_LIFETIMES,
 349         loops::EMPTY_LOOP,
 350         loops::EXPLICIT_COUNTER_LOOP,
 351         loops::EXPLICIT_INTO_ITER_LOOP,
 352         loops::EXPLICIT_ITER_LOOP,
 353         loops::FOR_KV_MAP,
 354         loops::FOR_LOOP_OVER_OPTION,
 355         loops::FOR_LOOP_OVER_RESULT,
 356         loops::ITER_NEXT_LOOP,
 357         loops::NEEDLESS_RANGE_LOOP,
 358         loops::REVERSE_RANGE_LOOP,
 359         loops::UNUSED_COLLECT,
 360         loops::WHILE_LET_LOOP,
 361         loops::WHILE_LET_ON_ITERATOR,
 362         map_clone::MAP_CLONE,
 363         matches::MATCH_BOOL,
 364         matches::MATCH_OVERLAPPING_ARM,
 365         matches::MATCH_REF_PATS,
 366         matches::SINGLE_MATCH,
 367         methods::CHARS_NEXT_CMP,
 368         methods::CLONE_DOUBLE_REF,
 369         methods::CLONE_ON_COPY,
 370         methods::EXTEND_FROM_SLICE,
 371         methods::FILTER_NEXT,
 372         methods::ITER_NTH,
 373         methods::NEW_RET_NO_SELF,
 374         methods::OK_EXPECT,
 375         methods::OPTION_MAP_UNWRAP_OR,
 376         methods::OPTION_MAP_UNWRAP_OR_ELSE,
 377         methods::OR_FUN_CALL,
 378         methods::SEARCH_IS_SOME,
 379         methods::SHOULD_IMPLEMENT_TRAIT,
 380         methods::SINGLE_CHAR_PATTERN,
 381         methods::TEMPORARY_CSTRING_AS_PTR,
 382         methods::WRONG_SELF_CONVENTION,
 383         minmax::MIN_MAX,
 384         misc::CMP_NAN,
 385         misc::CMP_OWNED,
 386         misc::FLOAT_CMP,
 387         misc::MODULO_ONE,
 388         misc::REDUNDANT_PATTERN,
 389         misc::TOPLEVEL_REF_ARG,
 390         misc_early::BUILTIN_TYPE_SHADOW,
 391         misc_early::DOUBLE_NEG,
 392         misc_early::DUPLICATE_UNDERSCORE_ARGUMENT,
 393         misc_early::MIXED_CASE_HEX_LITERALS,
 394         misc_early::REDUNDANT_CLOSURE_CALL,
 395         misc_early::UNNEEDED_FIELD_PATTERN,
 396         misc_early::ZERO_PREFIXED_LITERAL,
 397         mut_reference::UNNECESSARY_MUT_PASSED,
 398         mutex_atomic::MUTEX_ATOMIC,
 399         needless_bool::BOOL_COMPARISON,
 400         needless_bool::NEEDLESS_BOOL,
 401         needless_borrow::NEEDLESS_BORROW,
 402         needless_update::NEEDLESS_UPDATE,
 403         neg_multiply::NEG_MULTIPLY,
 404         new_without_default::NEW_WITHOUT_DEFAULT,
 405         new_without_default::NEW_WITHOUT_DEFAULT_DERIVE,
 406         no_effect::NO_EFFECT,
 407         no_effect::UNNECESSARY_OPERATION,
 408         non_expressive_names::MANY_SINGLE_CHAR_NAMES,
 409         ok_if_let::IF_LET_SOME_RESULT,
 410         open_options::NONSENSICAL_OPEN_OPTIONS,
 411         overflow_check_conditional::OVERFLOW_CHECK_CONDITIONAL,
 412         panic::PANIC_PARAMS,
 413         precedence::PRECEDENCE,
 414         print::PRINT_WITH_NEWLINE,
 415         ptr::CMP_NULL,
 416         ptr::PTR_ARG,
 417         ranges::RANGE_STEP_BY_ZERO,
 418         ranges::RANGE_ZIP_WITH_LEN,
 419         regex::INVALID_REGEX,
 420         regex::REGEX_MACRO,
 421         regex::TRIVIAL_REGEX,
 422         returns::LET_AND_RETURN,
 423         returns::NEEDLESS_RETURN,
 424         serde::SERDE_API_MISUSE,
 425         strings::STRING_LIT_AS_BYTES,
 426         swap::ALMOST_SWAPPED,
 427         swap::MANUAL_SWAP,
 428         temporary_assignment::TEMPORARY_ASSIGNMENT,
 429         transmute::CROSSPOINTER_TRANSMUTE,
 430         transmute::TRANSMUTE_PTR_TO_REF,
 431         transmute::USELESS_TRANSMUTE,
 432         transmute::WRONG_TRANSMUTE,
 433         types::ABSURD_EXTREME_COMPARISONS,
 434         types::BOX_VEC,
 435         types::CHAR_LIT_AS_U8,
 436         types::LET_UNIT_VALUE,
 437         types::LINKEDLIST,
 438         types::TYPE_COMPLEXITY,
 439         types::UNIT_CMP,
 440         unicode::ZERO_WIDTH_SPACE,
 441         unsafe_removed_from_name::UNSAFE_REMOVED_FROM_NAME,
 442         unused_label::UNUSED_LABEL,
 443         vec::USELESS_VEC,
 444         zero_div_zero::ZERO_DIVIDED_BY_ZERO,
 445     ]);
 446 }
 447
 448 // only exists to let the dogfood integration test works.
 449 // Don't run clippy as an executable directly
 450 #[allow(dead_code, print_stdout)]
 451 fn main() {
 452     panic!("Please use the cargo-clippy executable");
 453 }