2021-03-25 13:29:11 -05:00
|
|
|
use clippy_utils::diagnostics::span_lint_and_then;
|
|
|
|
use clippy_utils::source::snippet;
|
|
|
|
use clippy_utils::{path_to_local_id, visitors::LocalUsedVisitor};
|
2018-11-27 14:14:15 -06:00
|
|
|
use if_chain::if_chain;
|
2018-12-29 09:04:45 -06:00
|
|
|
use rustc_errors::Applicability;
|
2020-01-06 10:39:50 -06:00
|
|
|
use rustc_hir as hir;
|
|
|
|
use rustc_hir::BindingAnnotation;
|
2020-01-12 00:08:41 -06:00
|
|
|
use rustc_lint::{LateContext, LateLintPass};
|
2020-01-11 05:37:08 -06:00
|
|
|
use rustc_session::{declare_lint_pass, declare_tool_lint};
|
2016-03-30 12:53:43 -05:00
|
|
|
|
2018-03-28 08:24:26 -05:00
|
|
|
declare_clippy_lint! {
|
2019-03-05 10:50:33 -06:00
|
|
|
/// **What it does:** Checks for variable declarations immediately followed by a
|
|
|
|
/// conditional affectation.
|
|
|
|
///
|
|
|
|
/// **Why is this bad?** This is not idiomatic Rust.
|
|
|
|
///
|
|
|
|
/// **Known problems:** None.
|
|
|
|
///
|
|
|
|
/// **Example:**
|
|
|
|
/// ```rust,ignore
|
|
|
|
/// let foo;
|
|
|
|
///
|
|
|
|
/// if bar() {
|
|
|
|
/// foo = 42;
|
|
|
|
/// } else {
|
|
|
|
/// foo = 0;
|
|
|
|
/// }
|
|
|
|
///
|
|
|
|
/// let mut baz = None;
|
|
|
|
///
|
|
|
|
/// if bar() {
|
|
|
|
/// baz = Some(42);
|
|
|
|
/// }
|
|
|
|
/// ```
|
|
|
|
///
|
|
|
|
/// should be written
|
|
|
|
///
|
|
|
|
/// ```rust,ignore
|
|
|
|
/// let foo = if bar() {
|
|
|
|
/// 42
|
|
|
|
/// } else {
|
|
|
|
/// 0
|
|
|
|
/// };
|
|
|
|
///
|
|
|
|
/// let baz = if bar() {
|
|
|
|
/// Some(42)
|
|
|
|
/// } else {
|
|
|
|
/// None
|
|
|
|
/// };
|
|
|
|
/// ```
|
2016-03-30 12:53:43 -05:00
|
|
|
pub USELESS_LET_IF_SEQ,
|
2020-05-17 10:36:26 -05:00
|
|
|
nursery,
|
2016-08-06 03:18:36 -05:00
|
|
|
"unidiomatic `let mut` declaration followed by initialization in `if`"
|
2016-03-30 12:53:43 -05:00
|
|
|
}
|
|
|
|
|
2019-04-08 15:43:55 -05:00
|
|
|
declare_lint_pass!(LetIfSeq => [USELESS_LET_IF_SEQ]);
|
2016-03-30 12:53:43 -05:00
|
|
|
|
2020-06-25 15:41:36 -05:00
|
|
|
impl<'tcx> LateLintPass<'tcx> for LetIfSeq {
|
|
|
|
fn check_block(&mut self, cx: &LateContext<'tcx>, block: &'tcx hir::Block<'_>) {
|
2016-03-30 12:53:43 -05:00
|
|
|
let mut it = block.stmts.iter().peekable();
|
2016-08-01 09:59:14 -05:00
|
|
|
while let Some(stmt) = it.next() {
|
2017-10-23 14:18:02 -05:00
|
|
|
if_chain! {
|
|
|
|
if let Some(expr) = it.peek();
|
2019-09-27 10:16:06 -05:00
|
|
|
if let hir::StmtKind::Local(ref local) = stmt.kind;
|
|
|
|
if let hir::PatKind::Binding(mode, canonical_id, ident, None) = local.pat.kind;
|
|
|
|
if let hir::StmtKind::Expr(ref if_) = expr.kind;
|
2021-01-01 12:38:11 -06:00
|
|
|
if let hir::ExprKind::If(ref cond, ref then, ref else_) = if_.kind;
|
2021-02-11 08:04:38 -06:00
|
|
|
let mut used_visitor = LocalUsedVisitor::new(cx, canonical_id);
|
|
|
|
if !used_visitor.check_expr(cond);
|
2019-09-27 10:16:06 -05:00
|
|
|
if let hir::ExprKind::Block(ref then, _) = then.kind;
|
2017-10-23 14:18:02 -05:00
|
|
|
if let Some(value) = check_assign(cx, canonical_id, &*then);
|
2021-02-11 08:04:38 -06:00
|
|
|
if !used_visitor.check_expr(value);
|
2017-10-23 14:18:02 -05:00
|
|
|
then {
|
|
|
|
let span = stmt.span.to(if_.span);
|
2017-11-04 14:55:56 -05:00
|
|
|
|
2020-07-17 03:47:04 -05:00
|
|
|
let has_interior_mutability = !cx.typeck_results().node_type(canonical_id).is_freeze(
|
2020-06-21 04:20:48 -05:00
|
|
|
cx.tcx.at(span),
|
2019-04-25 21:07:01 -05:00
|
|
|
cx.param_env,
|
|
|
|
);
|
|
|
|
if has_interior_mutability { return; }
|
|
|
|
|
2017-10-23 14:18:02 -05:00
|
|
|
let (default_multi_stmts, default) = if let Some(ref else_) = *else_ {
|
2019-09-27 10:16:06 -05:00
|
|
|
if let hir::ExprKind::Block(ref else_, _) = else_.kind {
|
2017-10-23 14:18:02 -05:00
|
|
|
if let Some(default) = check_assign(cx, canonical_id, else_) {
|
|
|
|
(else_.stmts.len() > 1, default)
|
2019-01-20 04:21:30 -06:00
|
|
|
} else if let Some(ref default) = local.init {
|
2017-10-23 14:18:02 -05:00
|
|
|
(true, &**default)
|
|
|
|
} else {
|
|
|
|
continue;
|
|
|
|
}
|
2016-03-30 12:53:43 -05:00
|
|
|
} else {
|
|
|
|
continue;
|
|
|
|
}
|
2019-01-20 04:21:30 -06:00
|
|
|
} else if let Some(ref default) = local.init {
|
2017-10-23 14:18:02 -05:00
|
|
|
(false, &**default)
|
2016-03-30 12:53:43 -05:00
|
|
|
} else {
|
|
|
|
continue;
|
2017-10-23 14:18:02 -05:00
|
|
|
};
|
2017-11-04 14:55:56 -05:00
|
|
|
|
2017-10-23 14:18:02 -05:00
|
|
|
let mutability = match mode {
|
|
|
|
BindingAnnotation::RefMut | BindingAnnotation::Mutable => "<mut> ",
|
|
|
|
_ => "",
|
|
|
|
};
|
2017-11-04 14:55:56 -05:00
|
|
|
|
2017-10-23 14:18:02 -05:00
|
|
|
// FIXME: this should not suggest `mut` if we can detect that the variable is not
|
|
|
|
// use mutably after the `if`
|
2017-11-04 14:55:56 -05:00
|
|
|
|
2017-10-23 14:18:02 -05:00
|
|
|
let sug = format!(
|
|
|
|
"let {mut}{name} = if {cond} {{{then} {value} }} else {{{else} {default} }};",
|
|
|
|
mut=mutability,
|
2018-06-28 08:46:58 -05:00
|
|
|
name=ident.name,
|
2017-10-23 14:18:02 -05:00
|
|
|
cond=snippet(cx, cond.span, "_"),
|
|
|
|
then=if then.stmts.len() > 1 { " ..;" } else { "" },
|
|
|
|
else=if default_multi_stmts { " ..;" } else { "" },
|
|
|
|
value=snippet(cx, value.span, "<value>"),
|
|
|
|
default=snippet(cx, default.span, "<default>"),
|
|
|
|
);
|
|
|
|
span_lint_and_then(cx,
|
|
|
|
USELESS_LET_IF_SEQ,
|
|
|
|
span,
|
|
|
|
"`if _ { .. } else { .. }` is an expression",
|
2020-04-17 01:08:00 -05:00
|
|
|
|diag| {
|
|
|
|
diag.span_suggestion(
|
2018-09-18 10:07:54 -05:00
|
|
|
span,
|
|
|
|
"it is more idiomatic to write",
|
|
|
|
sug,
|
2018-09-18 14:43:52 -05:00
|
|
|
Applicability::HasPlaceholders,
|
2018-09-18 10:07:54 -05:00
|
|
|
);
|
2017-10-23 14:18:02 -05:00
|
|
|
if !mutability.is_empty() {
|
2020-04-17 01:08:00 -05:00
|
|
|
diag.note("you might not need `mut` at all");
|
2017-10-23 14:18:02 -05:00
|
|
|
}
|
|
|
|
});
|
|
|
|
}
|
|
|
|
}
|
2016-03-30 12:53:43 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-06-25 15:41:36 -05:00
|
|
|
fn check_assign<'tcx>(
|
|
|
|
cx: &LateContext<'tcx>,
|
2019-03-07 14:51:05 -06:00
|
|
|
decl: hir::HirId,
|
2019-12-27 01:12:26 -06:00
|
|
|
block: &'tcx hir::Block<'_>,
|
|
|
|
) -> Option<&'tcx hir::Expr<'tcx>> {
|
2017-10-23 14:18:02 -05:00
|
|
|
if_chain! {
|
|
|
|
if block.expr.is_none();
|
|
|
|
if let Some(expr) = block.stmts.iter().last();
|
2019-09-27 10:16:06 -05:00
|
|
|
if let hir::StmtKind::Semi(ref expr) = expr.kind;
|
2019-12-23 22:16:04 -06:00
|
|
|
if let hir::ExprKind::Assign(ref var, ref value, _) = expr.kind;
|
2021-02-11 08:04:38 -06:00
|
|
|
if path_to_local_id(var, decl);
|
2017-10-23 14:18:02 -05:00
|
|
|
then {
|
2021-02-11 08:04:38 -06:00
|
|
|
let mut v = LocalUsedVisitor::new(cx, decl);
|
2017-11-04 14:55:56 -05:00
|
|
|
|
2020-12-06 08:01:03 -06:00
|
|
|
if block.stmts.iter().take(block.stmts.len()-1).any(|stmt| v.check_stmt(stmt)) {
|
|
|
|
return None;
|
2016-06-03 12:35:39 -05:00
|
|
|
}
|
2017-11-04 14:55:56 -05:00
|
|
|
|
2017-10-23 14:18:02 -05:00
|
|
|
return Some(value);
|
2016-03-30 12:53:43 -05:00
|
|
|
}
|
2017-10-23 14:18:02 -05:00
|
|
|
}
|
2016-03-30 12:53:43 -05:00
|
|
|
|
|
|
|
None
|
|
|
|
}
|