clippy_lints/src/lib.rs

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