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