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