src/librustc_lint/lib.rs

   1 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! Lints in the Rust compiler.
  12 //!
  13 //! This currently only contains the definitions and implementations
  14 //! of most of the lints that `rustc` supports directly, it does not
  15 //! contain the infrastructure for defining/registering lints. That is
  16 //! available in `rustc::lint` and `rustc_plugin` respectively.
  17 //!
  18 //! # Note
  19 //!
  20 //! This API is completely unstable and subject to change.
  21
  22 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
  23       html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
  24       html_root_url = "https://doc.rust-lang.org/nightly/")]
  25
  26 #![cfg_attr(test, feature(test))]
  27 #![feature(box_patterns)]
  28 #![feature(box_syntax)]
  29 #![feature(macro_vis_matcher)]
  30 #![feature(quote)]
  31 #![feature(rustc_diagnostic_macros)]
  32 #![feature(macro_at_most_once_rep)]
  33
  34 extern crate syntax;
  35 #[macro_use]
  36 extern crate rustc;
  37 #[macro_use]
  38 extern crate log;
  39 extern crate rustc_mir;
  40 extern crate rustc_target;
  41 extern crate syntax_pos;
  42
  43 use rustc::lint;
  44 use rustc::lint::{LateContext, LateLintPass, LintPass, LintArray};
  45 use rustc::lint::builtin::{BARE_TRAIT_OBJECTS, ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE};
  46 use rustc::session;
  47 use rustc::util;
  48 use rustc::hir;
  49
  50 use syntax::ast;
  51 use syntax_pos::Span;
  52
  53 use session::Session;
  54 use syntax::edition::Edition;
  55 use lint::LintId;
  56 use lint::FutureIncompatibleInfo;
  57
  58 mod bad_style;
  59 mod builtin;
  60 mod types;
  61 mod unused;
  62
  63 use bad_style::*;
  64 use builtin::*;
  65 use types::*;
  66 use unused::*;
  67
  68 /// Useful for other parts of the compiler.
  69 pub use builtin::SoftLints;
  70
  71 /// Tell the `LintStore` about all the built-in lints (the ones
  72 /// defined in this crate and the ones defined in
  73 /// `rustc::lint::builtin`).
  74 pub fn register_builtins(store: &mut lint::LintStore, sess: Option<&Session>) {
  75     macro_rules! add_early_builtin {
  76         ($sess:ident, $($name:ident),*,) => (
  77             {$(
  78                 store.register_early_pass($sess, false, box $name);
  79                 )*}
  80             )
  81     }
  82
  83     macro_rules! add_early_builtin_with_new {
  84         ($sess:ident, $($name:ident),*,) => (
  85             {$(
  86                 store.register_early_pass($sess, false, box $name::new());
  87                 )*}
  88             )
  89     }
  90
  91     macro_rules! add_lint_group {
  92         ($sess:ident, $name:expr, $($lint:ident),*) => (
  93             store.register_group($sess, false, $name, vec![$(LintId::of($lint)),*]);
  94             )
  95     }
  96
  97     add_early_builtin!(sess,
  98                        UnusedParens,
  99                        UnusedImportBraces,
 100                        AnonymousParameters,
 101                        UnusedDocComment,
 102                        BadRepr,
 103                        EllipsisInclusiveRangePatterns,
 104                        );
 105
 106     add_early_builtin_with_new!(sess,
 107                                 DeprecatedAttr,
 108                                 );
 109
 110     late_lint_methods!(declare_combined_late_lint_pass, [BuiltinCombinedLateLintPass, [
 111         HardwiredLints: HardwiredLints,
 112         WhileTrue: WhileTrue,
 113         ImproperCTypes: ImproperCTypes,
 114         VariantSizeDifferences: VariantSizeDifferences,
 115         BoxPointers: BoxPointers,
 116         UnusedAttributes: UnusedAttributes,
 117         PathStatements: PathStatements,
 118         UnusedResults: UnusedResults,
 119         NonCamelCaseTypes: NonCamelCaseTypes,
 120         NonSnakeCase: NonSnakeCase,
 121         NonUpperCaseGlobals: NonUpperCaseGlobals,
 122         NonShorthandFieldPatterns: NonShorthandFieldPatterns,
 123         UnsafeCode: UnsafeCode,
 124         UnusedAllocation: UnusedAllocation,
 125         MissingCopyImplementations: MissingCopyImplementations,
 126         UnstableFeatures: UnstableFeatures,
 127         UnconditionalRecursion: UnconditionalRecursion,
 128         InvalidNoMangleItems: InvalidNoMangleItems,
 129         PluginAsLibrary: PluginAsLibrary,
 130         MutableTransmutes: MutableTransmutes,
 131         UnionsWithDropFields: UnionsWithDropFields,
 132         UnreachablePub: UnreachablePub,
 133         TypeAliasBounds: TypeAliasBounds,
 134         UnusedBrokenConst: UnusedBrokenConst,
 135         TrivialConstraints: TrivialConstraints,
 136         TypeLimits: TypeLimits::new(),
 137         MissingDoc: MissingDoc::new(),
 138         MissingDebugImplementations: MissingDebugImplementations::new(),
 139     ]], ['tcx]);
 140
 141     store.register_late_pass(sess, false, box BuiltinCombinedLateLintPass::new());
 142
 143     add_lint_group!(sess,
 144                     "bad_style",
 145                     NON_CAMEL_CASE_TYPES,
 146                     NON_SNAKE_CASE,
 147                     NON_UPPER_CASE_GLOBALS);
 148
 149     add_lint_group!(sess,
 150                     "nonstandard_style",
 151                     NON_CAMEL_CASE_TYPES,
 152                     NON_SNAKE_CASE,
 153                     NON_UPPER_CASE_GLOBALS);
 154
 155     add_lint_group!(sess,
 156                     "unused",
 157                     UNUSED_IMPORTS,
 158                     UNUSED_VARIABLES,
 159                     UNUSED_ASSIGNMENTS,
 160                     DEAD_CODE,
 161                     UNUSED_MUT,
 162                     UNREACHABLE_CODE,
 163                     UNREACHABLE_PATTERNS,
 164                     UNUSED_MUST_USE,
 165                     UNUSED_UNSAFE,
 166                     PATH_STATEMENTS,
 167                     UNUSED_ATTRIBUTES,
 168                     UNUSED_MACROS,
 169                     UNUSED_ALLOCATION,
 170                     UNUSED_DOC_COMMENTS,
 171                     UNUSED_EXTERN_CRATES,
 172                     UNUSED_FEATURES,
 173                     UNUSED_LABELS,
 174                     UNUSED_PARENS);
 175
 176     add_lint_group!(sess,
 177                     "rust_2018_idioms",
 178                     BARE_TRAIT_OBJECTS,
 179                     UNREACHABLE_PUB,
 180                     UNUSED_EXTERN_CRATES,
 181                     ELLIPSIS_INCLUSIVE_RANGE_PATTERNS);
 182
 183     // Guidelines for creating a future incompatibility lint:
 184     //
 185     // - Create a lint defaulting to warn as normal, with ideally the same error
 186     //   message you would normally give
 187     // - Add a suitable reference, typically an RFC or tracking issue. Go ahead
 188     //   and include the full URL, sort items in ascending order of issue numbers.
 189     // - Later, change lint to error
 190     // - Eventually, remove lint
 191     store.register_future_incompatible(sess,
 192                                        vec![
 193         FutureIncompatibleInfo {
 194             id: LintId::of(PRIVATE_IN_PUBLIC),
 195             reference: "issue #34537 <https://github.com/rust-lang/rust/issues/34537>",
 196             edition: None,
 197         },
 198         FutureIncompatibleInfo {
 199             id: LintId::of(PUB_USE_OF_PRIVATE_EXTERN_CRATE),
 200             reference: "issue #34537 <https://github.com/rust-lang/rust/issues/34537>",
 201             edition: None,
 202         },
 203         FutureIncompatibleInfo {
 204             id: LintId::of(PATTERNS_IN_FNS_WITHOUT_BODY),
 205             reference: "issue #35203 <https://github.com/rust-lang/rust/issues/35203>",
 206             edition: None,
 207         },
 208         FutureIncompatibleInfo {
 209             id: LintId::of(DUPLICATE_MACRO_EXPORTS),
 210             reference: "issue #35896 <https://github.com/rust-lang/rust/issues/35896>",
 211             edition: Some(Edition::Edition2018),
 212         },
 213         FutureIncompatibleInfo {
 214             id: LintId::of(SAFE_EXTERN_STATICS),
 215             reference: "issue #36247 <https://github.com/rust-lang/rust/issues/36247>",
 216             edition: None,
 217         },
 218         FutureIncompatibleInfo {
 219             id: LintId::of(INVALID_TYPE_PARAM_DEFAULT),
 220             reference: "issue #36887 <https://github.com/rust-lang/rust/issues/36887>",
 221             edition: None,
 222         },
 223         FutureIncompatibleInfo {
 224             id: LintId::of(LEGACY_DIRECTORY_OWNERSHIP),
 225             reference: "issue #37872 <https://github.com/rust-lang/rust/issues/37872>",
 226             edition: None,
 227         },
 228         FutureIncompatibleInfo {
 229             id: LintId::of(LEGACY_CONSTRUCTOR_VISIBILITY),
 230             reference: "issue #39207 <https://github.com/rust-lang/rust/issues/39207>",
 231             edition: None,
 232         },
 233         FutureIncompatibleInfo {
 234             id: LintId::of(MISSING_FRAGMENT_SPECIFIER),
 235             reference: "issue #40107 <https://github.com/rust-lang/rust/issues/40107>",
 236             edition: None,
 237         },
 238         FutureIncompatibleInfo {
 239             id: LintId::of(ILLEGAL_FLOATING_POINT_LITERAL_PATTERN),
 240             reference: "issue #41620 <https://github.com/rust-lang/rust/issues/41620>",
 241             edition: None,
 242         },
 243         FutureIncompatibleInfo {
 244             id: LintId::of(ANONYMOUS_PARAMETERS),
 245             reference: "issue #41686 <https://github.com/rust-lang/rust/issues/41686>",
 246             edition: None,
 247         },
 248         FutureIncompatibleInfo {
 249             id: LintId::of(PARENTHESIZED_PARAMS_IN_TYPES_AND_MODULES),
 250             reference: "issue #42238 <https://github.com/rust-lang/rust/issues/42238>",
 251             edition: None,
 252         },
 253         FutureIncompatibleInfo {
 254             id: LintId::of(LATE_BOUND_LIFETIME_ARGUMENTS),
 255             reference: "issue #42868 <https://github.com/rust-lang/rust/issues/42868>",
 256             edition: None,
 257         },
 258         FutureIncompatibleInfo {
 259             id: LintId::of(SAFE_PACKED_BORROWS),
 260             reference: "issue #46043 <https://github.com/rust-lang/rust/issues/46043>",
 261             edition: None,
 262         },
 263         FutureIncompatibleInfo {
 264             id: LintId::of(INCOHERENT_FUNDAMENTAL_IMPLS),
 265             reference: "issue #46205 <https://github.com/rust-lang/rust/issues/46205>",
 266             edition: None,
 267         },
 268         FutureIncompatibleInfo {
 269             id: LintId::of(TYVAR_BEHIND_RAW_POINTER),
 270             reference: "issue #46906 <https://github.com/rust-lang/rust/issues/46906>",
 271             edition: Some(Edition::Edition2018),
 272         },
 273         FutureIncompatibleInfo {
 274             id: LintId::of(UNSTABLE_NAME_COLLISIONS),
 275             reference: "issue #48919 <https://github.com/rust-lang/rust/issues/48919>",
 276             edition: None,
 277             // Note: this item represents future incompatibility of all unstable functions in the
 278             //       standard library, and thus should never be removed or changed to an error.
 279         },
 280         FutureIncompatibleInfo {
 281             id: LintId::of(ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE),
 282             reference: "issue TBD",
 283             edition: Some(Edition::Edition2018),
 284         },
 285         FutureIncompatibleInfo {
 286             id: LintId::of(WHERE_CLAUSES_OBJECT_SAFETY),
 287             reference: "issue #51443 <https://github.com/rust-lang/rust/issues/51443>",
 288             edition: None,
 289         },
 290         FutureIncompatibleInfo {
 291             id: LintId::of(DUPLICATE_ASSOCIATED_TYPE_BINDINGS),
 292             reference: "issue #50589 <https://github.com/rust-lang/rust/issues/50589>",
 293             edition: None,
 294         },
 295         ]);
 296
 297     // Register renamed and removed lints
 298     store.register_renamed("single_use_lifetime", "single_use_lifetimes");
 299     store.register_renamed("elided_lifetime_in_path", "elided_lifetimes_in_paths");
 300     store.register_renamed("bare_trait_object", "bare_trait_objects");
 301     store.register_renamed("unstable_name_collision", "unstable_name_collisions");
 302     store.register_renamed("unused_doc_comment", "unused_doc_comments");
 303     store.register_renamed("unknown_features", "unused_features");
 304     store.register_removed("unsigned_negation", "replaced by negate_unsigned feature gate");
 305     store.register_removed("negate_unsigned", "cast a signed value instead");
 306     store.register_removed("raw_pointer_derive", "using derive with raw pointers is ok");
 307     // This was renamed to raw_pointer_derive, which was then removed,
 308     // so it is also considered removed
 309     store.register_removed("raw_pointer_deriving", "using derive with raw pointers is ok");
 310     store.register_removed("drop_with_repr_extern", "drop flags have been removed");
 311     store.register_removed("fat_ptr_transmutes", "was accidentally removed back in 2014");
 312     store.register_removed("deprecated_attr", "use `deprecated` instead");
 313     store.register_removed("transmute_from_fn_item_types",
 314         "always cast functions before transmuting them");
 315     store.register_removed("hr_lifetime_in_assoc_type",
 316         "converted into hard error, see https://github.com/rust-lang/rust/issues/33685");
 317     store.register_removed("inaccessible_extern_crate",
 318         "converted into hard error, see https://github.com/rust-lang/rust/issues/36886");
 319     store.register_removed("super_or_self_in_global_path",
 320         "converted into hard error, see https://github.com/rust-lang/rust/issues/36888");
 321     store.register_removed("overlapping_inherent_impls",
 322         "converted into hard error, see https://github.com/rust-lang/rust/issues/36889");
 323     store.register_removed("illegal_floating_point_constant_pattern",
 324         "converted into hard error, see https://github.com/rust-lang/rust/issues/36890");
 325     store.register_removed("illegal_struct_or_enum_constant_pattern",
 326         "converted into hard error, see https://github.com/rust-lang/rust/issues/36891");
 327     store.register_removed("lifetime_underscore",
 328         "converted into hard error, see https://github.com/rust-lang/rust/issues/36892");
 329     store.register_removed("extra_requirement_in_impl",
 330         "converted into hard error, see https://github.com/rust-lang/rust/issues/37166");
 331     store.register_removed("legacy_imports",
 332         "converted into hard error, see https://github.com/rust-lang/rust/issues/38260");
 333     store.register_removed("coerce_never",
 334         "converted into hard error, see https://github.com/rust-lang/rust/issues/48950");
 335     store.register_removed("resolve_trait_on_defaulted_unit",
 336         "converted into hard error, see https://github.com/rust-lang/rust/issues/48950");
 337 }