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