clippy_lints/src/lib.rs

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