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 pub 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_pre_expansion_builtin {
  84         ($sess:ident, $($name:ident),*,) => (
  85             {$(
  86                 store.register_early_pass($sess, false, box $name);
  87                 )*}
  88             )
  89     }
  90
  91     macro_rules! add_early_builtin_with_new {
  92         ($sess:ident, $($name:ident),*,) => (
  93             {$(
  94                 store.register_early_pass($sess, false, box $name::new());
  95                 )*}
  96             )
  97     }
  98
  99     macro_rules! add_lint_group {
 100         ($sess:ident, $name:expr, $($lint:ident),*) => (
 101             store.register_group($sess, false, $name, vec![$(LintId::of($lint)),*]);
 102             )
 103     }
 104
 105     add_pre_expansion_builtin!(sess,
 106         Async2018,
 107     );
 108
 109     add_early_builtin!(sess,
 110                        UnusedParens,
 111                        UnusedImportBraces,
 112                        AnonymousParameters,
 113                        UnusedDocComment,
 114                        BadRepr,
 115                        EllipsisInclusiveRangePatterns,
 116                        );
 117
 118     add_early_builtin_with_new!(sess,
 119                                 DeprecatedAttr,
 120                                 );
 121
 122     late_lint_methods!(declare_combined_late_lint_pass, [BuiltinCombinedLateLintPass, [
 123         HardwiredLints: HardwiredLints,
 124         WhileTrue: WhileTrue,
 125         ImproperCTypes: ImproperCTypes,
 126         VariantSizeDifferences: VariantSizeDifferences,
 127         BoxPointers: BoxPointers,
 128         UnusedAttributes: UnusedAttributes,
 129         PathStatements: PathStatements,
 130         UnusedResults: UnusedResults,
 131         NonCamelCaseTypes: NonCamelCaseTypes,
 132         NonSnakeCase: NonSnakeCase,
 133         NonUpperCaseGlobals: NonUpperCaseGlobals,
 134         NonShorthandFieldPatterns: NonShorthandFieldPatterns,
 135         UnsafeCode: UnsafeCode,
 136         UnusedAllocation: UnusedAllocation,
 137         MissingCopyImplementations: MissingCopyImplementations,
 138         UnstableFeatures: UnstableFeatures,
 139         UnconditionalRecursion: UnconditionalRecursion,
 140         InvalidNoMangleItems: InvalidNoMangleItems,
 141         PluginAsLibrary: PluginAsLibrary,
 142         MutableTransmutes: MutableTransmutes,
 143         UnionsWithDropFields: UnionsWithDropFields,
 144         UnreachablePub: UnreachablePub,
 145         UnnameableTestFunctions: UnnameableTestFunctions,
 146         TypeAliasBounds: TypeAliasBounds,
 147         UnusedBrokenConst: UnusedBrokenConst,
 148         TrivialConstraints: TrivialConstraints,
 149         TypeLimits: TypeLimits::new(),
 150         MissingDoc: MissingDoc::new(),
 151         MissingDebugImplementations: MissingDebugImplementations::new(),
 152     ]], ['tcx]);
 153
 154     store.register_late_pass(sess, false, box BuiltinCombinedLateLintPass::new());
 155
 156     add_lint_group!(sess,
 157                     "bad_style",
 158                     NON_CAMEL_CASE_TYPES,
 159                     NON_SNAKE_CASE,
 160                     NON_UPPER_CASE_GLOBALS);
 161
 162     add_lint_group!(sess,
 163                     "nonstandard_style",
 164                     NON_CAMEL_CASE_TYPES,
 165                     NON_SNAKE_CASE,
 166                     NON_UPPER_CASE_GLOBALS);
 167
 168     add_lint_group!(sess,
 169                     "unused",
 170                     UNUSED_IMPORTS,
 171                     UNUSED_VARIABLES,
 172                     UNUSED_ASSIGNMENTS,
 173                     DEAD_CODE,
 174                     UNUSED_MUT,
 175                     UNREACHABLE_CODE,
 176                     UNREACHABLE_PATTERNS,
 177                     UNUSED_MUST_USE,
 178                     UNUSED_UNSAFE,
 179                     PATH_STATEMENTS,
 180                     UNUSED_ATTRIBUTES,
 181                     UNUSED_MACROS,
 182                     UNUSED_ALLOCATION,
 183                     UNUSED_DOC_COMMENTS,
 184                     UNUSED_EXTERN_CRATES,
 185                     UNUSED_FEATURES,
 186                     UNUSED_LABELS,
 187                     UNUSED_PARENS);
 188
 189     add_lint_group!(sess,
 190                     "rust_2018_idioms",
 191                     BARE_TRAIT_OBJECTS,
 192                     ASYNC_IDENTS,
 193                     UNREACHABLE_PUB,
 194                     UNUSED_EXTERN_CRATES,
 195                     ELLIPSIS_INCLUSIVE_RANGE_PATTERNS);
 196
 197     // Guidelines for creating a future incompatibility lint:
 198     //
 199     // - Create a lint defaulting to warn as normal, with ideally the same error
 200     //   message you would normally give
 201     // - Add a suitable reference, typically an RFC or tracking issue. Go ahead
 202     //   and include the full URL, sort items in ascending order of issue numbers.
 203     // - Later, change lint to error
 204     // - Eventually, remove lint
 205     store.register_future_incompatible(sess,
 206                                        vec![
 207         FutureIncompatibleInfo {
 208             id: LintId::of(PRIVATE_IN_PUBLIC),
 209             reference: "issue #34537 <https://github.com/rust-lang/rust/issues/34537>",
 210             edition: None,
 211         },
 212         FutureIncompatibleInfo {
 213             id: LintId::of(PUB_USE_OF_PRIVATE_EXTERN_CRATE),
 214             reference: "issue #34537 <https://github.com/rust-lang/rust/issues/34537>",
 215             edition: None,
 216         },
 217         FutureIncompatibleInfo {
 218             id: LintId::of(PATTERNS_IN_FNS_WITHOUT_BODY),
 219             reference: "issue #35203 <https://github.com/rust-lang/rust/issues/35203>",
 220             edition: None,
 221         },
 222         FutureIncompatibleInfo {
 223             id: LintId::of(DUPLICATE_MACRO_EXPORTS),
 224             reference: "issue #35896 <https://github.com/rust-lang/rust/issues/35896>",
 225             edition: Some(Edition::Edition2018),
 226         },
 227         FutureIncompatibleInfo {
 228             id: LintId::of(SAFE_EXTERN_STATICS),
 229             reference: "issue #36247 <https://github.com/rust-lang/rust/issues/36247>",
 230             edition: None,
 231         },
 232         FutureIncompatibleInfo {
 233             id: LintId::of(INVALID_TYPE_PARAM_DEFAULT),
 234             reference: "issue #36887 <https://github.com/rust-lang/rust/issues/36887>",
 235             edition: None,
 236         },
 237         FutureIncompatibleInfo {
 238             id: LintId::of(LEGACY_DIRECTORY_OWNERSHIP),
 239             reference: "issue #37872 <https://github.com/rust-lang/rust/issues/37872>",
 240             edition: None,
 241         },
 242         FutureIncompatibleInfo {
 243             id: LintId::of(LEGACY_CONSTRUCTOR_VISIBILITY),
 244             reference: "issue #39207 <https://github.com/rust-lang/rust/issues/39207>",
 245             edition: None,
 246         },
 247         FutureIncompatibleInfo {
 248             id: LintId::of(MISSING_FRAGMENT_SPECIFIER),
 249             reference: "issue #40107 <https://github.com/rust-lang/rust/issues/40107>",
 250             edition: None,
 251         },
 252         FutureIncompatibleInfo {
 253             id: LintId::of(ILLEGAL_FLOATING_POINT_LITERAL_PATTERN),
 254             reference: "issue #41620 <https://github.com/rust-lang/rust/issues/41620>",
 255             edition: None,
 256         },
 257         FutureIncompatibleInfo {
 258             id: LintId::of(ANONYMOUS_PARAMETERS),
 259             reference: "issue #41686 <https://github.com/rust-lang/rust/issues/41686>",
 260             edition: None,
 261         },
 262         FutureIncompatibleInfo {
 263             id: LintId::of(PARENTHESIZED_PARAMS_IN_TYPES_AND_MODULES),
 264             reference: "issue #42238 <https://github.com/rust-lang/rust/issues/42238>",
 265             edition: None,
 266         },
 267         FutureIncompatibleInfo {
 268             id: LintId::of(LATE_BOUND_LIFETIME_ARGUMENTS),
 269             reference: "issue #42868 <https://github.com/rust-lang/rust/issues/42868>",
 270             edition: None,
 271         },
 272         FutureIncompatibleInfo {
 273             id: LintId::of(SAFE_PACKED_BORROWS),
 274             reference: "issue #46043 <https://github.com/rust-lang/rust/issues/46043>",
 275             edition: None,
 276         },
 277         FutureIncompatibleInfo {
 278             id: LintId::of(INCOHERENT_FUNDAMENTAL_IMPLS),
 279             reference: "issue #46205 <https://github.com/rust-lang/rust/issues/46205>",
 280             edition: None,
 281         },
 282         FutureIncompatibleInfo {
 283             id: LintId::of(TYVAR_BEHIND_RAW_POINTER),
 284             reference: "issue #46906 <https://github.com/rust-lang/rust/issues/46906>",
 285             edition: Some(Edition::Edition2018),
 286         },
 287         FutureIncompatibleInfo {
 288             id: LintId::of(UNSTABLE_NAME_COLLISIONS),
 289             reference: "issue #48919 <https://github.com/rust-lang/rust/issues/48919>",
 290             edition: None,
 291             // Note: this item represents future incompatibility of all unstable functions in the
 292             //       standard library, and thus should never be removed or changed to an error.
 293         },
 294         FutureIncompatibleInfo {
 295             id: LintId::of(ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE),
 296             reference: "issue TBD",
 297             edition: Some(Edition::Edition2018),
 298         },
 299         FutureIncompatibleInfo {
 300             id: LintId::of(WHERE_CLAUSES_OBJECT_SAFETY),
 301             reference: "issue #51443 <https://github.com/rust-lang/rust/issues/51443>",
 302             edition: None,
 303         },
 304         FutureIncompatibleInfo {
 305             id: LintId::of(DUPLICATE_ASSOCIATED_TYPE_BINDINGS),
 306             reference: "issue #50589 <https://github.com/rust-lang/rust/issues/50589>",
 307             edition: None,
 308         },
 309         FutureIncompatibleInfo {
 310             id: LintId::of(PROC_MACRO_DERIVE_RESOLUTION_FALLBACK),
 311             reference: "issue #50504 <https://github.com/rust-lang/rust/issues/50504>",
 312             edition: None,
 313         },
 314         ]);
 315
 316     // Register renamed and removed lints
 317     store.register_renamed("single_use_lifetime", "single_use_lifetimes");
 318     store.register_renamed("elided_lifetime_in_path", "elided_lifetimes_in_paths");
 319     store.register_renamed("bare_trait_object", "bare_trait_objects");
 320     store.register_renamed("unstable_name_collision", "unstable_name_collisions");
 321     store.register_renamed("unused_doc_comment", "unused_doc_comments");
 322     store.register_renamed("unknown_features", "unused_features");
 323     store.register_removed("unsigned_negation", "replaced by negate_unsigned feature gate");
 324     store.register_removed("negate_unsigned", "cast a signed value instead");
 325     store.register_removed("raw_pointer_derive", "using derive with raw pointers is ok");
 326     // This was renamed to raw_pointer_derive, which was then removed,
 327     // so it is also considered removed
 328     store.register_removed("raw_pointer_deriving", "using derive with raw pointers is ok");
 329     store.register_removed("drop_with_repr_extern", "drop flags have been removed");
 330     store.register_removed("fat_ptr_transmutes", "was accidentally removed back in 2014");
 331     store.register_removed("deprecated_attr", "use `deprecated` instead");
 332     store.register_removed("transmute_from_fn_item_types",
 333         "always cast functions before transmuting them");
 334     store.register_removed("hr_lifetime_in_assoc_type",
 335         "converted into hard error, see https://github.com/rust-lang/rust/issues/33685");
 336     store.register_removed("inaccessible_extern_crate",
 337         "converted into hard error, see https://github.com/rust-lang/rust/issues/36886");
 338     store.register_removed("super_or_self_in_global_path",
 339         "converted into hard error, see https://github.com/rust-lang/rust/issues/36888");
 340     store.register_removed("overlapping_inherent_impls",
 341         "converted into hard error, see https://github.com/rust-lang/rust/issues/36889");
 342     store.register_removed("illegal_floating_point_constant_pattern",
 343         "converted into hard error, see https://github.com/rust-lang/rust/issues/36890");
 344     store.register_removed("illegal_struct_or_enum_constant_pattern",
 345         "converted into hard error, see https://github.com/rust-lang/rust/issues/36891");
 346     store.register_removed("lifetime_underscore",
 347         "converted into hard error, see https://github.com/rust-lang/rust/issues/36892");
 348     store.register_removed("extra_requirement_in_impl",
 349         "converted into hard error, see https://github.com/rust-lang/rust/issues/37166");
 350     store.register_removed("legacy_imports",
 351         "converted into hard error, see https://github.com/rust-lang/rust/issues/38260");
 352     store.register_removed("coerce_never",
 353         "converted into hard error, see https://github.com/rust-lang/rust/issues/48950");
 354     store.register_removed("resolve_trait_on_defaulted_unit",
 355         "converted into hard error, see https://github.com/rust-lang/rust/issues/48950");
 356 }