compiler/rustc_lint/src/unused.rs

   1 use crate::Lint;
   2 use crate::{EarlyContext, EarlyLintPass, LateContext, LateLintPass, LintContext};
   3 use rustc_ast as ast;
   4 use rustc_ast::util::{classify, parser};
   5 use rustc_ast::{ExprKind, StmtKind};
   6 use rustc_errors::{fluent, pluralize, Applicability, MultiSpan};
   7 use rustc_hir as hir;
   8 use rustc_hir::def::{DefKind, Res};
   9 use rustc_hir::def_id::DefId;
  10 use rustc_infer::traits::util::elaborate_predicates_with_span;
  11 use rustc_middle::ty::adjustment;
  12 use rustc_middle::ty::{self, Ty};
  13 use rustc_span::symbol::Symbol;
  14 use rustc_span::symbol::{kw, sym};
  15 use rustc_span::{BytePos, Span};
  16
  17 declare_lint! {
  18     /// The `unused_must_use` lint detects unused result of a type flagged as
  19     /// `#[must_use]`.
  20     ///
  21     /// ### Example
  22     ///
  23     /// ```rust
  24     /// fn returns_result() -> Result<(), ()> {
  25     ///     Ok(())
  26     /// }
  27     ///
  28     /// fn main() {
  29     ///     returns_result();
  30     /// }
  31     /// ```
  32     ///
  33     /// {{produces}}
  34     ///
  35     /// ### Explanation
  36     ///
  37     /// The `#[must_use]` attribute is an indicator that it is a mistake to
  38     /// ignore the value. See [the reference] for more details.
  39     ///
  40     /// [the reference]: https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-must_use-attribute
  41     pub UNUSED_MUST_USE,
  42     Warn,
  43     "unused result of a type flagged as `#[must_use]`",
  44     report_in_external_macro
  45 }
  46
  47 declare_lint! {
  48     /// The `unused_results` lint checks for the unused result of an
  49     /// expression in a statement.
  50     ///
  51     /// ### Example
  52     ///
  53     /// ```rust,compile_fail
  54     /// #![deny(unused_results)]
  55     /// fn foo<T>() -> T { panic!() }
  56     ///
  57     /// fn main() {
  58     ///     foo::<usize>();
  59     /// }
  60     /// ```
  61     ///
  62     /// {{produces}}
  63     ///
  64     /// ### Explanation
  65     ///
  66     /// Ignoring the return value of a function may indicate a mistake. In
  67     /// cases were it is almost certain that the result should be used, it is
  68     /// recommended to annotate the function with the [`must_use` attribute].
  69     /// Failure to use such a return value will trigger the [`unused_must_use`
  70     /// lint] which is warn-by-default. The `unused_results` lint is
  71     /// essentially the same, but triggers for *all* return values.
  72     ///
  73     /// This lint is "allow" by default because it can be noisy, and may not be
  74     /// an actual problem. For example, calling the `remove` method of a `Vec`
  75     /// or `HashMap` returns the previous value, which you may not care about.
  76     /// Using this lint would require explicitly ignoring or discarding such
  77     /// values.
  78     ///
  79     /// [`must_use` attribute]: https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-must_use-attribute
  80     /// [`unused_must_use` lint]: warn-by-default.html#unused-must-use
  81     pub UNUSED_RESULTS,
  82     Allow,
  83     "unused result of an expression in a statement"
  84 }
  85
  86 declare_lint_pass!(UnusedResults => [UNUSED_MUST_USE, UNUSED_RESULTS]);
  87
  88 impl<'tcx> LateLintPass<'tcx> for UnusedResults {
  89     fn check_stmt(&mut self, cx: &LateContext<'_>, s: &hir::Stmt<'_>) {
  90         let expr = match s.kind {
  91             hir::StmtKind::Semi(ref expr) => &**expr,
  92             _ => return,
  93         };
  94
  95         if let hir::ExprKind::Ret(..) = expr.kind {
  96             return;
  97         }
  98
  99         let ty = cx.typeck_results().expr_ty(&expr);
 100         let type_permits_lack_of_use = check_must_use_ty(cx, ty, &expr, s.span, "", "", 1);
 101
 102         let mut fn_warned = false;
 103         let mut op_warned = false;
 104         let maybe_def_id = match expr.kind {
 105             hir::ExprKind::Call(ref callee, _) => {
 106                 match callee.kind {
 107                     hir::ExprKind::Path(ref qpath) => {
 108                         match cx.qpath_res(qpath, callee.hir_id) {
 109                             Res::Def(DefKind::Fn | DefKind::AssocFn, def_id) => Some(def_id),
 110                             // `Res::Local` if it was a closure, for which we
 111                             // do not currently support must-use linting
 112                             _ => None,
 113                         }
 114                     }
 115                     _ => None,
 116                 }
 117             }
 118             hir::ExprKind::MethodCall(..) => cx.typeck_results().type_dependent_def_id(expr.hir_id),
 119             _ => None,
 120         };
 121         if let Some(def_id) = maybe_def_id {
 122             fn_warned = check_must_use_def(cx, def_id, s.span, "return value of ", "");
 123         } else if type_permits_lack_of_use {
 124             // We don't warn about unused unit or uninhabited types.
 125             // (See https://github.com/rust-lang/rust/issues/43806 for details.)
 126             return;
 127         }
 128
 129         let must_use_op = match expr.kind {
 130             // Hardcoding operators here seemed more expedient than the
 131             // refactoring that would be needed to look up the `#[must_use]`
 132             // attribute which does exist on the comparison trait methods
 133             hir::ExprKind::Binary(bin_op, ..) => match bin_op.node {
 134                 hir::BinOpKind::Eq
 135                 | hir::BinOpKind::Lt
 136                 | hir::BinOpKind::Le
 137                 | hir::BinOpKind::Ne
 138                 | hir::BinOpKind::Ge
 139                 | hir::BinOpKind::Gt => Some("comparison"),
 140                 hir::BinOpKind::Add
 141                 | hir::BinOpKind::Sub
 142                 | hir::BinOpKind::Div
 143                 | hir::BinOpKind::Mul
 144                 | hir::BinOpKind::Rem => Some("arithmetic operation"),
 145                 hir::BinOpKind::And | hir::BinOpKind::Or => Some("logical operation"),
 146                 hir::BinOpKind::BitXor
 147                 | hir::BinOpKind::BitAnd
 148                 | hir::BinOpKind::BitOr
 149                 | hir::BinOpKind::Shl
 150                 | hir::BinOpKind::Shr => Some("bitwise operation"),
 151             },
 152             hir::ExprKind::AddrOf(..) => Some("borrow"),
 153             hir::ExprKind::Unary(..) => Some("unary operation"),
 154             _ => None,
 155         };
 156
 157         if let Some(must_use_op) = must_use_op {
 158             cx.struct_span_lint(UNUSED_MUST_USE, expr.span, fluent::lint_unused_op, |lint| {
 159                 lint.set_arg("op", must_use_op)
 160                     .span_label(expr.span, fluent::label)
 161                     .span_suggestion_verbose(
 162                         expr.span.shrink_to_lo(),
 163                         fluent::suggestion,
 164                         "let _ = ",
 165                         Applicability::MachineApplicable,
 166                     )
 167             });
 168             op_warned = true;
 169         }
 170
 171         if !(type_permits_lack_of_use || fn_warned || op_warned) {
 172             cx.struct_span_lint(UNUSED_RESULTS, s.span, fluent::lint_unused_result, |lint| {
 173                 lint.set_arg("ty", ty)
 174             });
 175         }
 176
 177         // Returns whether an error has been emitted (and thus another does not need to be later).
 178         fn check_must_use_ty<'tcx>(
 179             cx: &LateContext<'tcx>,
 180             ty: Ty<'tcx>,
 181             expr: &hir::Expr<'_>,
 182             span: Span,
 183             descr_pre: &str,
 184             descr_post: &str,
 185             plural_len: usize,
 186         ) -> bool {
 187             if ty.is_unit()
 188                 || cx.tcx.is_ty_uninhabited_from(
 189                     cx.tcx.parent_module(expr.hir_id).to_def_id(),
 190                     ty,
 191                     cx.param_env,
 192                 )
 193             {
 194                 return true;
 195             }
 196
 197             let plural_suffix = pluralize!(plural_len);
 198
 199             match *ty.kind() {
 200                 ty::Adt(..) if ty.is_box() => {
 201                     let boxed_ty = ty.boxed_ty();
 202                     let descr_pre = &format!("{}boxed ", descr_pre);
 203                     check_must_use_ty(cx, boxed_ty, expr, span, descr_pre, descr_post, plural_len)
 204                 }
 205                 ty::Adt(def, _) => check_must_use_def(cx, def.did(), span, descr_pre, descr_post),
 206                 ty::Opaque(def, _) => {
 207                     let mut has_emitted = false;
 208                     for obligation in elaborate_predicates_with_span(
 209                         cx.tcx,
 210                         cx.tcx.explicit_item_bounds(def).iter().cloned(),
 211                     ) {
 212                         // We only look at the `DefId`, so it is safe to skip the binder here.
 213                         if let ty::PredicateKind::Trait(ref poly_trait_predicate) =
 214                             obligation.predicate.kind().skip_binder()
 215                         {
 216                             let def_id = poly_trait_predicate.trait_ref.def_id;
 217                             let descr_pre =
 218                                 &format!("{}implementer{} of ", descr_pre, plural_suffix,);
 219                             if check_must_use_def(cx, def_id, span, descr_pre, descr_post) {
 220                                 has_emitted = true;
 221                                 break;
 222                             }
 223                         }
 224                     }
 225                     has_emitted
 226                 }
 227                 ty::Dynamic(binder, _, _) => {
 228                     let mut has_emitted = false;
 229                     for predicate in binder.iter() {
 230                         if let ty::ExistentialPredicate::Trait(ref trait_ref) =
 231                             predicate.skip_binder()
 232                         {
 233                             let def_id = trait_ref.def_id;
 234                             let descr_post =
 235                                 &format!(" trait object{}{}", plural_suffix, descr_post,);
 236                             if check_must_use_def(cx, def_id, span, descr_pre, descr_post) {
 237                                 has_emitted = true;
 238                                 break;
 239                             }
 240                         }
 241                     }
 242                     has_emitted
 243                 }
 244                 ty::Tuple(ref tys) => {
 245                     let mut has_emitted = false;
 246                     let comps = if let hir::ExprKind::Tup(comps) = expr.kind {
 247                         debug_assert_eq!(comps.len(), tys.len());
 248                         comps
 249                     } else {
 250                         &[]
 251                     };
 252                     for (i, ty) in tys.iter().enumerate() {
 253                         let descr_post = &format!(" in tuple element {}", i);
 254                         let e = comps.get(i).unwrap_or(expr);
 255                         let span = e.span;
 256                         if check_must_use_ty(cx, ty, e, span, descr_pre, descr_post, plural_len) {
 257                             has_emitted = true;
 258                         }
 259                     }
 260                     has_emitted
 261                 }
 262                 ty::Array(ty, len) => match len.try_eval_usize(cx.tcx, cx.param_env) {
 263                     // If the array is empty we don't lint, to avoid false positives
 264                     Some(0) | None => false,
 265                     // If the array is definitely non-empty, we can do `#[must_use]` checking.
 266                     Some(n) => {
 267                         let descr_pre = &format!("{}array{} of ", descr_pre, plural_suffix,);
 268                         check_must_use_ty(cx, ty, expr, span, descr_pre, descr_post, n as usize + 1)
 269                     }
 270                 },
 271                 ty::Closure(..) => {
 272                     cx.struct_span_lint(
 273                         UNUSED_MUST_USE,
 274                         span,
 275                         fluent::lint_unused_closure,
 276                         |lint| {
 277                             // FIXME(davidtwco): this isn't properly translatable because of the
 278                             // pre/post strings
 279                             lint.set_arg("count", plural_len)
 280                                 .set_arg("pre", descr_pre)
 281                                 .set_arg("post", descr_post)
 282                                 .note(fluent::note)
 283                         },
 284                     );
 285                     true
 286                 }
 287                 ty::Generator(..) => {
 288                     cx.struct_span_lint(
 289                         UNUSED_MUST_USE,
 290                         span,
 291                         fluent::lint_unused_generator,
 292                         |lint| {
 293                             // FIXME(davidtwco): this isn't properly translatable because of the
 294                             // pre/post strings
 295                             lint.set_arg("count", plural_len)
 296                                 .set_arg("pre", descr_pre)
 297                                 .set_arg("post", descr_post)
 298                                 .note(fluent::note)
 299                         },
 300                     );
 301                     true
 302                 }
 303                 _ => false,
 304             }
 305         }
 306
 307         // Returns whether an error has been emitted (and thus another does not need to be later).
 308         // FIXME: Args desc_{pre,post}_path could be made lazy by taking Fn() -> &str, but this
 309         // would make calling it a big awkward. Could also take String (so args are moved), but
 310         // this would still require a copy into the format string, which would only be executed
 311         // when needed.
 312         fn check_must_use_def(
 313             cx: &LateContext<'_>,
 314             def_id: DefId,
 315             span: Span,
 316             descr_pre_path: &str,
 317             descr_post_path: &str,
 318         ) -> bool {
 319             if let Some(attr) = cx.tcx.get_attr(def_id, sym::must_use) {
 320                 cx.struct_span_lint(UNUSED_MUST_USE, span, fluent::lint_unused_def, |lint| {
 321                     // FIXME(davidtwco): this isn't properly translatable because of the pre/post
 322                     // strings
 323                     lint.set_arg("pre", descr_pre_path);
 324                     lint.set_arg("post", descr_post_path);
 325                     lint.set_arg("def", cx.tcx.def_path_str(def_id));
 326                     // check for #[must_use = "..."]
 327                     if let Some(note) = attr.value_str() {
 328                         lint.note(note.as_str());
 329                     }
 330                     lint
 331                 });
 332                 true
 333             } else {
 334                 false
 335             }
 336         }
 337     }
 338 }
 339
 340 declare_lint! {
 341     /// The `path_statements` lint detects path statements with no effect.
 342     ///
 343     /// ### Example
 344     ///
 345     /// ```rust
 346     /// let x = 42;
 347     ///
 348     /// x;
 349     /// ```
 350     ///
 351     /// {{produces}}
 352     ///
 353     /// ### Explanation
 354     ///
 355     /// It is usually a mistake to have a statement that has no effect.
 356     pub PATH_STATEMENTS,
 357     Warn,
 358     "path statements with no effect"
 359 }
 360
 361 declare_lint_pass!(PathStatements => [PATH_STATEMENTS]);
 362
 363 impl<'tcx> LateLintPass<'tcx> for PathStatements {
 364     fn check_stmt(&mut self, cx: &LateContext<'_>, s: &hir::Stmt<'_>) {
 365         if let hir::StmtKind::Semi(expr) = s.kind {
 366             if let hir::ExprKind::Path(_) = expr.kind {
 367                 let ty = cx.typeck_results().expr_ty(expr);
 368                 if ty.needs_drop(cx.tcx, cx.param_env) {
 369                     cx.struct_span_lint(
 370                         PATH_STATEMENTS,
 371                         s.span,
 372                         fluent::lint_path_statement_drop,
 373                         |lint| {
 374                             if let Ok(snippet) = cx.sess().source_map().span_to_snippet(expr.span) {
 375                                 lint.span_suggestion(
 376                                     s.span,
 377                                     fluent::suggestion,
 378                                     format!("drop({});", snippet),
 379                                     Applicability::MachineApplicable,
 380                                 );
 381                             } else {
 382                                 lint.span_help(s.span, fluent::suggestion);
 383                             }
 384                             lint
 385                         },
 386                     );
 387                 } else {
 388                     cx.struct_span_lint(
 389                         PATH_STATEMENTS,
 390                         s.span,
 391                         fluent::lint_path_statement_no_effect,
 392                         |lint| lint,
 393                     );
 394                 }
 395             }
 396         }
 397     }
 398 }
 399
 400 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 401 enum UnusedDelimsCtx {
 402     FunctionArg,
 403     MethodArg,
 404     AssignedValue,
 405     AssignedValueLetElse,
 406     IfCond,
 407     WhileCond,
 408     ForIterExpr,
 409     MatchScrutineeExpr,
 410     ReturnValue,
 411     BlockRetValue,
 412     LetScrutineeExpr,
 413     ArrayLenExpr,
 414     AnonConst,
 415     MatchArmExpr,
 416 }
 417
 418 impl From<UnusedDelimsCtx> for &'static str {
 419     fn from(ctx: UnusedDelimsCtx) -> &'static str {
 420         match ctx {
 421             UnusedDelimsCtx::FunctionArg => "function argument",
 422             UnusedDelimsCtx::MethodArg => "method argument",
 423             UnusedDelimsCtx::AssignedValue | UnusedDelimsCtx::AssignedValueLetElse => {
 424                 "assigned value"
 425             }
 426             UnusedDelimsCtx::IfCond => "`if` condition",
 427             UnusedDelimsCtx::WhileCond => "`while` condition",
 428             UnusedDelimsCtx::ForIterExpr => "`for` iterator expression",
 429             UnusedDelimsCtx::MatchScrutineeExpr => "`match` scrutinee expression",
 430             UnusedDelimsCtx::ReturnValue => "`return` value",
 431             UnusedDelimsCtx::BlockRetValue => "block return value",
 432             UnusedDelimsCtx::LetScrutineeExpr => "`let` scrutinee expression",
 433             UnusedDelimsCtx::ArrayLenExpr | UnusedDelimsCtx::AnonConst => "const expression",
 434             UnusedDelimsCtx::MatchArmExpr => "match arm expression",
 435         }
 436     }
 437 }
 438
 439 /// Used by both `UnusedParens` and `UnusedBraces` to prevent code duplication.
 440 trait UnusedDelimLint {
 441     const DELIM_STR: &'static str;
 442
 443     /// Due to `ref` pattern, there can be a difference between using
 444     /// `{ expr }` and `expr` in pattern-matching contexts. This means
 445     /// that we should only lint `unused_parens` and not `unused_braces`
 446     /// in this case.
 447     ///
 448     /// ```rust
 449     /// let mut a = 7;
 450     /// let ref b = { a }; // We actually borrow a copy of `a` here.
 451     /// a += 1; // By mutating `a` we invalidate any borrows of `a`.
 452     /// assert_eq!(b + 1, a); // `b` does not borrow `a`, so we can still use it here.
 453     /// ```
 454     const LINT_EXPR_IN_PATTERN_MATCHING_CTX: bool;
 455
 456     // this cannot be a constant is it refers to a static.
 457     fn lint(&self) -> &'static Lint;
 458
 459     fn check_unused_delims_expr(
 460         &self,
 461         cx: &EarlyContext<'_>,
 462         value: &ast::Expr,
 463         ctx: UnusedDelimsCtx,
 464         followed_by_block: bool,
 465         left_pos: Option<BytePos>,
 466         right_pos: Option<BytePos>,
 467     );
 468
 469     fn is_expr_delims_necessary(
 470         inner: &ast::Expr,
 471         followed_by_block: bool,
 472         followed_by_else: bool,
 473     ) -> bool {
 474         if followed_by_else {
 475             match inner.kind {
 476                 ast::ExprKind::Binary(op, ..) if op.node.lazy() => return true,
 477                 _ if classify::expr_trailing_brace(inner).is_some() => return true,
 478                 _ => {}
 479             }
 480         }
 481
 482         // Prevent false-positives in cases like `fn x() -> u8 { ({ 0 } + 1) }`
 483         let lhs_needs_parens = {
 484             let mut innermost = inner;
 485             loop {
 486                 innermost = match &innermost.kind {
 487                     ExprKind::Binary(_, lhs, _rhs) => lhs,
 488                     ExprKind::Call(fn_, _params) => fn_,
 489                     ExprKind::Cast(expr, _ty) => expr,
 490                     ExprKind::Type(expr, _ty) => expr,
 491                     ExprKind::Index(base, _subscript) => base,
 492                     _ => break false,
 493                 };
 494                 if !classify::expr_requires_semi_to_be_stmt(innermost) {
 495                     break true;
 496                 }
 497             }
 498         };
 499
 500         lhs_needs_parens
 501             || (followed_by_block
 502                 && match &inner.kind {
 503                     ExprKind::Ret(_) | ExprKind::Break(..) | ExprKind::Yield(..) => true,
 504                     ExprKind::Range(_lhs, Some(rhs), _limits) => {
 505                         matches!(rhs.kind, ExprKind::Block(..))
 506                     }
 507                     _ => parser::contains_exterior_struct_lit(&inner),
 508                 })
 509     }
 510
 511     fn emit_unused_delims_expr(
 512         &self,
 513         cx: &EarlyContext<'_>,
 514         value: &ast::Expr,
 515         ctx: UnusedDelimsCtx,
 516         left_pos: Option<BytePos>,
 517         right_pos: Option<BytePos>,
 518     ) {
 519         let spans = match value.kind {
 520             ast::ExprKind::Block(ref block, None) if block.stmts.len() > 0 => {
 521                 let start = block.stmts[0].span;
 522                 let end = block.stmts[block.stmts.len() - 1].span;
 523                 if let Some(start) = start.find_ancestor_inside(value.span)
 524                     && let Some(end) = end.find_ancestor_inside(value.span)
 525                 {
 526                     Some((
 527                         value.span.with_hi(start.lo()),
 528                         value.span.with_lo(end.hi()),
 529                     ))
 530                 } else {
 531                     None
 532                 }
 533             }
 534             ast::ExprKind::Paren(ref expr) => {
 535                 let expr_span = expr.span.find_ancestor_inside(value.span);
 536                 if let Some(expr_span) = expr_span {
 537                     Some((value.span.with_hi(expr_span.lo()), value.span.with_lo(expr_span.hi())))
 538                 } else {
 539                     None
 540                 }
 541             }
 542             _ => return,
 543         };
 544         let keep_space = (
 545             left_pos.map_or(false, |s| s >= value.span.lo()),
 546             right_pos.map_or(false, |s| s <= value.span.hi()),
 547         );
 548         self.emit_unused_delims(cx, value.span, spans, ctx.into(), keep_space);
 549     }
 550
 551     fn emit_unused_delims(
 552         &self,
 553         cx: &EarlyContext<'_>,
 554         value_span: Span,
 555         spans: Option<(Span, Span)>,
 556         msg: &str,
 557         keep_space: (bool, bool),
 558     ) {
 559         let primary_span = if let Some((lo, hi)) = spans {
 560             MultiSpan::from(vec![lo, hi])
 561         } else {
 562             MultiSpan::from(value_span)
 563         };
 564         cx.struct_span_lint(self.lint(), primary_span, fluent::lint_unused_delim, |lint| {
 565             lint.set_arg("delim", Self::DELIM_STR);
 566             lint.set_arg("item", msg);
 567             if let Some((lo, hi)) = spans {
 568                 let replacement = vec![
 569                     (lo, if keep_space.0 { " ".into() } else { "".into() }),
 570                     (hi, if keep_space.1 { " ".into() } else { "".into() }),
 571                 ];
 572                 lint.multipart_suggestion(
 573                     fluent::suggestion,
 574                     replacement,
 575                     Applicability::MachineApplicable,
 576                 );
 577             }
 578             lint
 579         });
 580     }
 581
 582     fn check_expr(&mut self, cx: &EarlyContext<'_>, e: &ast::Expr) {
 583         use rustc_ast::ExprKind::*;
 584         let (value, ctx, followed_by_block, left_pos, right_pos) = match e.kind {
 585             // Do not lint `unused_braces` in `if let` expressions.
 586             If(ref cond, ref block, _)
 587                 if !matches!(cond.kind, Let(_, _, _))
 588                     || Self::LINT_EXPR_IN_PATTERN_MATCHING_CTX =>
 589             {
 590                 let left = e.span.lo() + rustc_span::BytePos(2);
 591                 let right = block.span.lo();
 592                 (cond, UnusedDelimsCtx::IfCond, true, Some(left), Some(right))
 593             }
 594
 595             // Do not lint `unused_braces` in `while let` expressions.
 596             While(ref cond, ref block, ..)
 597                 if !matches!(cond.kind, Let(_, _, _))
 598                     || Self::LINT_EXPR_IN_PATTERN_MATCHING_CTX =>
 599             {
 600                 let left = e.span.lo() + rustc_span::BytePos(5);
 601                 let right = block.span.lo();
 602                 (cond, UnusedDelimsCtx::WhileCond, true, Some(left), Some(right))
 603             }
 604
 605             ForLoop(_, ref cond, ref block, ..) => {
 606                 (cond, UnusedDelimsCtx::ForIterExpr, true, None, Some(block.span.lo()))
 607             }
 608
 609             Match(ref head, _) if Self::LINT_EXPR_IN_PATTERN_MATCHING_CTX => {
 610                 let left = e.span.lo() + rustc_span::BytePos(5);
 611                 (head, UnusedDelimsCtx::MatchScrutineeExpr, true, Some(left), None)
 612             }
 613
 614             Ret(Some(ref value)) => {
 615                 let left = e.span.lo() + rustc_span::BytePos(3);
 616                 (value, UnusedDelimsCtx::ReturnValue, false, Some(left), None)
 617             }
 618
 619             Assign(_, ref value, _) | AssignOp(.., ref value) => {
 620                 (value, UnusedDelimsCtx::AssignedValue, false, None, None)
 621             }
 622             // either function/method call, or something this lint doesn't care about
 623             ref call_or_other => {
 624                 let (args_to_check, ctx) = match *call_or_other {
 625                     Call(_, ref args) => (&args[..], UnusedDelimsCtx::FunctionArg),
 626                     MethodCall(_, _, ref args, _) => (&args[..], UnusedDelimsCtx::MethodArg),
 627                     // actual catch-all arm
 628                     _ => {
 629                         return;
 630                     }
 631                 };
 632                 // Don't lint if this is a nested macro expansion: otherwise, the lint could
 633                 // trigger in situations that macro authors shouldn't have to care about, e.g.,
 634                 // when a parenthesized token tree matched in one macro expansion is matched as
 635                 // an expression in another and used as a fn/method argument (Issue #47775)
 636                 if e.span.ctxt().outer_expn_data().call_site.from_expansion() {
 637                     return;
 638                 }
 639                 for arg in args_to_check {
 640                     self.check_unused_delims_expr(cx, arg, ctx, false, None, None);
 641                 }
 642                 return;
 643             }
 644         };
 645         self.check_unused_delims_expr(cx, &value, ctx, followed_by_block, left_pos, right_pos);
 646     }
 647
 648     fn check_stmt(&mut self, cx: &EarlyContext<'_>, s: &ast::Stmt) {
 649         match s.kind {
 650             StmtKind::Local(ref local) if Self::LINT_EXPR_IN_PATTERN_MATCHING_CTX => {
 651                 if let Some((init, els)) = local.kind.init_else_opt() {
 652                     let ctx = match els {
 653                         None => UnusedDelimsCtx::AssignedValue,
 654                         Some(_) => UnusedDelimsCtx::AssignedValueLetElse,
 655                     };
 656                     self.check_unused_delims_expr(cx, init, ctx, false, None, None);
 657                 }
 658             }
 659             StmtKind::Expr(ref expr) => {
 660                 self.check_unused_delims_expr(
 661                     cx,
 662                     &expr,
 663                     UnusedDelimsCtx::BlockRetValue,
 664                     false,
 665                     None,
 666                     None,
 667                 );
 668             }
 669             _ => {}
 670         }
 671     }
 672
 673     fn check_item(&mut self, cx: &EarlyContext<'_>, item: &ast::Item) {
 674         use ast::ItemKind::*;
 675
 676         if let Const(.., Some(expr)) | Static(.., Some(expr)) = &item.kind {
 677             self.check_unused_delims_expr(
 678                 cx,
 679                 expr,
 680                 UnusedDelimsCtx::AssignedValue,
 681                 false,
 682                 None,
 683                 None,
 684             );
 685         }
 686     }
 687 }
 688
 689 declare_lint! {
 690     /// The `unused_parens` lint detects `if`, `match`, `while` and `return`
 691     /// with parentheses; they do not need them.
 692     ///
 693     /// ### Examples
 694     ///
 695     /// ```rust
 696     /// if(true) {}
 697     /// ```
 698     ///
 699     /// {{produces}}
 700     ///
 701     /// ### Explanation
 702     ///
 703     /// The parentheses are not needed, and should be removed. This is the
 704     /// preferred style for writing these expressions.
 705     pub(super) UNUSED_PARENS,
 706     Warn,
 707     "`if`, `match`, `while` and `return` do not need parentheses"
 708 }
 709
 710 declare_lint_pass!(UnusedParens => [UNUSED_PARENS]);
 711
 712 impl UnusedDelimLint for UnusedParens {
 713     const DELIM_STR: &'static str = "parentheses";
 714
 715     const LINT_EXPR_IN_PATTERN_MATCHING_CTX: bool = true;
 716
 717     fn lint(&self) -> &'static Lint {
 718         UNUSED_PARENS
 719     }
 720
 721     fn check_unused_delims_expr(
 722         &self,
 723         cx: &EarlyContext<'_>,
 724         value: &ast::Expr,
 725         ctx: UnusedDelimsCtx,
 726         followed_by_block: bool,
 727         left_pos: Option<BytePos>,
 728         right_pos: Option<BytePos>,
 729     ) {
 730         match value.kind {
 731             ast::ExprKind::Paren(ref inner) => {
 732                 let followed_by_else = ctx == UnusedDelimsCtx::AssignedValueLetElse;
 733                 if !Self::is_expr_delims_necessary(inner, followed_by_block, followed_by_else)
 734                     && value.attrs.is_empty()
 735                     && !value.span.from_expansion()
 736                     && (ctx != UnusedDelimsCtx::LetScrutineeExpr
 737                         || !matches!(inner.kind, ast::ExprKind::Binary(
 738                                 rustc_span::source_map::Spanned { node, .. },
 739                                 _,
 740                                 _,
 741                             ) if node.lazy()))
 742                 {
 743                     self.emit_unused_delims_expr(cx, value, ctx, left_pos, right_pos)
 744                 }
 745             }
 746             ast::ExprKind::Let(_, ref expr, _) => {
 747                 self.check_unused_delims_expr(
 748                     cx,
 749                     expr,
 750                     UnusedDelimsCtx::LetScrutineeExpr,
 751                     followed_by_block,
 752                     None,
 753                     None,
 754                 );
 755             }
 756             _ => {}
 757         }
 758     }
 759 }
 760
 761 impl UnusedParens {
 762     fn check_unused_parens_pat(
 763         &self,
 764         cx: &EarlyContext<'_>,
 765         value: &ast::Pat,
 766         avoid_or: bool,
 767         avoid_mut: bool,
 768     ) {
 769         use ast::{BindingAnnotation, PatKind};
 770
 771         if let PatKind::Paren(inner) = &value.kind {
 772             match inner.kind {
 773                 // The lint visitor will visit each subpattern of `p`. We do not want to lint
 774                 // any range pattern no matter where it occurs in the pattern. For something like
 775                 // `&(a..=b)`, there is a recursive `check_pat` on `a` and `b`, but we will assume
 776                 // that if there are unnecessary parens they serve a purpose of readability.
 777                 PatKind::Range(..) => return,
 778                 // Avoid `p0 | .. | pn` if we should.
 779                 PatKind::Or(..) if avoid_or => return,
 780                 // Avoid `mut x` and `mut x @ p` if we should:
 781                 PatKind::Ident(BindingAnnotation::MUT, ..) if avoid_mut => {
 782                     return;
 783                 }
 784                 // Otherwise proceed with linting.
 785                 _ => {}
 786             }
 787             let spans = if let Some(inner) = inner.span.find_ancestor_inside(value.span) {
 788                 Some((value.span.with_hi(inner.lo()), value.span.with_lo(inner.hi())))
 789             } else {
 790                 None
 791             };
 792             self.emit_unused_delims(cx, value.span, spans, "pattern", (false, false));
 793         }
 794     }
 795 }
 796
 797 impl EarlyLintPass for UnusedParens {
 798     fn check_expr(&mut self, cx: &EarlyContext<'_>, e: &ast::Expr) {
 799         match e.kind {
 800             ExprKind::Let(ref pat, _, _) | ExprKind::ForLoop(ref pat, ..) => {
 801                 self.check_unused_parens_pat(cx, pat, false, false);
 802             }
 803             // We ignore parens in cases like `if (((let Some(0) = Some(1))))` because we already
 804             // handle a hard error for them during AST lowering in `lower_expr_mut`, but we still
 805             // want to complain about things like `if let 42 = (42)`.
 806             ExprKind::If(ref cond, ref block, ref else_)
 807                 if matches!(cond.peel_parens().kind, ExprKind::Let(..)) =>
 808             {
 809                 self.check_unused_delims_expr(
 810                     cx,
 811                     cond.peel_parens(),
 812                     UnusedDelimsCtx::LetScrutineeExpr,
 813                     true,
 814                     None,
 815                     None,
 816                 );
 817                 for stmt in &block.stmts {
 818                     <Self as UnusedDelimLint>::check_stmt(self, cx, stmt);
 819                 }
 820                 if let Some(e) = else_ {
 821                     <Self as UnusedDelimLint>::check_expr(self, cx, e);
 822                 }
 823                 return;
 824             }
 825             ExprKind::Match(ref _expr, ref arm) => {
 826                 for a in arm {
 827                     self.check_unused_delims_expr(
 828                         cx,
 829                         &a.body,
 830                         UnusedDelimsCtx::MatchArmExpr,
 831                         false,
 832                         None,
 833                         None,
 834                     );
 835                 }
 836             }
 837             _ => {}
 838         }
 839
 840         <Self as UnusedDelimLint>::check_expr(self, cx, e)
 841     }
 842
 843     fn check_pat(&mut self, cx: &EarlyContext<'_>, p: &ast::Pat) {
 844         use ast::{Mutability, PatKind::*};
 845         match &p.kind {
 846             // Do not lint on `(..)` as that will result in the other arms being useless.
 847             Paren(_)
 848             // The other cases do not contain sub-patterns.
 849             | Wild | Rest | Lit(..) | MacCall(..) | Range(..) | Ident(.., None) | Path(..) => {},
 850             // These are list-like patterns; parens can always be removed.
 851             TupleStruct(_, _, ps) | Tuple(ps) | Slice(ps) | Or(ps) => for p in ps {
 852                 self.check_unused_parens_pat(cx, p, false, false);
 853             },
 854             Struct(_, _, fps, _) => for f in fps {
 855                 self.check_unused_parens_pat(cx, &f.pat, false, false);
 856             },
 857             // Avoid linting on `i @ (p0 | .. | pn)` and `box (p0 | .. | pn)`, #64106.
 858             Ident(.., Some(p)) | Box(p) => self.check_unused_parens_pat(cx, p, true, false),
 859             // Avoid linting on `&(mut x)` as `&mut x` has a different meaning, #55342.
 860             // Also avoid linting on `& mut? (p0 | .. | pn)`, #64106.
 861             Ref(p, m) => self.check_unused_parens_pat(cx, p, true, *m == Mutability::Not),
 862         }
 863     }
 864
 865     fn check_stmt(&mut self, cx: &EarlyContext<'_>, s: &ast::Stmt) {
 866         if let StmtKind::Local(ref local) = s.kind {
 867             self.check_unused_parens_pat(cx, &local.pat, true, false);
 868         }
 869
 870         <Self as UnusedDelimLint>::check_stmt(self, cx, s)
 871     }
 872
 873     fn check_param(&mut self, cx: &EarlyContext<'_>, param: &ast::Param) {
 874         self.check_unused_parens_pat(cx, &param.pat, true, false);
 875     }
 876
 877     fn check_arm(&mut self, cx: &EarlyContext<'_>, arm: &ast::Arm) {
 878         self.check_unused_parens_pat(cx, &arm.pat, false, false);
 879     }
 880
 881     fn check_ty(&mut self, cx: &EarlyContext<'_>, ty: &ast::Ty) {
 882         if let ast::TyKind::Paren(r) = &ty.kind {
 883             match &r.kind {
 884                 ast::TyKind::TraitObject(..) => {}
 885                 ast::TyKind::ImplTrait(_, bounds) if bounds.len() > 1 => {}
 886                 ast::TyKind::Array(_, len) => {
 887                     self.check_unused_delims_expr(
 888                         cx,
 889                         &len.value,
 890                         UnusedDelimsCtx::ArrayLenExpr,
 891                         false,
 892                         None,
 893                         None,
 894                     );
 895                 }
 896                 _ => {
 897                     let spans = if let Some(r) = r.span.find_ancestor_inside(ty.span) {
 898                         Some((ty.span.with_hi(r.lo()), ty.span.with_lo(r.hi())))
 899                     } else {
 900                         None
 901                     };
 902                     self.emit_unused_delims(cx, ty.span, spans, "type", (false, false));
 903                 }
 904             }
 905         }
 906     }
 907
 908     fn check_item(&mut self, cx: &EarlyContext<'_>, item: &ast::Item) {
 909         <Self as UnusedDelimLint>::check_item(self, cx, item)
 910     }
 911 }
 912
 913 declare_lint! {
 914     /// The `unused_braces` lint detects unnecessary braces around an
 915     /// expression.
 916     ///
 917     /// ### Example
 918     ///
 919     /// ```rust
 920     /// if { true } {
 921     ///     // ...
 922     /// }
 923     /// ```
 924     ///
 925     /// {{produces}}
 926     ///
 927     /// ### Explanation
 928     ///
 929     /// The braces are not needed, and should be removed. This is the
 930     /// preferred style for writing these expressions.
 931     pub(super) UNUSED_BRACES,
 932     Warn,
 933     "unnecessary braces around an expression"
 934 }
 935
 936 declare_lint_pass!(UnusedBraces => [UNUSED_BRACES]);
 937
 938 impl UnusedDelimLint for UnusedBraces {
 939     const DELIM_STR: &'static str = "braces";
 940
 941     const LINT_EXPR_IN_PATTERN_MATCHING_CTX: bool = false;
 942
 943     fn lint(&self) -> &'static Lint {
 944         UNUSED_BRACES
 945     }
 946
 947     fn check_unused_delims_expr(
 948         &self,
 949         cx: &EarlyContext<'_>,
 950         value: &ast::Expr,
 951         ctx: UnusedDelimsCtx,
 952         followed_by_block: bool,
 953         left_pos: Option<BytePos>,
 954         right_pos: Option<BytePos>,
 955     ) {
 956         match value.kind {
 957             ast::ExprKind::Block(ref inner, None)
 958                 if inner.rules == ast::BlockCheckMode::Default =>
 959             {
 960                 // emit a warning under the following conditions:
 961                 //
 962                 // - the block does not have a label
 963                 // - the block is not `unsafe`
 964                 // - the block contains exactly one expression (do not lint `{ expr; }`)
 965                 // - `followed_by_block` is true and the internal expr may contain a `{`
 966                 // - the block is not multiline (do not lint multiline match arms)
 967                 //      ```
 968                 //      match expr {
 969                 //          Pattern => {
 970                 //              somewhat_long_expression
 971                 //          }
 972                 //          // ...
 973                 //      }
 974                 //      ```
 975                 // - the block has no attribute and was not created inside a macro
 976                 // - if the block is an `anon_const`, the inner expr must be a literal
 977                 //      (do not lint `struct A<const N: usize>; let _: A<{ 2 + 3 }>;`)
 978                 //
 979                 // FIXME(const_generics): handle paths when #67075 is fixed.
 980                 if let [stmt] = inner.stmts.as_slice() {
 981                     if let ast::StmtKind::Expr(ref expr) = stmt.kind {
 982                         if !Self::is_expr_delims_necessary(expr, followed_by_block, false)
 983                             && (ctx != UnusedDelimsCtx::AnonConst
 984                                 || matches!(expr.kind, ast::ExprKind::Lit(_)))
 985                             && !cx.sess().source_map().is_multiline(value.span)
 986                             && value.attrs.is_empty()
 987                             && !value.span.from_expansion()
 988                         {
 989                             self.emit_unused_delims_expr(cx, value, ctx, left_pos, right_pos)
 990                         }
 991                     }
 992                 }
 993             }
 994             ast::ExprKind::Let(_, ref expr, _) => {
 995                 self.check_unused_delims_expr(
 996                     cx,
 997                     expr,
 998                     UnusedDelimsCtx::LetScrutineeExpr,
 999                     followed_by_block,
1000                     None,
1001                     None,
1002                 );
1003             }
1004             _ => {}
1005         }
1006     }
1007 }
1008
1009 impl EarlyLintPass for UnusedBraces {
1010     fn check_stmt(&mut self, cx: &EarlyContext<'_>, s: &ast::Stmt) {
1011         <Self as UnusedDelimLint>::check_stmt(self, cx, s)
1012     }
1013
1014     fn check_expr(&mut self, cx: &EarlyContext<'_>, e: &ast::Expr) {
1015         <Self as UnusedDelimLint>::check_expr(self, cx, e);
1016
1017         if let ExprKind::Repeat(_, ref anon_const) = e.kind {
1018             self.check_unused_delims_expr(
1019                 cx,
1020                 &anon_const.value,
1021                 UnusedDelimsCtx::AnonConst,
1022                 false,
1023                 None,
1024                 None,
1025             );
1026         }
1027     }
1028
1029     fn check_generic_arg(&mut self, cx: &EarlyContext<'_>, arg: &ast::GenericArg) {
1030         if let ast::GenericArg::Const(ct) = arg {
1031             self.check_unused_delims_expr(
1032                 cx,
1033                 &ct.value,
1034                 UnusedDelimsCtx::AnonConst,
1035                 false,
1036                 None,
1037                 None,
1038             );
1039         }
1040     }
1041
1042     fn check_variant(&mut self, cx: &EarlyContext<'_>, v: &ast::Variant) {
1043         if let Some(anon_const) = &v.disr_expr {
1044             self.check_unused_delims_expr(
1045                 cx,
1046                 &anon_const.value,
1047                 UnusedDelimsCtx::AnonConst,
1048                 false,
1049                 None,
1050                 None,
1051             );
1052         }
1053     }
1054
1055     fn check_ty(&mut self, cx: &EarlyContext<'_>, ty: &ast::Ty) {
1056         match ty.kind {
1057             ast::TyKind::Array(_, ref len) => {
1058                 self.check_unused_delims_expr(
1059                     cx,
1060                     &len.value,
1061                     UnusedDelimsCtx::ArrayLenExpr,
1062                     false,
1063                     None,
1064                     None,
1065                 );
1066             }
1067
1068             ast::TyKind::Typeof(ref anon_const) => {
1069                 self.check_unused_delims_expr(
1070                     cx,
1071                     &anon_const.value,
1072                     UnusedDelimsCtx::AnonConst,
1073                     false,
1074                     None,
1075                     None,
1076                 );
1077             }
1078
1079             _ => {}
1080         }
1081     }
1082
1083     fn check_item(&mut self, cx: &EarlyContext<'_>, item: &ast::Item) {
1084         <Self as UnusedDelimLint>::check_item(self, cx, item)
1085     }
1086 }
1087
1088 declare_lint! {
1089     /// The `unused_import_braces` lint catches unnecessary braces around an
1090     /// imported item.
1091     ///
1092     /// ### Example
1093     ///
1094     /// ```rust,compile_fail
1095     /// #![deny(unused_import_braces)]
1096     /// use test::{A};
1097     ///
1098     /// pub mod test {
1099     ///     pub struct A;
1100     /// }
1101     /// # fn main() {}
1102     /// ```
1103     ///
1104     /// {{produces}}
1105     ///
1106     /// ### Explanation
1107     ///
1108     /// If there is only a single item, then remove the braces (`use test::A;`
1109     /// for example).
1110     ///
1111     /// This lint is "allow" by default because it is only enforcing a
1112     /// stylistic choice.
1113     UNUSED_IMPORT_BRACES,
1114     Allow,
1115     "unnecessary braces around an imported item"
1116 }
1117
1118 declare_lint_pass!(UnusedImportBraces => [UNUSED_IMPORT_BRACES]);
1119
1120 impl UnusedImportBraces {
1121     fn check_use_tree(&self, cx: &EarlyContext<'_>, use_tree: &ast::UseTree, item: &ast::Item) {
1122         if let ast::UseTreeKind::Nested(ref items) = use_tree.kind {
1123             // Recursively check nested UseTrees
1124             for &(ref tree, _) in items {
1125                 self.check_use_tree(cx, tree, item);
1126             }
1127
1128             // Trigger the lint only if there is one nested item
1129             if items.len() != 1 {
1130                 return;
1131             }
1132
1133             // Trigger the lint if the nested item is a non-self single item
1134             let node_name = match items[0].0.kind {
1135                 ast::UseTreeKind::Simple(rename, ..) => {
1136                     let orig_ident = items[0].0.prefix.segments.last().unwrap().ident;
1137                     if orig_ident.name == kw::SelfLower {
1138                         return;
1139                     }
1140                     rename.unwrap_or(orig_ident).name
1141                 }
1142                 ast::UseTreeKind::Glob => Symbol::intern("*"),
1143                 ast::UseTreeKind::Nested(_) => return,
1144             };
1145
1146             cx.struct_span_lint(
1147                 UNUSED_IMPORT_BRACES,
1148                 item.span,
1149                 fluent::lint_unused_import_braces,
1150                 |lint| lint.set_arg("node", node_name),
1151             );
1152         }
1153     }
1154 }
1155
1156 impl EarlyLintPass for UnusedImportBraces {
1157     fn check_item(&mut self, cx: &EarlyContext<'_>, item: &ast::Item) {
1158         if let ast::ItemKind::Use(ref use_tree) = item.kind {
1159             self.check_use_tree(cx, use_tree, item);
1160         }
1161     }
1162 }
1163
1164 declare_lint! {
1165     /// The `unused_allocation` lint detects unnecessary allocations that can
1166     /// be eliminated.
1167     ///
1168     /// ### Example
1169     ///
1170     /// ```rust
1171     /// #![feature(box_syntax)]
1172     /// fn main() {
1173     ///     let a = (box [1, 2, 3]).len();
1174     /// }
1175     /// ```
1176     ///
1177     /// {{produces}}
1178     ///
1179     /// ### Explanation
1180     ///
1181     /// When a `box` expression is immediately coerced to a reference, then
1182     /// the allocation is unnecessary, and a reference (using `&` or `&mut`)
1183     /// should be used instead to avoid the allocation.
1184     pub(super) UNUSED_ALLOCATION,
1185     Warn,
1186     "detects unnecessary allocations that can be eliminated"
1187 }
1188
1189 declare_lint_pass!(UnusedAllocation => [UNUSED_ALLOCATION]);
1190
1191 impl<'tcx> LateLintPass<'tcx> for UnusedAllocation {
1192     fn check_expr(&mut self, cx: &LateContext<'_>, e: &hir::Expr<'_>) {
1193         match e.kind {
1194             hir::ExprKind::Box(_) => {}
1195             _ => return,
1196         }
1197
1198         for adj in cx.typeck_results().expr_adjustments(e) {
1199             if let adjustment::Adjust::Borrow(adjustment::AutoBorrow::Ref(_, m)) = adj.kind {
1200                 cx.struct_span_lint(
1201                     UNUSED_ALLOCATION,
1202                     e.span,
1203                     match m {
1204                         adjustment::AutoBorrowMutability::Not => fluent::lint_unused_allocation,
1205                         adjustment::AutoBorrowMutability::Mut { .. } => {
1206                             fluent::lint_unused_allocation_mut
1207                         }
1208                     },
1209                     |lint| lint,
1210                 );
1211             }
1212         }
1213     }
1214 }