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