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