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 #![cfg_attr(not(stage0), feature(nll))]
  31 #![feature(quote)]
  32 #![feature(rustc_diagnostic_macros)]
  33 #![feature(macro_at_most_once_rep)]
  34
  35 extern crate syntax;
  36 #[macro_use]
  37 extern crate rustc;
  38 #[macro_use]
  39 extern crate log;
  40 extern crate rustc_mir;
  41 extern crate rustc_target;
  42 extern crate syntax_pos;
  43
  44 use rustc::lint;
  45 use rustc::lint::{LateContext, LateLintPass, LintPass, LintArray};
  46 use rustc::lint::builtin::{
  47     BARE_TRAIT_OBJECTS,
  48     ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE,
  49     ELIDED_LIFETIMES_IN_PATHS,
  50     parser::QUESTION_MARK_MACRO_SEP
  51 };
  52 use rustc::session;
  53 use rustc::util;
  54 use rustc::hir;
  55
  56 use syntax::ast;
  57 use syntax_pos::Span;
  58
  59 use session::Session;
  60 use syntax::edition::Edition;
  61 use lint::LintId;
  62 use lint::FutureIncompatibleInfo;
  63
  64 mod bad_style;
  65 pub mod builtin;
  66 mod types;
  67 mod unused;
  68
  69 use bad_style::*;
  70 use builtin::*;
  71 use types::*;
  72 use unused::*;
  73
  74 /// Useful for other parts of the compiler.
  75 pub use builtin::SoftLints;
  76
  77 /// Tell the `LintStore` about all the built-in lints (the ones
  78 /// defined in this crate and the ones defined in
  79 /// `rustc::lint::builtin`).
  80 pub fn register_builtins(store: &mut lint::LintStore, sess: Option<&Session>) {
  81     macro_rules! add_early_builtin {
  82         ($sess:ident, $($name:ident),*,) => (
  83             {$(
  84                 store.register_early_pass($sess, false, box $name);
  85                 )*}
  86             )
  87     }
  88
  89     macro_rules! add_pre_expansion_builtin {
  90         ($sess:ident, $($name:ident),*,) => (
  91             {$(
  92                 store.register_early_pass($sess, false, box $name);
  93                 )*}
  94             )
  95     }
  96
  97     macro_rules! add_early_builtin_with_new {
  98         ($sess:ident, $($name:ident),*,) => (
  99             {$(
 100                 store.register_early_pass($sess, false, box $name::new());
 101                 )*}
 102             )
 103     }
 104
 105     macro_rules! add_lint_group {
 106         ($sess:ident, $name:expr, $($lint:ident),*) => (
 107             store.register_group($sess, false, $name, vec![$(LintId::of($lint)),*]);
 108             )
 109     }
 110
 111     add_pre_expansion_builtin!(sess,
 112         Async2018,
 113     );
 114
 115     add_early_builtin!(sess,
 116                        UnusedParens,
 117                        UnusedImportBraces,
 118                        AnonymousParameters,
 119                        UnusedDocComment,
 120                        BadRepr,
 121                        EllipsisInclusiveRangePatterns,
 122                        );
 123
 124     add_early_builtin_with_new!(sess,
 125                                 DeprecatedAttr,
 126                                 );
 127
 128     late_lint_methods!(declare_combined_late_lint_pass, [BuiltinCombinedLateLintPass, [
 129         HardwiredLints: HardwiredLints,
 130         WhileTrue: WhileTrue,
 131         ImproperCTypes: ImproperCTypes,
 132         VariantSizeDifferences: VariantSizeDifferences,
 133         BoxPointers: BoxPointers,
 134         UnusedAttributes: UnusedAttributes,
 135         PathStatements: PathStatements,
 136         UnusedResults: UnusedResults,
 137         NonCamelCaseTypes: NonCamelCaseTypes,
 138         NonSnakeCase: NonSnakeCase,
 139         NonUpperCaseGlobals: NonUpperCaseGlobals,
 140         NonShorthandFieldPatterns: NonShorthandFieldPatterns,
 141         UnsafeCode: UnsafeCode,
 142         UnusedAllocation: UnusedAllocation,
 143         MissingCopyImplementations: MissingCopyImplementations,
 144         UnstableFeatures: UnstableFeatures,
 145         UnconditionalRecursion: UnconditionalRecursion,
 146         InvalidNoMangleItems: InvalidNoMangleItems,
 147         PluginAsLibrary: PluginAsLibrary,
 148         MutableTransmutes: MutableTransmutes,
 149         UnionsWithDropFields: UnionsWithDropFields,
 150         UnreachablePub: UnreachablePub,
 151         UnnameableTestFunctions: UnnameableTestFunctions,
 152         TypeAliasBounds: TypeAliasBounds,
 153         UnusedBrokenConst: UnusedBrokenConst,
 154         TrivialConstraints: TrivialConstraints,
 155         TypeLimits: TypeLimits::new(),
 156         MissingDoc: MissingDoc::new(),
 157         MissingDebugImplementations: MissingDebugImplementations::new(),
 158     ]], ['tcx]);
 159
 160     store.register_late_pass(sess, false, box BuiltinCombinedLateLintPass::new());
 161
 162     add_lint_group!(sess,
 163                     "bad_style",
 164                     NON_CAMEL_CASE_TYPES,
 165                     NON_SNAKE_CASE,
 166                     NON_UPPER_CASE_GLOBALS);
 167
 168     add_lint_group!(sess,
 169                     "nonstandard_style",
 170                     NON_CAMEL_CASE_TYPES,
 171                     NON_SNAKE_CASE,
 172                     NON_UPPER_CASE_GLOBALS);
 173
 174     add_lint_group!(sess,
 175                     "unused",
 176                     UNUSED_IMPORTS,
 177                     UNUSED_VARIABLES,
 178                     UNUSED_ASSIGNMENTS,
 179                     DEAD_CODE,
 180                     UNUSED_MUT,
 181                     UNREACHABLE_CODE,
 182                     UNREACHABLE_PATTERNS,
 183                     UNUSED_MUST_USE,
 184                     UNUSED_UNSAFE,
 185                     PATH_STATEMENTS,
 186                     UNUSED_ATTRIBUTES,
 187                     UNUSED_MACROS,
 188                     UNUSED_ALLOCATION,
 189                     UNUSED_DOC_COMMENTS,
 190                     UNUSED_EXTERN_CRATES,
 191                     UNUSED_FEATURES,
 192                     UNUSED_LABELS,
 193                     UNUSED_PARENS);
 194
 195     add_lint_group!(sess,
 196                     "rust_2018_idioms",
 197                     BARE_TRAIT_OBJECTS,
 198                     UNUSED_EXTERN_CRATES,
 199                     ELLIPSIS_INCLUSIVE_RANGE_PATTERNS,
 200                     ELIDED_LIFETIMES_IN_PATHS
 201
 202                     // FIXME(#52665, #47816) not always applicable and not all
 203                     // macros are ready for this yet.
 204                     // UNREACHABLE_PUB,
 205
 206                     // FIXME macro crates are not up for this yet, too much
 207                     // breakage is seen if we try to encourage this lint.
 208                     // MACRO_USE_EXTERN_CRATE,
 209                     );
 210
 211     // Guidelines for creating a future incompatibility lint:
 212     //
 213     // - Create a lint defaulting to warn as normal, with ideally the same error
 214     //   message you would normally give
 215     // - Add a suitable reference, typically an RFC or tracking issue. Go ahead
 216     //   and include the full URL, sort items in ascending order of issue numbers.
 217     // - Later, change lint to error
 218     // - Eventually, remove lint
 219     store.register_future_incompatible(sess,
 220                                        vec![
 221         FutureIncompatibleInfo {
 222             id: LintId::of(PRIVATE_IN_PUBLIC),
 223             reference: "issue #34537 <https://github.com/rust-lang/rust/issues/34537>",
 224             edition: None,
 225         },
 226         FutureIncompatibleInfo {
 227             id: LintId::of(PUB_USE_OF_PRIVATE_EXTERN_CRATE),
 228             reference: "issue #34537 <https://github.com/rust-lang/rust/issues/34537>",
 229             edition: None,
 230         },
 231         FutureIncompatibleInfo {
 232             id: LintId::of(PATTERNS_IN_FNS_WITHOUT_BODY),
 233             reference: "issue #35203 <https://github.com/rust-lang/rust/issues/35203>",
 234             edition: None,
 235         },
 236         FutureIncompatibleInfo {
 237             id: LintId::of(DUPLICATE_MACRO_EXPORTS),
 238             reference: "issue #35896 <https://github.com/rust-lang/rust/issues/35896>",
 239             edition: Some(Edition::Edition2018),
 240         },
 241         FutureIncompatibleInfo {
 242             id: LintId::of(ASYNC_IDENTS),
 243             reference: "issue #49716 <https://github.com/rust-lang/rust/issues/49716>",
 244             edition: Some(Edition::Edition2018),
 245         },
 246         FutureIncompatibleInfo {
 247             id: LintId::of(SAFE_EXTERN_STATICS),
 248             reference: "issue #36247 <https://github.com/rust-lang/rust/issues/36247>",
 249             edition: None,
 250         },
 251         FutureIncompatibleInfo {
 252             id: LintId::of(INVALID_TYPE_PARAM_DEFAULT),
 253             reference: "issue #36887 <https://github.com/rust-lang/rust/issues/36887>",
 254             edition: None,
 255         },
 256         FutureIncompatibleInfo {
 257             id: LintId::of(LEGACY_DIRECTORY_OWNERSHIP),
 258             reference: "issue #37872 <https://github.com/rust-lang/rust/issues/37872>",
 259             edition: None,
 260         },
 261         FutureIncompatibleInfo {
 262             id: LintId::of(LEGACY_CONSTRUCTOR_VISIBILITY),
 263             reference: "issue #39207 <https://github.com/rust-lang/rust/issues/39207>",
 264             edition: None,
 265         },
 266         FutureIncompatibleInfo {
 267             id: LintId::of(MISSING_FRAGMENT_SPECIFIER),
 268             reference: "issue #40107 <https://github.com/rust-lang/rust/issues/40107>",
 269             edition: None,
 270         },
 271         FutureIncompatibleInfo {
 272             id: LintId::of(ILLEGAL_FLOATING_POINT_LITERAL_PATTERN),
 273             reference: "issue #41620 <https://github.com/rust-lang/rust/issues/41620>",
 274             edition: None,
 275         },
 276         FutureIncompatibleInfo {
 277             id: LintId::of(ANONYMOUS_PARAMETERS),
 278             reference: "issue #41686 <https://github.com/rust-lang/rust/issues/41686>",
 279             edition: None,
 280         },
 281         FutureIncompatibleInfo {
 282             id: LintId::of(PARENTHESIZED_PARAMS_IN_TYPES_AND_MODULES),
 283             reference: "issue #42238 <https://github.com/rust-lang/rust/issues/42238>",
 284             edition: None,
 285         },
 286         FutureIncompatibleInfo {
 287             id: LintId::of(LATE_BOUND_LIFETIME_ARGUMENTS),
 288             reference: "issue #42868 <https://github.com/rust-lang/rust/issues/42868>",
 289             edition: None,
 290         },
 291         FutureIncompatibleInfo {
 292             id: LintId::of(SAFE_PACKED_BORROWS),
 293             reference: "issue #46043 <https://github.com/rust-lang/rust/issues/46043>",
 294             edition: None,
 295         },
 296         FutureIncompatibleInfo {
 297             id: LintId::of(INCOHERENT_FUNDAMENTAL_IMPLS),
 298             reference: "issue #46205 <https://github.com/rust-lang/rust/issues/46205>",
 299             edition: None,
 300         },
 301         FutureIncompatibleInfo {
 302             id: LintId::of(TYVAR_BEHIND_RAW_POINTER),
 303             reference: "issue #46906 <https://github.com/rust-lang/rust/issues/46906>",
 304             edition: Some(Edition::Edition2018),
 305         },
 306         FutureIncompatibleInfo {
 307             id: LintId::of(UNSTABLE_NAME_COLLISIONS),
 308             reference: "issue #48919 <https://github.com/rust-lang/rust/issues/48919>",
 309             edition: None,
 310             // Note: this item represents future incompatibility of all unstable functions in the
 311             //       standard library, and thus should never be removed or changed to an error.
 312         },
 313         FutureIncompatibleInfo {
 314             id: LintId::of(ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE),
 315             reference: "issue TBD",
 316             edition: Some(Edition::Edition2018),
 317         },
 318         FutureIncompatibleInfo {
 319             id: LintId::of(WHERE_CLAUSES_OBJECT_SAFETY),
 320             reference: "issue #51443 <https://github.com/rust-lang/rust/issues/51443>",
 321             edition: None,
 322         },
 323         FutureIncompatibleInfo {
 324             id: LintId::of(DUPLICATE_ASSOCIATED_TYPE_BINDINGS),
 325             reference: "issue #50589 <https://github.com/rust-lang/rust/issues/50589>",
 326             edition: None,
 327         },
 328         FutureIncompatibleInfo {
 329             id: LintId::of(PROC_MACRO_DERIVE_RESOLUTION_FALLBACK),
 330             reference: "issue #50504 <https://github.com/rust-lang/rust/issues/50504>",
 331             edition: None,
 332         },
 333         FutureIncompatibleInfo {
 334             id: LintId::of(QUESTION_MARK_MACRO_SEP),
 335             reference: "issue #48075 <https://github.com/rust-lang/rust/issues/48075>",
 336             edition: Some(Edition::Edition2018),
 337         }
 338         ]);
 339
 340     // Register renamed and removed lints
 341     store.register_renamed("single_use_lifetime", "single_use_lifetimes");
 342     store.register_renamed("elided_lifetime_in_path", "elided_lifetimes_in_paths");
 343     store.register_renamed("bare_trait_object", "bare_trait_objects");
 344     store.register_renamed("unstable_name_collision", "unstable_name_collisions");
 345     store.register_renamed("unused_doc_comment", "unused_doc_comments");
 346     store.register_removed("unknown_features", "replaced by an error");
 347     store.register_removed("unsigned_negation", "replaced by negate_unsigned feature gate");
 348     store.register_removed("negate_unsigned", "cast a signed value instead");
 349     store.register_removed("raw_pointer_derive", "using derive with raw pointers is ok");
 350     // This was renamed to raw_pointer_derive, which was then removed,
 351     // so it is also considered removed
 352     store.register_removed("raw_pointer_deriving", "using derive with raw pointers is ok");
 353     store.register_removed("drop_with_repr_extern", "drop flags have been removed");
 354     store.register_removed("fat_ptr_transmutes", "was accidentally removed back in 2014");
 355     store.register_removed("deprecated_attr", "use `deprecated` instead");
 356     store.register_removed("transmute_from_fn_item_types",
 357         "always cast functions before transmuting them");
 358     store.register_removed("hr_lifetime_in_assoc_type",
 359         "converted into hard error, see https://github.com/rust-lang/rust/issues/33685");
 360     store.register_removed("inaccessible_extern_crate",
 361         "converted into hard error, see https://github.com/rust-lang/rust/issues/36886");
 362     store.register_removed("super_or_self_in_global_path",
 363         "converted into hard error, see https://github.com/rust-lang/rust/issues/36888");
 364     store.register_removed("overlapping_inherent_impls",
 365         "converted into hard error, see https://github.com/rust-lang/rust/issues/36889");
 366     store.register_removed("illegal_floating_point_constant_pattern",
 367         "converted into hard error, see https://github.com/rust-lang/rust/issues/36890");
 368     store.register_removed("illegal_struct_or_enum_constant_pattern",
 369         "converted into hard error, see https://github.com/rust-lang/rust/issues/36891");
 370     store.register_removed("lifetime_underscore",
 371         "converted into hard error, see https://github.com/rust-lang/rust/issues/36892");
 372     store.register_removed("extra_requirement_in_impl",
 373         "converted into hard error, see https://github.com/rust-lang/rust/issues/37166");
 374     store.register_removed("legacy_imports",
 375         "converted into hard error, see https://github.com/rust-lang/rust/issues/38260");
 376     store.register_removed("coerce_never",
 377         "converted into hard error, see https://github.com/rust-lang/rust/issues/48950");
 378     store.register_removed("resolve_trait_on_defaulted_unit",
 379         "converted into hard error, see https://github.com/rust-lang/rust/issues/48950");
 380 }