src/lib.rs

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