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 #![feature(type_macros)]
  12
  13 #![allow(indexing_slicing, shadow_reuse, unknown_lints)]
  14
  15 #[macro_use]
  16 extern crate syntax;
  17 #[macro_use]
  18 extern crate rustc;
  19
  20 extern crate toml;
  21
  22 // Only for the compile time checking of paths
  23 extern crate core;
  24 extern crate collections;
  25
  26 // for unicode nfc normalization
  27 extern crate unicode_normalization;
  28
  29 // for semver check in attrs.rs
  30 extern crate semver;
  31
  32 // for regex checking
  33 extern crate regex_syntax;
  34
  35 // for finding minimal boolean expressions
  36 extern crate quine_mc_cluskey;
  37
  38 extern crate rustc_serialize;
  39
  40 extern crate rustc_errors;
  41 extern crate rustc_plugin;
  42 extern crate rustc_const_eval;
  43 extern crate rustc_const_math;
  44
  45 #[macro_use]
  46 extern crate matches as matches_macro;
  47
  48 macro_rules! declare_restriction_lint {
  49     { pub $name:tt, $description:tt } => {
  50         declare_lint! { pub $name, Allow, $description }
  51     };
  52 }
  53
  54 pub mod consts;
  55 #[macro_use]
  56 pub mod utils;
  57
  58 // begin lints modules, do not remove this comment, it’s used in `update_lints`
  59 pub mod approx_const;
  60 pub mod arithmetic;
  61 pub mod array_indexing;
  62 pub mod assign_ops;
  63 pub mod attrs;
  64 pub mod bit_mask;
  65 pub mod blacklisted_name;
  66 pub mod block_in_if_condition;
  67 pub mod booleans;
  68 pub mod collapsible_if;
  69 pub mod copies;
  70 pub mod cyclomatic_complexity;
  71 pub mod derive;
  72 pub mod doc;
  73 pub mod drop_ref;
  74 pub mod entry;
  75 pub mod enum_clike;
  76 pub mod enum_glob_use;
  77 pub mod enum_variants;
  78 pub mod eq_op;
  79 pub mod escape;
  80 pub mod eta_reduction;
  81 pub mod eval_order_dependence;
  82 pub mod format;
  83 pub mod formatting;
  84 pub mod functions;
  85 pub mod identity_op;
  86 pub mod if_not_else;
  87 pub mod items_after_statements;
  88 pub mod len_zero;
  89 pub mod let_if_seq;
  90 pub mod lifetimes;
  91 pub mod loops;
  92 pub mod map_clone;
  93 pub mod matches;
  94 pub mod mem_forget;
  95 pub mod methods;
  96 pub mod minmax;
  97 pub mod misc;
  98 pub mod misc_early;
  99 pub mod module_inception;
 100 pub mod mut_mut;
 101 pub mod mut_reference;
 102 pub mod mutex_atomic;
 103 pub mod needless_bool;
 104 pub mod needless_borrow;
 105 pub mod needless_update;
 106 pub mod neg_multiply;
 107 pub mod new_without_default;
 108 pub mod no_effect;
 109 pub mod non_expressive_names;
 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_arg;
 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 types::TypePass);
 176     reg.register_late_lint_pass(box booleans::NonminimalBool);
 177     reg.register_early_lint_pass(box module_inception::Pass);
 178     reg.register_late_lint_pass(box misc::TopLevelRefPass);
 179     reg.register_late_lint_pass(box misc::CmpNan);
 180     reg.register_late_lint_pass(box eq_op::EqOp);
 181     reg.register_early_lint_pass(box enum_variants::EnumVariantNames::new(conf.enum_variant_name_threshold));
 182     reg.register_late_lint_pass(box enum_glob_use::EnumGlobUse);
 183     reg.register_late_lint_pass(box enum_clike::UnportableVariant);
 184     reg.register_late_lint_pass(box bit_mask::BitMask);
 185     reg.register_late_lint_pass(box ptr_arg::PtrArg);
 186     reg.register_late_lint_pass(box needless_bool::NeedlessBool);
 187     reg.register_late_lint_pass(box needless_bool::BoolComparison);
 188     reg.register_late_lint_pass(box approx_const::Pass);
 189     reg.register_late_lint_pass(box misc::FloatCmp);
 190     reg.register_early_lint_pass(box precedence::Precedence);
 191     reg.register_late_lint_pass(box eta_reduction::EtaPass);
 192     reg.register_late_lint_pass(box identity_op::IdentityOp);
 193     reg.register_early_lint_pass(box items_after_statements::ItemsAfterStatements);
 194     reg.register_late_lint_pass(box mut_mut::MutMut);
 195     reg.register_late_lint_pass(box mut_reference::UnnecessaryMutPassed);
 196     reg.register_late_lint_pass(box len_zero::LenZero);
 197     reg.register_late_lint_pass(box misc::CmpOwned);
 198     reg.register_late_lint_pass(box attrs::AttrPass);
 199     reg.register_early_lint_pass(box collapsible_if::CollapsibleIf);
 200     reg.register_late_lint_pass(box block_in_if_condition::BlockInIfCondition);
 201     reg.register_late_lint_pass(box misc::ModuloOne);
 202     reg.register_late_lint_pass(box unicode::Unicode);
 203     reg.register_late_lint_pass(box strings::StringAdd);
 204     reg.register_early_lint_pass(box returns::ReturnPass);
 205     reg.register_late_lint_pass(box methods::Pass);
 206     reg.register_late_lint_pass(box shadow::Pass);
 207     reg.register_late_lint_pass(box types::LetPass);
 208     reg.register_late_lint_pass(box types::UnitCmp);
 209     reg.register_late_lint_pass(box loops::Pass);
 210     reg.register_late_lint_pass(box lifetimes::LifetimePass);
 211     reg.register_late_lint_pass(box entry::HashMapLint);
 212     reg.register_late_lint_pass(box ranges::StepByZero);
 213     reg.register_late_lint_pass(box types::CastPass);
 214     reg.register_late_lint_pass(box types::TypeComplexityPass::new(conf.type_complexity_threshold));
 215     reg.register_late_lint_pass(box matches::MatchPass);
 216     reg.register_late_lint_pass(box misc::PatternPass);
 217     reg.register_late_lint_pass(box minmax::MinMaxPass);
 218     reg.register_late_lint_pass(box open_options::NonSensical);
 219     reg.register_late_lint_pass(box zero_div_zero::Pass);
 220     reg.register_late_lint_pass(box mutex_atomic::MutexAtomic);
 221     reg.register_late_lint_pass(box needless_update::Pass);
 222     reg.register_late_lint_pass(box needless_borrow::NeedlessBorrow);
 223     reg.register_late_lint_pass(box no_effect::Pass);
 224     reg.register_late_lint_pass(box map_clone::Pass);
 225     reg.register_late_lint_pass(box temporary_assignment::Pass);
 226     reg.register_late_lint_pass(box transmute::Transmute);
 227     reg.register_late_lint_pass(box cyclomatic_complexity::CyclomaticComplexity::new(conf.cyclomatic_complexity_threshold));
 228     reg.register_late_lint_pass(box escape::Pass{too_large_for_stack: conf.too_large_for_stack});
 229     reg.register_early_lint_pass(box misc_early::MiscEarly);
 230     reg.register_late_lint_pass(box misc::UsedUnderscoreBinding);
 231     reg.register_late_lint_pass(box array_indexing::ArrayIndexing);
 232     reg.register_late_lint_pass(box panic::Pass);
 233     reg.register_late_lint_pass(box strings::StringLitAsBytes);
 234     reg.register_late_lint_pass(box derive::Derive);
 235     reg.register_late_lint_pass(box types::CharLitAsU8);
 236     reg.register_late_lint_pass(box print::Pass);
 237     reg.register_late_lint_pass(box vec::Pass);
 238     reg.register_early_lint_pass(box non_expressive_names::NonExpressiveNames {
 239         max_single_char_names: conf.max_single_char_names,
 240     });
 241     reg.register_late_lint_pass(box drop_ref::Pass);
 242     reg.register_late_lint_pass(box types::AbsurdExtremeComparisons);
 243     reg.register_late_lint_pass(box types::InvalidUpcastComparisons);
 244     reg.register_late_lint_pass(box regex::Pass::default());
 245     reg.register_late_lint_pass(box copies::CopyAndPaste);
 246     reg.register_late_lint_pass(box format::Pass);
 247     reg.register_early_lint_pass(box formatting::Formatting);
 248     reg.register_late_lint_pass(box swap::Swap);
 249     reg.register_early_lint_pass(box if_not_else::IfNotElse);
 250     reg.register_late_lint_pass(box overflow_check_conditional::OverflowCheckConditional);
 251     reg.register_late_lint_pass(box unused_label::UnusedLabel);
 252     reg.register_late_lint_pass(box new_without_default::NewWithoutDefault);
 253     reg.register_late_lint_pass(box blacklisted_name::BlackListedName::new(conf.blacklisted_names));
 254     reg.register_late_lint_pass(box functions::Functions::new(conf.too_many_arguments_threshold));
 255     reg.register_early_lint_pass(box doc::Doc::new(conf.doc_valid_idents));
 256     reg.register_late_lint_pass(box neg_multiply::NegMultiply);
 257     reg.register_late_lint_pass(box unsafe_removed_from_name::UnsafeNameRemoval);
 258     reg.register_late_lint_pass(box mem_forget::MemForget);
 259     reg.register_late_lint_pass(box arithmetic::Arithmetic::default());
 260     reg.register_late_lint_pass(box assign_ops::AssignOps);
 261     reg.register_late_lint_pass(box let_if_seq::LetIfSeq);
 262     reg.register_late_lint_pass(box eval_order_dependence::EvalOrderDependence);
 263
 264     reg.register_lint_group("clippy_restrictions", vec![
 265         arithmetic::FLOAT_ARITHMETIC,
 266         arithmetic::INTEGER_ARITHMETIC,
 267         array_indexing::INDEXING_SLICING,
 268         assign_ops::ASSIGN_OPS,
 269     ]);
 270
 271     reg.register_lint_group("clippy_pedantic", vec![
 272         booleans::NONMINIMAL_BOOL,
 273         enum_glob_use::ENUM_GLOB_USE,
 274         enum_variants::STUTTER,
 275         if_not_else::IF_NOT_ELSE,
 276         items_after_statements::ITEMS_AFTER_STATEMENTS,
 277         matches::SINGLE_MATCH_ELSE,
 278         mem_forget::MEM_FORGET,
 279         methods::FILTER_MAP,
 280         methods::OPTION_UNWRAP_USED,
 281         methods::RESULT_UNWRAP_USED,
 282         methods::WRONG_PUB_SELF_CONVENTION,
 283         misc::USED_UNDERSCORE_BINDING,
 284         misc_early::UNSEPARATED_LITERAL_SUFFIX,
 285         mut_mut::MUT_MUT,
 286         mutex_atomic::MUTEX_INTEGER,
 287         non_expressive_names::SIMILAR_NAMES,
 288         print::PRINT_STDOUT,
 289         print::USE_DEBUG,
 290         shadow::SHADOW_REUSE,
 291         shadow::SHADOW_SAME,
 292         shadow::SHADOW_UNRELATED,
 293         strings::STRING_ADD,
 294         strings::STRING_ADD_ASSIGN,
 295         types::CAST_POSSIBLE_TRUNCATION,
 296         types::CAST_POSSIBLE_WRAP,
 297         types::CAST_PRECISION_LOSS,
 298         types::CAST_SIGN_LOSS,
 299         types::INVALID_UPCAST_COMPARISONS,
 300         unicode::NON_ASCII_LITERAL,
 301         unicode::UNICODE_NOT_NFC,
 302     ]);
 303
 304     reg.register_lint_group("clippy", vec![
 305         approx_const::APPROX_CONSTANT,
 306         array_indexing::OUT_OF_BOUNDS_INDEXING,
 307         assign_ops::ASSIGN_OP_PATTERN,
 308         assign_ops::MISREFACTORED_ASSIGN_OP,
 309         attrs::DEPRECATED_SEMVER,
 310         attrs::INLINE_ALWAYS,
 311         bit_mask::BAD_BIT_MASK,
 312         bit_mask::INEFFECTIVE_BIT_MASK,
 313         blacklisted_name::BLACKLISTED_NAME,
 314         block_in_if_condition::BLOCK_IN_IF_CONDITION_EXPR,
 315         block_in_if_condition::BLOCK_IN_IF_CONDITION_STMT,
 316         booleans::LOGIC_BUG,
 317         collapsible_if::COLLAPSIBLE_IF,
 318         copies::IF_SAME_THEN_ELSE,
 319         copies::IFS_SAME_COND,
 320         copies::MATCH_SAME_ARMS,
 321         cyclomatic_complexity::CYCLOMATIC_COMPLEXITY,
 322         derive::DERIVE_HASH_XOR_EQ,
 323         derive::EXPL_IMPL_CLONE_ON_COPY,
 324         doc::DOC_MARKDOWN,
 325         drop_ref::DROP_REF,
 326         entry::MAP_ENTRY,
 327         enum_clike::ENUM_CLIKE_UNPORTABLE_VARIANT,
 328         enum_variants::ENUM_VARIANT_NAMES,
 329         eq_op::EQ_OP,
 330         escape::BOXED_LOCAL,
 331         eta_reduction::REDUNDANT_CLOSURE,
 332         eval_order_dependence::EVAL_ORDER_DEPENDENCE,
 333         format::USELESS_FORMAT,
 334         formatting::SUSPICIOUS_ASSIGNMENT_FORMATTING,
 335         formatting::SUSPICIOUS_ELSE_FORMATTING,
 336         functions::NOT_UNSAFE_PTR_ARG_DEREF,
 337         functions::TOO_MANY_ARGUMENTS,
 338         identity_op::IDENTITY_OP,
 339         len_zero::LEN_WITHOUT_IS_EMPTY,
 340         len_zero::LEN_ZERO,
 341         let_if_seq::USELESS_LET_IF_SEQ,
 342         lifetimes::NEEDLESS_LIFETIMES,
 343         lifetimes::UNUSED_LIFETIMES,
 344         loops::EMPTY_LOOP,
 345         loops::EXPLICIT_COUNTER_LOOP,
 346         loops::EXPLICIT_ITER_LOOP,
 347         loops::FOR_KV_MAP,
 348         loops::FOR_LOOP_OVER_OPTION,
 349         loops::FOR_LOOP_OVER_RESULT,
 350         loops::ITER_NEXT_LOOP,
 351         loops::NEEDLESS_RANGE_LOOP,
 352         loops::REVERSE_RANGE_LOOP,
 353         loops::UNUSED_COLLECT,
 354         loops::WHILE_LET_LOOP,
 355         loops::WHILE_LET_ON_ITERATOR,
 356         map_clone::MAP_CLONE,
 357         matches::MATCH_BOOL,
 358         matches::MATCH_OVERLAPPING_ARM,
 359         matches::MATCH_REF_PATS,
 360         matches::SINGLE_MATCH,
 361         methods::CHARS_NEXT_CMP,
 362         methods::CLONE_DOUBLE_REF,
 363         methods::CLONE_ON_COPY,
 364         methods::EXTEND_FROM_SLICE,
 365         methods::FILTER_NEXT,
 366         methods::ITER_NTH,
 367         methods::NEW_RET_NO_SELF,
 368         methods::OK_EXPECT,
 369         methods::OPTION_MAP_UNWRAP_OR,
 370         methods::OPTION_MAP_UNWRAP_OR_ELSE,
 371         methods::OR_FUN_CALL,
 372         methods::SEARCH_IS_SOME,
 373         methods::SHOULD_IMPLEMENT_TRAIT,
 374         methods::SINGLE_CHAR_PATTERN,
 375         methods::TEMPORARY_CSTRING_AS_PTR,
 376         methods::WRONG_SELF_CONVENTION,
 377         minmax::MIN_MAX,
 378         misc::CMP_NAN,
 379         misc::CMP_OWNED,
 380         misc::FLOAT_CMP,
 381         misc::MODULO_ONE,
 382         misc::REDUNDANT_PATTERN,
 383         misc::TOPLEVEL_REF_ARG,
 384         misc_early::DOUBLE_NEG,
 385         misc_early::DUPLICATE_UNDERSCORE_ARGUMENT,
 386         misc_early::MIXED_CASE_HEX_LITERALS,
 387         misc_early::REDUNDANT_CLOSURE_CALL,
 388         misc_early::UNNEEDED_FIELD_PATTERN,
 389         module_inception::MODULE_INCEPTION,
 390         mut_reference::UNNECESSARY_MUT_PASSED,
 391         mutex_atomic::MUTEX_ATOMIC,
 392         needless_bool::BOOL_COMPARISON,
 393         needless_bool::NEEDLESS_BOOL,
 394         needless_borrow::NEEDLESS_BORROW,
 395         needless_update::NEEDLESS_UPDATE,
 396         neg_multiply::NEG_MULTIPLY,
 397         new_without_default::NEW_WITHOUT_DEFAULT,
 398         new_without_default::NEW_WITHOUT_DEFAULT_DERIVE,
 399         no_effect::NO_EFFECT,
 400         no_effect::UNNECESSARY_OPERATION,
 401         non_expressive_names::MANY_SINGLE_CHAR_NAMES,
 402         open_options::NONSENSICAL_OPEN_OPTIONS,
 403         overflow_check_conditional::OVERFLOW_CHECK_CONDITIONAL,
 404         panic::PANIC_PARAMS,
 405         precedence::PRECEDENCE,
 406         ptr_arg::PTR_ARG,
 407         ranges::RANGE_STEP_BY_ZERO,
 408         ranges::RANGE_ZIP_WITH_LEN,
 409         regex::INVALID_REGEX,
 410         regex::REGEX_MACRO,
 411         regex::TRIVIAL_REGEX,
 412         returns::LET_AND_RETURN,
 413         returns::NEEDLESS_RETURN,
 414         serde::SERDE_API_MISUSE,
 415         strings::STRING_LIT_AS_BYTES,
 416         swap::ALMOST_SWAPPED,
 417         swap::MANUAL_SWAP,
 418         temporary_assignment::TEMPORARY_ASSIGNMENT,
 419         transmute::CROSSPOINTER_TRANSMUTE,
 420         transmute::TRANSMUTE_PTR_TO_REF,
 421         transmute::USELESS_TRANSMUTE,
 422         transmute::WRONG_TRANSMUTE,
 423         types::ABSURD_EXTREME_COMPARISONS,
 424         types::BOX_VEC,
 425         types::CHAR_LIT_AS_U8,
 426         types::LET_UNIT_VALUE,
 427         types::LINKEDLIST,
 428         types::TYPE_COMPLEXITY,
 429         types::UNIT_CMP,
 430         unicode::ZERO_WIDTH_SPACE,
 431         unsafe_removed_from_name::UNSAFE_REMOVED_FROM_NAME,
 432         unused_label::UNUSED_LABEL,
 433         vec::USELESS_VEC,
 434         zero_div_zero::ZERO_DIVIDED_BY_ZERO,
 435     ]);
 436 }
 437
 438 // only exists to let the dogfood integration test works.
 439 // Don't run clippy as an executable directly
 440 #[allow(dead_code, print_stdout)]
 441 fn main() {
 442     panic!("Please use the cargo-clippy executable");
 443 }