rust/clippy_lints/src/let_if_seq.rs

163 lines
5.9 KiB
Rust
Raw Normal View History

use clippy_utils::diagnostics::span_lint_and_then;
use clippy_utils::source::snippet;
2021-03-16 11:06:34 -05:00
use clippy_utils::{path_to_local_id, visitors::LocalUsedVisitor};
2018-11-27 14:14:15 -06:00
use if_chain::if_chain;
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! {
/// ### What it does
/// Checks for variable declarations immediately followed by a
/// conditional affectation.
///
/// ### Why is this bad?
/// This is not idiomatic Rust.
///
/// ### 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,
nursery,
"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
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() {
if_chain! {
if let Some(expr) = it.peek();
if let hir::StmtKind::Local(local) = stmt.kind;
2019-09-27 10:16:06 -05:00
if let hir::PatKind::Binding(mode, canonical_id, ident, None) = local.pat.kind;
if let hir::StmtKind::Expr(if_) = expr.kind;
if let hir::ExprKind::If(cond, then, ref else_) = if_.kind;
let mut used_visitor = LocalUsedVisitor::new(cx, canonical_id);
if !used_visitor.check_expr(cond);
if let hir::ExprKind::Block(then, _) = then.kind;
if let Some(value) = check_assign(cx, canonical_id, &*then);
if !used_visitor.check_expr(value);
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(
cx.tcx.at(span),
cx.param_env,
);
if has_interior_mutability { return; }
let (default_multi_stmts, default) = if let Some(else_) = *else_ {
if let hir::ExprKind::Block(else_, _) = else_.kind {
if let Some(default) = check_assign(cx, canonical_id, else_) {
(else_.stmts.len() > 1, default)
} else if let Some(default) = local.init {
(true, default)
} else {
continue;
}
2016-03-30 12:53:43 -05:00
} else {
continue;
}
} else if let Some(default) = local.init {
(false, default)
2016-03-30 12:53:43 -05:00
} else {
continue;
};
2017-11-04 14:55:56 -05:00
let mutability = match mode {
BindingAnnotation::RefMut | BindingAnnotation::Mutable => "<mut> ",
_ => "",
};
2017-11-04 14:55:56 -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
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,
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",
|diag| {
diag.span_suggestion(
2018-09-18 10:07:54 -05:00
span,
"it is more idiomatic to write",
sug,
Applicability::HasPlaceholders,
2018-09-18 10:07:54 -05:00
);
if !mutability.is_empty() {
diag.note("you might not need `mut` at all");
}
});
}
}
2016-03-30 12:53:43 -05:00
}
}
}
fn check_assign<'tcx>(
cx: &LateContext<'tcx>,
decl: hir::HirId,
block: &'tcx hir::Block<'_>,
) -> Option<&'tcx hir::Expr<'tcx>> {
if_chain! {
if block.expr.is_none();
if let Some(expr) = block.stmts.iter().last();
if let hir::StmtKind::Semi(expr) = expr.kind;
if let hir::ExprKind::Assign(var, value, _) = expr.kind;
2021-02-01 19:22:31 -06:00
if path_to_local_id(var, decl);
then {
let mut v = LocalUsedVisitor::new(cx, decl);
2017-11-04 14:55:56 -05:00
if block.stmts.iter().take(block.stmts.len()-1).any(|stmt| v.check_stmt(stmt)) {
return None;
}
2017-11-04 14:55:56 -05:00
return Some(value);
2016-03-30 12:53:43 -05:00
}
}
2016-03-30 12:53:43 -05:00
None
}