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