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