2019-09-18 17:29:04 +00:00
|
|
|
use crate::utils::{higher, qpath_res, snippet, span_lint_and_then};
|
2018-11-27 20:14:15 +00:00
|
|
|
use if_chain::if_chain;
|
2019-12-03 23:16:03 +00:00
|
|
|
use rustc::declare_lint_pass;
|
2018-12-29 15:04:45 +00:00
|
|
|
use rustc::hir;
|
2019-05-04 00:03:12 +00:00
|
|
|
use rustc::hir::def::Res;
|
2018-12-29 15:04:45 +00:00
|
|
|
use rustc::hir::BindingAnnotation;
|
|
|
|
use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
|
|
|
|
use rustc_errors::Applicability;
|
2019-12-03 23:16:03 +00:00
|
|
|
use rustc_session::declare_tool_lint;
|
2016-03-30 17:53:43 +00:00
|
|
|
|
2018-03-28 13:24:26 +00:00
|
|
|
declare_clippy_lint! {
|
2019-03-05 16:50:33 +00: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 17:53:43 +00:00
|
|
|
pub USELESS_LET_IF_SEQ,
|
2018-03-28 13:24:26 +00:00
|
|
|
style,
|
2016-08-06 08:18:36 +00:00
|
|
|
"unidiomatic `let mut` declaration followed by initialization in `if`"
|
2016-03-30 17:53:43 +00:00
|
|
|
}
|
|
|
|
|
2019-04-08 20:43:55 +00:00
|
|
|
declare_lint_pass!(LetIfSeq => [USELESS_LET_IF_SEQ]);
|
2016-03-30 17:53:43 +00:00
|
|
|
|
2016-12-07 12:13:40 +00:00
|
|
|
impl<'a, 'tcx> LateLintPass<'a, 'tcx> for LetIfSeq {
|
|
|
|
fn check_block(&mut self, cx: &LateContext<'a, 'tcx>, block: &'tcx hir::Block) {
|
2016-03-30 17:53:43 +00:00
|
|
|
let mut it = block.stmts.iter().peekable();
|
2016-08-01 14:59:14 +00:00
|
|
|
while let Some(stmt) = it.next() {
|
2017-10-23 19:18:02 +00:00
|
|
|
if_chain! {
|
|
|
|
if let Some(expr) = it.peek();
|
2019-09-27 15:16:06 +00: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;
|
2019-05-11 02:34:47 +00:00
|
|
|
if let Some((ref cond, ref then, ref else_)) = higher::if_block(&if_);
|
2017-10-23 19:18:02 +00:00
|
|
|
if !used_in_expr(cx, canonical_id, cond);
|
2019-09-27 15:16:06 +00:00
|
|
|
if let hir::ExprKind::Block(ref then, _) = then.kind;
|
2017-10-23 19:18:02 +00:00
|
|
|
if let Some(value) = check_assign(cx, canonical_id, &*then);
|
|
|
|
if !used_in_expr(cx, canonical_id, value);
|
|
|
|
then {
|
|
|
|
let span = stmt.span.to(if_.span);
|
2017-11-04 19:55:56 +00:00
|
|
|
|
2019-04-26 02:07:01 +00:00
|
|
|
let has_interior_mutability = !cx.tables.node_type(canonical_id).is_freeze(
|
|
|
|
cx.tcx,
|
|
|
|
cx.param_env,
|
|
|
|
span
|
|
|
|
);
|
|
|
|
if has_interior_mutability { return; }
|
|
|
|
|
2017-10-23 19:18:02 +00:00
|
|
|
let (default_multi_stmts, default) = if let Some(ref else_) = *else_ {
|
2019-09-27 15:16:06 +00:00
|
|
|
if let hir::ExprKind::Block(ref else_, _) = else_.kind {
|
2017-10-23 19:18:02 +00:00
|
|
|
if let Some(default) = check_assign(cx, canonical_id, else_) {
|
|
|
|
(else_.stmts.len() > 1, default)
|
2019-01-20 10:21:30 +00:00
|
|
|
} else if let Some(ref default) = local.init {
|
2017-10-23 19:18:02 +00:00
|
|
|
(true, &**default)
|
|
|
|
} else {
|
|
|
|
continue;
|
|
|
|
}
|
2016-03-30 17:53:43 +00:00
|
|
|
} else {
|
|
|
|
continue;
|
|
|
|
}
|
2019-01-20 10:21:30 +00:00
|
|
|
} else if let Some(ref default) = local.init {
|
2017-10-23 19:18:02 +00:00
|
|
|
(false, &**default)
|
2016-03-30 17:53:43 +00:00
|
|
|
} else {
|
|
|
|
continue;
|
2017-10-23 19:18:02 +00:00
|
|
|
};
|
2017-11-04 19:55:56 +00:00
|
|
|
|
2017-10-23 19:18:02 +00:00
|
|
|
let mutability = match mode {
|
|
|
|
BindingAnnotation::RefMut | BindingAnnotation::Mutable => "<mut> ",
|
|
|
|
_ => "",
|
|
|
|
};
|
2017-11-04 19:55:56 +00:00
|
|
|
|
2017-10-23 19:18:02 +00:00
|
|
|
// FIXME: this should not suggest `mut` if we can detect that the variable is not
|
|
|
|
// use mutably after the `if`
|
2017-11-04 19:55:56 +00:00
|
|
|
|
2017-10-23 19:18:02 +00:00
|
|
|
let sug = format!(
|
|
|
|
"let {mut}{name} = if {cond} {{{then} {value} }} else {{{else} {default} }};",
|
|
|
|
mut=mutability,
|
2018-06-28 13:46:58 +00:00
|
|
|
name=ident.name,
|
2017-10-23 19:18:02 +00: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",
|
|
|
|
|db| {
|
2019-01-27 12:33:56 +00:00
|
|
|
db.span_suggestion(
|
2018-09-18 15:07:54 +00:00
|
|
|
span,
|
|
|
|
"it is more idiomatic to write",
|
|
|
|
sug,
|
2018-09-18 19:43:52 +00:00
|
|
|
Applicability::HasPlaceholders,
|
2018-09-18 15:07:54 +00:00
|
|
|
);
|
2017-10-23 19:18:02 +00:00
|
|
|
if !mutability.is_empty() {
|
|
|
|
db.note("you might not need `mut` at all");
|
|
|
|
}
|
|
|
|
});
|
|
|
|
}
|
|
|
|
}
|
2016-03-30 17:53:43 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-06-19 18:36:23 +00:00
|
|
|
struct UsedVisitor<'a, 'tcx> {
|
2016-03-30 17:53:43 +00:00
|
|
|
cx: &'a LateContext<'a, 'tcx>,
|
2019-03-07 20:51:05 +00:00
|
|
|
id: hir::HirId,
|
2016-03-30 17:53:43 +00:00
|
|
|
used: bool,
|
|
|
|
}
|
|
|
|
|
2016-12-06 10:32:21 +00:00
|
|
|
impl<'a, 'tcx> hir::intravisit::Visitor<'tcx> for UsedVisitor<'a, 'tcx> {
|
|
|
|
fn visit_expr(&mut self, expr: &'tcx hir::Expr) {
|
2017-10-23 19:18:02 +00:00
|
|
|
if_chain! {
|
2019-09-27 15:16:06 +00:00
|
|
|
if let hir::ExprKind::Path(ref qpath) = expr.kind;
|
2019-09-18 17:29:04 +00:00
|
|
|
if let Res::Local(local_id) = qpath_res(self.cx, qpath, expr.hir_id);
|
2019-04-14 20:09:17 +00:00
|
|
|
if self.id == local_id;
|
2017-10-23 19:18:02 +00:00
|
|
|
then {
|
|
|
|
self.used = true;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
}
|
2016-03-30 17:53:43 +00:00
|
|
|
hir::intravisit::walk_expr(self, expr);
|
|
|
|
}
|
2016-12-06 10:32:21 +00:00
|
|
|
fn nested_visit_map<'this>(&'this mut self) -> hir::intravisit::NestedVisitorMap<'this, 'tcx> {
|
2017-05-12 10:02:42 +00:00
|
|
|
hir::intravisit::NestedVisitorMap::None
|
2016-12-06 10:32:21 +00:00
|
|
|
}
|
2016-03-30 17:53:43 +00:00
|
|
|
}
|
|
|
|
|
2016-12-21 11:14:54 +00:00
|
|
|
fn check_assign<'a, 'tcx>(
|
|
|
|
cx: &LateContext<'a, 'tcx>,
|
2019-03-07 20:51:05 +00:00
|
|
|
decl: hir::HirId,
|
2017-08-09 07:30:56 +00:00
|
|
|
block: &'tcx hir::Block,
|
2016-12-21 11:14:54 +00:00
|
|
|
) -> Option<&'tcx hir::Expr> {
|
2017-10-23 19:18:02 +00:00
|
|
|
if_chain! {
|
|
|
|
if block.expr.is_none();
|
|
|
|
if let Some(expr) = block.stmts.iter().last();
|
2019-09-27 15:16:06 +00:00
|
|
|
if let hir::StmtKind::Semi(ref expr) = expr.kind;
|
2019-12-24 04:16:04 +00:00
|
|
|
if let hir::ExprKind::Assign(ref var, ref value, _) = expr.kind;
|
2019-09-27 15:16:06 +00:00
|
|
|
if let hir::ExprKind::Path(ref qpath) = var.kind;
|
2019-09-18 17:29:04 +00:00
|
|
|
if let Res::Local(local_id) = qpath_res(cx, qpath, var.hir_id);
|
2019-04-14 20:09:17 +00:00
|
|
|
if decl == local_id;
|
2017-10-23 19:18:02 +00:00
|
|
|
then {
|
|
|
|
let mut v = UsedVisitor {
|
2018-03-15 15:07:15 +00:00
|
|
|
cx,
|
2017-10-23 19:18:02 +00:00
|
|
|
id: decl,
|
|
|
|
used: false,
|
|
|
|
};
|
2017-11-04 19:55:56 +00:00
|
|
|
|
2017-10-23 19:18:02 +00:00
|
|
|
for s in block.stmts.iter().take(block.stmts.len()-1) {
|
|
|
|
hir::intravisit::walk_stmt(&mut v, s);
|
2017-11-04 19:55:56 +00:00
|
|
|
|
2017-10-23 19:18:02 +00:00
|
|
|
if v.used {
|
|
|
|
return None;
|
|
|
|
}
|
2016-06-03 17:35:39 +00:00
|
|
|
}
|
2017-11-04 19:55:56 +00:00
|
|
|
|
2017-10-23 19:18:02 +00:00
|
|
|
return Some(value);
|
2016-03-30 17:53:43 +00:00
|
|
|
}
|
2017-10-23 19:18:02 +00:00
|
|
|
}
|
2016-03-30 17:53:43 +00:00
|
|
|
|
|
|
|
None
|
|
|
|
}
|
2016-06-05 19:38:15 +00:00
|
|
|
|
2019-06-19 18:36:23 +00:00
|
|
|
fn used_in_expr<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, id: hir::HirId, expr: &'tcx hir::Expr) -> bool {
|
2018-11-27 20:14:15 +00:00
|
|
|
let mut v = UsedVisitor { cx, id, used: false };
|
2016-06-05 19:38:15 +00:00
|
|
|
hir::intravisit::walk_expr(&mut v, expr);
|
|
|
|
v.used
|
|
|
|
}
|