src/librustc/lint/mod.rs

   1 //! Lints, aka compiler warnings.
   2 //!
   3 //! A 'lint' check is a kind of miscellaneous constraint that a user _might_
   4 //! want to enforce, but might reasonably want to permit as well, on a
   5 //! module-by-module basis. They contrast with static constraints enforced by
   6 //! other phases of the compiler, which are generally required to hold in order
   7 //! to compile the program at all.
   8 //!
   9 //! Most lints can be written as `LintPass` instances. These run after
  10 //! all other analyses. The `LintPass`es built into rustc are defined
  11 //! within `builtin.rs`, which has further comments on how to add such a lint.
  12 //! rustc can also load user-defined lint plugins via the plugin mechanism.
  13 //!
  14 //! Some of rustc's lints are defined elsewhere in the compiler and work by
  15 //! calling `add_lint()` on the overall `Session` object. This works when
  16 //! it happens before the main lint pass, which emits the lints stored by
  17 //! `add_lint()`. To emit lints after the main lint pass (from codegen, for
  18 //! example) requires more effort. See `emit_lint` and `GatherNodeLevels`
  19 //! in `context.rs`.
  20
  21 pub use self::Level::*;
  22 pub use self::LintSource::*;
  23
  24 use rustc_data_structures::sync;
  25
  26 use crate::hir::def_id::{CrateNum, LOCAL_CRATE};
  27 use crate::hir::intravisit;
  28 use crate::hir;
  29 use crate::lint::builtin::BuiltinLintDiagnostics;
  30 use crate::lint::builtin::parser::{ILL_FORMED_ATTRIBUTE_INPUT, META_VARIABLE_MISUSE};
  31 use crate::session::{Session, DiagnosticMessageId};
  32 use crate::ty::TyCtxt;
  33 use crate::ty::query::Providers;
  34 use crate::util::nodemap::NodeMap;
  35 use errors::{DiagnosticBuilder, DiagnosticId};
  36 use std::{hash, ptr};
  37 use syntax::ast;
  38 use syntax::source_map::{MultiSpan, ExpnKind, DesugaringKind};
  39 use syntax::early_buffered_lints::BufferedEarlyLintId;
  40 use syntax::edition::Edition;
  41 use syntax::ext::base::MacroKind;
  42 use syntax::symbol::{Symbol, sym};
  43 use syntax_pos::Span;
  44
  45 pub use crate::lint::context::{LateContext, EarlyContext, LintContext, LintStore,
  46                         check_crate, check_ast_crate, late_lint_mod, CheckLintNameResult,
  47                         FutureIncompatibleInfo, BufferedEarlyLint,};
  48
  49 /// Specification of a single lint.
  50 #[derive(Copy, Clone, Debug)]
  51 pub struct Lint {
  52     /// A string identifier for the lint.
  53     ///
  54     /// This identifies the lint in attributes and in command-line arguments.
  55     /// In those contexts it is always lowercase, but this field is compared
  56     /// in a way which is case-insensitive for ASCII characters. This allows
  57     /// `declare_lint!()` invocations to follow the convention of upper-case
  58     /// statics without repeating the name.
  59     ///
  60     /// The name is written with underscores, e.g., "unused_imports".
  61     /// On the command line, underscores become dashes.
  62     pub name: &'static str,
  63
  64     /// Default level for the lint.
  65     pub default_level: Level,
  66
  67     /// Description of the lint or the issue it detects.
  68     ///
  69     /// e.g., "imports that are never used"
  70     pub desc: &'static str,
  71
  72     /// Starting at the given edition, default to the given lint level. If this is `None`, then use
  73     /// `default_level`.
  74     pub edition_lint_opts: Option<(Edition, Level)>,
  75
  76     /// `true` if this lint is reported even inside expansions of external macros.
  77     pub report_in_external_macro: bool,
  78 }
  79
  80 impl Lint {
  81     /// Returns the `rust::lint::Lint` for a `syntax::early_buffered_lints::BufferedEarlyLintId`.
  82     pub fn from_parser_lint_id(lint_id: BufferedEarlyLintId) -> &'static Self {
  83         match lint_id {
  84             BufferedEarlyLintId::IllFormedAttributeInput => ILL_FORMED_ATTRIBUTE_INPUT,
  85             BufferedEarlyLintId::MetaVariableMisuse => META_VARIABLE_MISUSE,
  86         }
  87     }
  88
  89     /// Gets the lint's name, with ASCII letters converted to lowercase.
  90     pub fn name_lower(&self) -> String {
  91         self.name.to_ascii_lowercase()
  92     }
  93
  94     pub fn default_level(&self, session: &Session) -> Level {
  95         self.edition_lint_opts
  96             .filter(|(e, _)| *e <= session.edition())
  97             .map(|(_, l)| l)
  98             .unwrap_or(self.default_level)
  99     }
 100 }
 101
 102 /// Declares a static item of type `&'static Lint`.
 103 #[macro_export]
 104 macro_rules! declare_lint {
 105     ($vis: vis $NAME: ident, $Level: ident, $desc: expr) => (
 106         declare_lint!{$vis $NAME, $Level, $desc, false}
 107     );
 108     ($vis: vis $NAME: ident, $Level: ident, $desc: expr, report_in_external_macro: $rep: expr) => (
 109         declare_lint!{$vis $NAME, $Level, $desc, $rep}
 110     );
 111     ($vis: vis $NAME: ident, $Level: ident, $desc: expr, $external: expr) => (
 112         $vis static $NAME: &$crate::lint::Lint = &$crate::lint::Lint {
 113             name: stringify!($NAME),
 114             default_level: $crate::lint::$Level,
 115             desc: $desc,
 116             edition_lint_opts: None,
 117             report_in_external_macro: $external,
 118         };
 119     );
 120     ($vis: vis $NAME: ident, $Level: ident, $desc: expr,
 121      $lint_edition: expr => $edition_level: ident
 122     ) => (
 123         $vis static $NAME: &$crate::lint::Lint = &$crate::lint::Lint {
 124             name: stringify!($NAME),
 125             default_level: $crate::lint::$Level,
 126             desc: $desc,
 127             edition_lint_opts: Some(($lint_edition, $crate::lint::Level::$edition_level)),
 128             report_in_external_macro: false,
 129         };
 130     );
 131 }
 132
 133 #[macro_export]
 134 macro_rules! declare_tool_lint {
 135     (
 136         $(#[$attr:meta])* $vis:vis $tool:ident ::$NAME:ident, $Level: ident, $desc: expr
 137     ) => (
 138         declare_tool_lint!{$(#[$attr])* $vis $tool::$NAME, $Level, $desc, false}
 139     );
 140     (
 141         $(#[$attr:meta])* $vis:vis $tool:ident ::$NAME:ident, $Level:ident, $desc:expr,
 142         report_in_external_macro: $rep:expr
 143     ) => (
 144          declare_tool_lint!{$(#[$attr])* $vis $tool::$NAME, $Level, $desc, $rep}
 145     );
 146     (
 147         $(#[$attr:meta])* $vis:vis $tool:ident ::$NAME:ident, $Level:ident, $desc:expr,
 148         $external:expr
 149     ) => (
 150         $(#[$attr])*
 151         $vis static $NAME: &$crate::lint::Lint = &$crate::lint::Lint {
 152             name: &concat!(stringify!($tool), "::", stringify!($NAME)),
 153             default_level: $crate::lint::$Level,
 154             desc: $desc,
 155             edition_lint_opts: None,
 156             report_in_external_macro: $external,
 157         };
 158     );
 159 }
 160
 161 /// Declares a static `LintArray` and return it as an expression.
 162 #[macro_export]
 163 macro_rules! lint_array {
 164     ($( $lint:expr ),* ,) => { lint_array!( $($lint),* ) };
 165     ($( $lint:expr ),*) => {{
 166         vec![$($lint),*]
 167     }}
 168 }
 169
 170 pub type LintArray = Vec<&'static Lint>;
 171
 172 pub trait LintPass {
 173     fn name(&self) -> &'static str;
 174
 175     /// Gets descriptions of the lints this `LintPass` object can emit.
 176     ///
 177     /// N.B., there is no enforcement that the object only emits lints it registered.
 178     /// And some `rustc` internal `LintPass`es register lints to be emitted by other
 179     /// parts of the compiler. If you want enforced access restrictions for your
 180     /// `Lint`, make it a private `static` item in its own module.
 181     fn get_lints(&self) -> LintArray;
 182 }
 183
 184 /// Implements `LintPass for $name` with the given list of `Lint` statics.
 185 #[macro_export]
 186 macro_rules! impl_lint_pass {
 187     ($name:ident => [$($lint:expr),* $(,)?]) => {
 188         impl LintPass for $name {
 189             fn name(&self) -> &'static str { stringify!($name) }
 190             fn get_lints(&self) -> LintArray { $crate::lint_array!($($lint),*) }
 191         }
 192     };
 193 }
 194
 195 /// Declares a type named `$name` which implements `LintPass`.
 196 /// To the right of `=>` a comma separated list of `Lint` statics is given.
 197 #[macro_export]
 198 macro_rules! declare_lint_pass {
 199     ($(#[$m:meta])* $name:ident => [$($lint:expr),* $(,)?]) => {
 200         $(#[$m])* #[derive(Copy, Clone)] pub struct $name;
 201         $crate::impl_lint_pass!($name => [$($lint),*]);
 202     };
 203 }
 204
 205 #[macro_export]
 206 macro_rules! late_lint_methods {
 207     ($macro:path, $args:tt, [$hir:tt]) => (
 208         $macro!($args, [$hir], [
 209             fn check_param(a: &$hir hir::Param);
 210             fn check_body(a: &$hir hir::Body);
 211             fn check_body_post(a: &$hir hir::Body);
 212             fn check_name(a: Span, b: ast::Name);
 213             fn check_crate(a: &$hir hir::Crate);
 214             fn check_crate_post(a: &$hir hir::Crate);
 215             fn check_mod(a: &$hir hir::Mod, b: Span, c: hir::HirId);
 216             fn check_mod_post(a: &$hir hir::Mod, b: Span, c: hir::HirId);
 217             fn check_foreign_item(a: &$hir hir::ForeignItem);
 218             fn check_foreign_item_post(a: &$hir hir::ForeignItem);
 219             fn check_item(a: &$hir hir::Item);
 220             fn check_item_post(a: &$hir hir::Item);
 221             fn check_local(a: &$hir hir::Local);
 222             fn check_block(a: &$hir hir::Block);
 223             fn check_block_post(a: &$hir hir::Block);
 224             fn check_stmt(a: &$hir hir::Stmt);
 225             fn check_arm(a: &$hir hir::Arm);
 226             fn check_pat(a: &$hir hir::Pat);
 227             fn check_expr(a: &$hir hir::Expr);
 228             fn check_expr_post(a: &$hir hir::Expr);
 229             fn check_ty(a: &$hir hir::Ty);
 230             fn check_generic_param(a: &$hir hir::GenericParam);
 231             fn check_generics(a: &$hir hir::Generics);
 232             fn check_where_predicate(a: &$hir hir::WherePredicate);
 233             fn check_poly_trait_ref(a: &$hir hir::PolyTraitRef, b: hir::TraitBoundModifier);
 234             fn check_fn(
 235                 a: hir::intravisit::FnKind<$hir>,
 236                 b: &$hir hir::FnDecl,
 237                 c: &$hir hir::Body,
 238                 d: Span,
 239                 e: hir::HirId);
 240             fn check_fn_post(
 241                 a: hir::intravisit::FnKind<$hir>,
 242                 b: &$hir hir::FnDecl,
 243                 c: &$hir hir::Body,
 244                 d: Span,
 245                 e: hir::HirId
 246             );
 247             fn check_trait_item(a: &$hir hir::TraitItem);
 248             fn check_trait_item_post(a: &$hir hir::TraitItem);
 249             fn check_impl_item(a: &$hir hir::ImplItem);
 250             fn check_impl_item_post(a: &$hir hir::ImplItem);
 251             fn check_struct_def(a: &$hir hir::VariantData);
 252             fn check_struct_def_post(a: &$hir hir::VariantData);
 253             fn check_struct_field(a: &$hir hir::StructField);
 254             fn check_variant(a: &$hir hir::Variant);
 255             fn check_variant_post(a: &$hir hir::Variant);
 256             fn check_lifetime(a: &$hir hir::Lifetime);
 257             fn check_path(a: &$hir hir::Path, b: hir::HirId);
 258             fn check_attribute(a: &$hir ast::Attribute);
 259
 260             /// Called when entering a syntax node that can have lint attributes such
 261             /// as `#[allow(...)]`. Called with *all* the attributes of that node.
 262             fn enter_lint_attrs(a: &$hir [ast::Attribute]);
 263
 264             /// Counterpart to `enter_lint_attrs`.
 265             fn exit_lint_attrs(a: &$hir [ast::Attribute]);
 266         ]);
 267     )
 268 }
 269
 270 /// Trait for types providing lint checks.
 271 ///
 272 /// Each `check` method checks a single syntax node, and should not
 273 /// invoke methods recursively (unlike `Visitor`). By default they
 274 /// do nothing.
 275 //
 276 // FIXME: eliminate the duplication with `Visitor`. But this also
 277 // contains a few lint-specific methods with no equivalent in `Visitor`.
 278
 279 macro_rules! expand_lint_pass_methods {
 280     ($context:ty, [$($(#[$attr:meta])* fn $name:ident($($param:ident: $arg:ty),*);)*]) => (
 281         $(#[inline(always)] fn $name(&mut self, _: $context, $(_: $arg),*) {})*
 282     )
 283 }
 284
 285 macro_rules! declare_late_lint_pass {
 286     ([], [$hir:tt], [$($methods:tt)*]) => (
 287         pub trait LateLintPass<'a, $hir>: LintPass {
 288             fn fresh_late_pass(&self) -> LateLintPassObject {
 289                 panic!()
 290             }
 291             expand_lint_pass_methods!(&LateContext<'a, $hir>, [$($methods)*]);
 292         }
 293     )
 294 }
 295
 296 late_lint_methods!(declare_late_lint_pass, [], ['tcx]);
 297
 298 #[macro_export]
 299 macro_rules! expand_combined_late_lint_pass_method {
 300     ([$($passes:ident),*], $self: ident, $name: ident, $params:tt) => ({
 301         $($self.$passes.$name $params;)*
 302     })
 303 }
 304
 305 #[macro_export]
 306 macro_rules! expand_combined_late_lint_pass_methods {
 307     ($passes:tt, [$($(#[$attr:meta])* fn $name:ident($($param:ident: $arg:ty),*);)*]) => (
 308         $(fn $name(&mut self, context: &LateContext<'a, 'tcx>, $($param: $arg),*) {
 309             expand_combined_late_lint_pass_method!($passes, self, $name, (context, $($param),*));
 310         })*
 311     )
 312 }
 313
 314 #[macro_export]
 315 macro_rules! declare_combined_late_lint_pass {
 316     ([$v:vis $name:ident, [$($passes:ident: $constructor:expr,)*]], [$hir:tt], $methods:tt) => (
 317         #[allow(non_snake_case)]
 318         $v struct $name {
 319             $($passes: $passes,)*
 320         }
 321
 322         impl $name {
 323             $v fn new() -> Self {
 324                 Self {
 325                     $($passes: $constructor,)*
 326                 }
 327             }
 328         }
 329
 330         impl<'a, 'tcx> LateLintPass<'a, 'tcx> for $name {
 331             expand_combined_late_lint_pass_methods!([$($passes),*], $methods);
 332         }
 333
 334         impl LintPass for $name {
 335             fn name(&self) -> &'static str {
 336                 panic!()
 337             }
 338
 339             fn get_lints(&self) -> LintArray {
 340                 let mut lints = Vec::new();
 341                 $(lints.extend_from_slice(&self.$passes.get_lints());)*
 342                 lints
 343             }
 344         }
 345     )
 346 }
 347
 348 #[macro_export]
 349 macro_rules! early_lint_methods {
 350     ($macro:path, $args:tt) => (
 351         $macro!($args, [
 352             fn check_param(a: &ast::Param);
 353             fn check_ident(a: ast::Ident);
 354             fn check_crate(a: &ast::Crate);
 355             fn check_crate_post(a: &ast::Crate);
 356             fn check_mod(a: &ast::Mod, b: Span, c: ast::NodeId);
 357             fn check_mod_post(a: &ast::Mod, b: Span, c: ast::NodeId);
 358             fn check_foreign_item(a: &ast::ForeignItem);
 359             fn check_foreign_item_post(a: &ast::ForeignItem);
 360             fn check_item(a: &ast::Item);
 361             fn check_item_post(a: &ast::Item);
 362             fn check_local(a: &ast::Local);
 363             fn check_block(a: &ast::Block);
 364             fn check_block_post(a: &ast::Block);
 365             fn check_stmt(a: &ast::Stmt);
 366             fn check_arm(a: &ast::Arm);
 367             fn check_pat(a: &ast::Pat);
 368             fn check_pat_post(a: &ast::Pat);
 369             fn check_expr(a: &ast::Expr);
 370             fn check_expr_post(a: &ast::Expr);
 371             fn check_ty(a: &ast::Ty);
 372             fn check_generic_param(a: &ast::GenericParam);
 373             fn check_generics(a: &ast::Generics);
 374             fn check_where_predicate(a: &ast::WherePredicate);
 375             fn check_poly_trait_ref(a: &ast::PolyTraitRef,
 376                                     b: &ast::TraitBoundModifier);
 377             fn check_fn(a: syntax::visit::FnKind<'_>, b: &ast::FnDecl, c: Span, d_: ast::NodeId);
 378             fn check_fn_post(
 379                 a: syntax::visit::FnKind<'_>,
 380                 b: &ast::FnDecl,
 381                 c: Span,
 382                 d: ast::NodeId
 383             );
 384             fn check_trait_item(a: &ast::TraitItem);
 385             fn check_trait_item_post(a: &ast::TraitItem);
 386             fn check_impl_item(a: &ast::ImplItem);
 387             fn check_impl_item_post(a: &ast::ImplItem);
 388             fn check_struct_def(a: &ast::VariantData);
 389             fn check_struct_def_post(a: &ast::VariantData);
 390             fn check_struct_field(a: &ast::StructField);
 391             fn check_variant(a: &ast::Variant);
 392             fn check_variant_post(a: &ast::Variant);
 393             fn check_lifetime(a: &ast::Lifetime);
 394             fn check_path(a: &ast::Path, b: ast::NodeId);
 395             fn check_attribute(a: &ast::Attribute);
 396             fn check_mac_def(a: &ast::MacroDef, b: ast::NodeId);
 397             fn check_mac(a: &ast::Mac);
 398
 399             /// Called when entering a syntax node that can have lint attributes such
 400             /// as `#[allow(...)]`. Called with *all* the attributes of that node.
 401             fn enter_lint_attrs(a: &[ast::Attribute]);
 402
 403             /// Counterpart to `enter_lint_attrs`.
 404             fn exit_lint_attrs(a: &[ast::Attribute]);
 405         ]);
 406     )
 407 }
 408
 409 macro_rules! expand_early_lint_pass_methods {
 410     ($context:ty, [$($(#[$attr:meta])* fn $name:ident($($param:ident: $arg:ty),*);)*]) => (
 411         $(#[inline(always)] fn $name(&mut self, _: $context, $(_: $arg),*) {})*
 412     )
 413 }
 414
 415 macro_rules! declare_early_lint_pass {
 416     ([], [$($methods:tt)*]) => (
 417         pub trait EarlyLintPass: LintPass {
 418             expand_early_lint_pass_methods!(&EarlyContext<'_>, [$($methods)*]);
 419         }
 420     )
 421 }
 422
 423 early_lint_methods!(declare_early_lint_pass, []);
 424
 425 #[macro_export]
 426 macro_rules! expand_combined_early_lint_pass_method {
 427     ([$($passes:ident),*], $self: ident, $name: ident, $params:tt) => ({
 428         $($self.$passes.$name $params;)*
 429     })
 430 }
 431
 432 #[macro_export]
 433 macro_rules! expand_combined_early_lint_pass_methods {
 434     ($passes:tt, [$($(#[$attr:meta])* fn $name:ident($($param:ident: $arg:ty),*);)*]) => (
 435         $(fn $name(&mut self, context: &EarlyContext<'_>, $($param: $arg),*) {
 436             expand_combined_early_lint_pass_method!($passes, self, $name, (context, $($param),*));
 437         })*
 438     )
 439 }
 440
 441 #[macro_export]
 442 macro_rules! declare_combined_early_lint_pass {
 443     ([$v:vis $name:ident, [$($passes:ident: $constructor:expr,)*]], $methods:tt) => (
 444         #[allow(non_snake_case)]
 445         $v struct $name {
 446             $($passes: $passes,)*
 447         }
 448
 449         impl $name {
 450             $v fn new() -> Self {
 451                 Self {
 452                     $($passes: $constructor,)*
 453                 }
 454             }
 455         }
 456
 457         impl EarlyLintPass for $name {
 458             expand_combined_early_lint_pass_methods!([$($passes),*], $methods);
 459         }
 460
 461         impl LintPass for $name {
 462             fn name(&self) -> &'static str {
 463                 panic!()
 464             }
 465
 466             fn get_lints(&self) -> LintArray {
 467                 let mut lints = Vec::new();
 468                 $(lints.extend_from_slice(&self.$passes.get_lints());)*
 469                 lints
 470             }
 471         }
 472     )
 473 }
 474
 475 /// A lint pass boxed up as a trait object.
 476 pub type EarlyLintPassObject = Box<dyn EarlyLintPass + sync::Send + sync::Sync + 'static>;
 477 pub type LateLintPassObject = Box<dyn for<'a, 'tcx> LateLintPass<'a, 'tcx> + sync::Send
 478                                                                            + sync::Sync + 'static>;
 479
 480 /// Identifies a lint known to the compiler.
 481 #[derive(Clone, Copy, Debug)]
 482 pub struct LintId {
 483     // Identity is based on pointer equality of this field.
 484     lint: &'static Lint,
 485 }
 486
 487 impl PartialEq for LintId {
 488     fn eq(&self, other: &LintId) -> bool {
 489         ptr::eq(self.lint, other.lint)
 490     }
 491 }
 492
 493 impl Eq for LintId { }
 494
 495 impl hash::Hash for LintId {
 496     fn hash<H: hash::Hasher>(&self, state: &mut H) {
 497         let ptr = self.lint as *const Lint;
 498         ptr.hash(state);
 499     }
 500 }
 501
 502 impl LintId {
 503     /// Gets the `LintId` for a `Lint`.
 504     pub fn of(lint: &'static Lint) -> LintId {
 505         LintId {
 506             lint,
 507         }
 508     }
 509
 510     pub fn lint_name_raw(&self) -> &'static str {
 511         self.lint.name
 512     }
 513
 514     /// Gets the name of the lint.
 515     pub fn to_string(&self) -> String {
 516         self.lint.name_lower()
 517     }
 518 }
 519
 520 /// Setting for how to handle a lint.
 521 #[derive(Clone, Copy, PartialEq, PartialOrd, Eq, Ord, Debug, Hash)]
 522 pub enum Level {
 523     Allow, Warn, Deny, Forbid,
 524 }
 525
 526 impl_stable_hash_for!(enum self::Level {
 527     Allow,
 528     Warn,
 529     Deny,
 530     Forbid
 531 });
 532
 533 impl Level {
 534     /// Converts a level to a lower-case string.
 535     pub fn as_str(self) -> &'static str {
 536         match self {
 537             Allow => "allow",
 538             Warn => "warn",
 539             Deny => "deny",
 540             Forbid => "forbid",
 541         }
 542     }
 543
 544     /// Converts a lower-case string to a level.
 545     pub fn from_str(x: &str) -> Option<Level> {
 546         match x {
 547             "allow" => Some(Allow),
 548             "warn" => Some(Warn),
 549             "deny" => Some(Deny),
 550             "forbid" => Some(Forbid),
 551             _ => None,
 552         }
 553     }
 554
 555     /// Converts a symbol to a level.
 556     pub fn from_symbol(x: Symbol) -> Option<Level> {
 557         match x {
 558             sym::allow => Some(Allow),
 559             sym::warn => Some(Warn),
 560             sym::deny => Some(Deny),
 561             sym::forbid => Some(Forbid),
 562             _ => None,
 563         }
 564     }
 565 }
 566
 567 /// How a lint level was set.
 568 #[derive(Clone, Copy, PartialEq, Eq)]
 569 pub enum LintSource {
 570     /// Lint is at the default level as declared
 571     /// in rustc or a plugin.
 572     Default,
 573
 574     /// Lint level was set by an attribute.
 575     Node(ast::Name, Span, Option<Symbol> /* RFC 2383 reason */),
 576
 577     /// Lint level was set by a command-line flag.
 578     CommandLine(Symbol),
 579 }
 580
 581 impl_stable_hash_for!(enum self::LintSource {
 582     Default,
 583     Node(name, span, reason),
 584     CommandLine(text)
 585 });
 586
 587 pub type LevelSource = (Level, LintSource);
 588
 589 pub mod builtin;
 590 pub mod internal;
 591 mod context;
 592 mod levels;
 593
 594 pub use self::levels::{LintLevelSets, LintLevelMap};
 595
 596 #[derive(Default)]
 597 pub struct LintBuffer {
 598     map: NodeMap<Vec<BufferedEarlyLint>>,
 599 }
 600
 601 impl LintBuffer {
 602     pub fn add_lint(&mut self,
 603                     lint: &'static Lint,
 604                     id: ast::NodeId,
 605                     sp: MultiSpan,
 606                     msg: &str,
 607                     diagnostic: BuiltinLintDiagnostics) {
 608         let early_lint = BufferedEarlyLint {
 609             lint_id: LintId::of(lint),
 610             ast_id: id,
 611             span: sp,
 612             msg: msg.to_string(),
 613             diagnostic
 614         };
 615         let arr = self.map.entry(id).or_default();
 616         if !arr.contains(&early_lint) {
 617             arr.push(early_lint);
 618         }
 619     }
 620
 621     pub fn take(&mut self, id: ast::NodeId) -> Vec<BufferedEarlyLint> {
 622         self.map.remove(&id).unwrap_or_default()
 623     }
 624
 625     pub fn get_any(&self) -> Option<&[BufferedEarlyLint]> {
 626         let key = self.map.keys().next().map(|k| *k);
 627         key.map(|k| &self.map[&k][..])
 628     }
 629 }
 630
 631 pub fn struct_lint_level<'a>(sess: &'a Session,
 632                              lint: &'static Lint,
 633                              level: Level,
 634                              src: LintSource,
 635                              span: Option<MultiSpan>,
 636                              msg: &str)
 637     -> DiagnosticBuilder<'a>
 638 {
 639     let mut err = match (level, span) {
 640         (Level::Allow, _) => return sess.diagnostic().struct_dummy(),
 641         (Level::Warn, Some(span)) => sess.struct_span_warn(span, msg),
 642         (Level::Warn, None) => sess.struct_warn(msg),
 643         (Level::Deny, Some(span)) |
 644         (Level::Forbid, Some(span)) => sess.struct_span_err(span, msg),
 645         (Level::Deny, None) |
 646         (Level::Forbid, None) => sess.struct_err(msg),
 647     };
 648
 649     // Check for future incompatibility lints and issue a stronger warning.
 650     let lints = sess.lint_store.borrow();
 651     let lint_id = LintId::of(lint);
 652     let future_incompatible = lints.future_incompatible(lint_id);
 653
 654     // If this code originates in a foreign macro, aka something that this crate
 655     // did not itself author, then it's likely that there's nothing this crate
 656     // can do about it. We probably want to skip the lint entirely.
 657     if err.span.primary_spans().iter().any(|s| in_external_macro(sess, *s)) {
 658         // Any suggestions made here are likely to be incorrect, so anything we
 659         // emit shouldn't be automatically fixed by rustfix.
 660         err.allow_suggestions(false);
 661
 662         // If this is a future incompatible lint it'll become a hard error, so
 663         // we have to emit *something*. Also allow lints to whitelist themselves
 664         // on a case-by-case basis for emission in a foreign macro.
 665         if future_incompatible.is_none() && !lint.report_in_external_macro {
 666             err.cancel();
 667             // Don't continue further, since we don't want to have
 668             // `diag_span_note_once` called for a diagnostic that isn't emitted.
 669             return err;
 670         }
 671     }
 672
 673     let name = lint.name_lower();
 674     match src {
 675         LintSource::Default => {
 676             sess.diag_note_once(
 677                 &mut err,
 678                 DiagnosticMessageId::from(lint),
 679                 &format!("`#[{}({})]` on by default", level.as_str(), name));
 680         }
 681         LintSource::CommandLine(lint_flag_val) => {
 682             let flag = match level {
 683                 Level::Warn => "-W",
 684                 Level::Deny => "-D",
 685                 Level::Forbid => "-F",
 686                 Level::Allow => panic!(),
 687             };
 688             let hyphen_case_lint_name = name.replace("_", "-");
 689             if lint_flag_val.as_str() == name {
 690                 sess.diag_note_once(
 691                     &mut err,
 692                     DiagnosticMessageId::from(lint),
 693                     &format!("requested on the command line with `{} {}`",
 694                              flag, hyphen_case_lint_name));
 695             } else {
 696                 let hyphen_case_flag_val = lint_flag_val.as_str().replace("_", "-");
 697                 sess.diag_note_once(
 698                     &mut err,
 699                     DiagnosticMessageId::from(lint),
 700                     &format!("`{} {}` implied by `{} {}`",
 701                              flag, hyphen_case_lint_name, flag,
 702                              hyphen_case_flag_val));
 703             }
 704         }
 705         LintSource::Node(lint_attr_name, src, reason) => {
 706             if let Some(rationale) = reason {
 707                 err.note(&rationale.as_str());
 708             }
 709             sess.diag_span_note_once(&mut err, DiagnosticMessageId::from(lint),
 710                                      src, "lint level defined here");
 711             if lint_attr_name.as_str() != name {
 712                 let level_str = level.as_str();
 713                 sess.diag_note_once(&mut err, DiagnosticMessageId::from(lint),
 714                                     &format!("`#[{}({})]` implied by `#[{}({})]`",
 715                                              level_str, name, level_str, lint_attr_name));
 716             }
 717         }
 718     }
 719
 720     err.code(DiagnosticId::Lint(name));
 721
 722     if let Some(future_incompatible) = future_incompatible {
 723         const STANDARD_MESSAGE: &str =
 724             "this was previously accepted by the compiler but is being phased out; \
 725              it will become a hard error";
 726
 727         let explanation = if lint_id == LintId::of(builtin::UNSTABLE_NAME_COLLISIONS) {
 728             "once this method is added to the standard library, \
 729              the ambiguity may cause an error or change in behavior!"
 730                 .to_owned()
 731         } else if lint_id == LintId::of(builtin::MUTABLE_BORROW_RESERVATION_CONFLICT) {
 732             "this borrowing pattern was not meant to be accepted, \
 733              and may become a hard error in the future"
 734                 .to_owned()
 735         } else if let Some(edition) = future_incompatible.edition {
 736             format!("{} in the {} edition!", STANDARD_MESSAGE, edition)
 737         } else {
 738             format!("{} in a future release!", STANDARD_MESSAGE)
 739         };
 740         let citation = format!("for more information, see {}",
 741                                future_incompatible.reference);
 742         err.warn(&explanation);
 743         err.note(&citation);
 744     }
 745
 746     return err
 747 }
 748
 749 pub fn maybe_lint_level_root(tcx: TyCtxt<'_>, id: hir::HirId) -> bool {
 750     let attrs = tcx.hir().attrs(id);
 751     attrs.iter().any(|attr| Level::from_symbol(attr.name_or_empty()).is_some())
 752 }
 753
 754 fn lint_levels(tcx: TyCtxt<'_>, cnum: CrateNum) -> &LintLevelMap {
 755     assert_eq!(cnum, LOCAL_CRATE);
 756     let mut builder = LintLevelMapBuilder {
 757         levels: LintLevelSets::builder(tcx.sess),
 758         tcx: tcx,
 759     };
 760     let krate = tcx.hir().krate();
 761
 762     let push = builder.levels.push(&krate.attrs);
 763     builder.levels.register_id(hir::CRATE_HIR_ID);
 764     for macro_def in &krate.exported_macros {
 765        builder.levels.register_id(macro_def.hir_id);
 766     }
 767     intravisit::walk_crate(&mut builder, krate);
 768     builder.levels.pop(push);
 769
 770     tcx.arena.alloc(builder.levels.build_map())
 771 }
 772
 773 struct LintLevelMapBuilder<'tcx> {
 774     levels: levels::LintLevelsBuilder<'tcx>,
 775     tcx: TyCtxt<'tcx>,
 776 }
 777
 778 impl LintLevelMapBuilder<'tcx> {
 779     fn with_lint_attrs<F>(&mut self,
 780                           id: hir::HirId,
 781                           attrs: &[ast::Attribute],
 782                           f: F)
 783         where F: FnOnce(&mut Self)
 784     {
 785         let push = self.levels.push(attrs);
 786         if push.changed {
 787             self.levels.register_id(id);
 788         }
 789         f(self);
 790         self.levels.pop(push);
 791     }
 792 }
 793
 794 impl intravisit::Visitor<'tcx> for LintLevelMapBuilder<'tcx> {
 795     fn nested_visit_map<'this>(&'this mut self) -> intravisit::NestedVisitorMap<'this, 'tcx> {
 796         intravisit::NestedVisitorMap::All(&self.tcx.hir())
 797     }
 798
 799     fn visit_param(&mut self, param: &'tcx hir::Param) {
 800         self.with_lint_attrs(param.hir_id, &param.attrs, |builder| {
 801             intravisit::walk_param(builder, param);
 802         });
 803     }
 804
 805     fn visit_item(&mut self, it: &'tcx hir::Item) {
 806         self.with_lint_attrs(it.hir_id, &it.attrs, |builder| {
 807             intravisit::walk_item(builder, it);
 808         });
 809     }
 810
 811     fn visit_foreign_item(&mut self, it: &'tcx hir::ForeignItem) {
 812         self.with_lint_attrs(it.hir_id, &it.attrs, |builder| {
 813             intravisit::walk_foreign_item(builder, it);
 814         })
 815     }
 816
 817     fn visit_expr(&mut self, e: &'tcx hir::Expr) {
 818         self.with_lint_attrs(e.hir_id, &e.attrs, |builder| {
 819             intravisit::walk_expr(builder, e);
 820         })
 821     }
 822
 823     fn visit_struct_field(&mut self, s: &'tcx hir::StructField) {
 824         self.with_lint_attrs(s.hir_id, &s.attrs, |builder| {
 825             intravisit::walk_struct_field(builder, s);
 826         })
 827     }
 828
 829     fn visit_variant(&mut self,
 830                      v: &'tcx hir::Variant,
 831                      g: &'tcx hir::Generics,
 832                      item_id: hir::HirId) {
 833         self.with_lint_attrs(v.id, &v.attrs, |builder| {
 834             intravisit::walk_variant(builder, v, g, item_id);
 835         })
 836     }
 837
 838     fn visit_local(&mut self, l: &'tcx hir::Local) {
 839         self.with_lint_attrs(l.hir_id, &l.attrs, |builder| {
 840             intravisit::walk_local(builder, l);
 841         })
 842     }
 843
 844     fn visit_arm(&mut self, a: &'tcx hir::Arm) {
 845         self.with_lint_attrs(a.hir_id, &a.attrs, |builder| {
 846             intravisit::walk_arm(builder, a);
 847         })
 848     }
 849
 850     fn visit_trait_item(&mut self, trait_item: &'tcx hir::TraitItem) {
 851         self.with_lint_attrs(trait_item.hir_id, &trait_item.attrs, |builder| {
 852             intravisit::walk_trait_item(builder, trait_item);
 853         });
 854     }
 855
 856     fn visit_impl_item(&mut self, impl_item: &'tcx hir::ImplItem) {
 857         self.with_lint_attrs(impl_item.hir_id, &impl_item.attrs, |builder| {
 858             intravisit::walk_impl_item(builder, impl_item);
 859         });
 860     }
 861 }
 862
 863 pub fn provide(providers: &mut Providers<'_>) {
 864     providers.lint_levels = lint_levels;
 865 }
 866
 867 /// Returns whether `span` originates in a foreign crate's external macro.
 868 ///
 869 /// This is used to test whether a lint should not even begin to figure out whether it should
 870 /// be reported on the current node.
 871 pub fn in_external_macro(sess: &Session, span: Span) -> bool {
 872     let expn_data = span.ctxt().outer_expn_data();
 873     match expn_data.kind {
 874         ExpnKind::Root | ExpnKind::Desugaring(DesugaringKind::ForLoop) => false,
 875         ExpnKind::AstPass(_) | ExpnKind::Desugaring(_) => true, // well, it's "external"
 876         ExpnKind::Macro(MacroKind::Bang, _) => {
 877             if expn_data.def_site.is_dummy() {
 878                 // Dummy span for the `def_site` means it's an external macro.
 879                 return true;
 880             }
 881             match sess.source_map().span_to_snippet(expn_data.def_site) {
 882                 Ok(code) => !code.starts_with("macro_rules"),
 883                 // No snippet means external macro or compiler-builtin expansion.
 884                 Err(_) => true,
 885             }
 886         }
 887         ExpnKind::Macro(..) => true, // definitely a plugin
 888     }
 889 }
 890
 891 /// Returns `true` if `span` originates in a derive-macro's expansion.
 892 pub fn in_derive_expansion(span: Span) -> bool {
 893     if let ExpnKind::Macro(MacroKind::Derive, _) = span.ctxt().outer_expn_data().kind {
 894         return true;
 895     }
 896     false
 897 }