2021-03-16 00:55:45 +00:00
|
|
|
use clippy_utils::diagnostics::{span_lint, span_lint_and_sugg};
|
2021-03-14 23:17:44 +00:00
|
|
|
use clippy_utils::source::snippet_block_with_applicability;
|
2021-03-13 23:01:03 +00:00
|
|
|
use clippy_utils::ty::implements_trait;
|
2021-03-16 16:06:34 +00:00
|
|
|
use clippy_utils::{differing_macro_contexts, get_parent_expr};
|
2021-02-14 15:21:12 +00:00
|
|
|
use if_chain::if_chain;
|
2020-02-04 15:08:15 +00:00
|
|
|
use rustc_errors::Applicability;
|
2020-01-09 07:13:22 +00:00
|
|
|
use rustc_hir::intravisit::{walk_expr, NestedVisitorMap, Visitor};
|
2020-02-21 08:39:38 +00:00
|
|
|
use rustc_hir::{BlockCheckMode, Expr, ExprKind};
|
2020-01-12 06:08:41 +00:00
|
|
|
use rustc_lint::{LateContext, LateLintPass, LintContext};
|
2020-03-30 09:02:14 +00:00
|
|
|
use rustc_middle::hir::map::Map;
|
|
|
|
use rustc_middle::lint::in_external_macro;
|
2020-01-11 11:37:08 +00:00
|
|
|
use rustc_session::{declare_lint_pass, declare_tool_lint};
|
2021-03-12 17:09:19 +00:00
|
|
|
use rustc_span::sym;
|
2015-11-20 05:22:52 +00:00
|
|
|
|
2018-03-28 13:24:26 +00:00
|
|
|
declare_clippy_lint! {
|
2020-05-17 15:36:26 +00:00
|
|
|
/// **What it does:** Checks for `if` conditions that use blocks containing an
|
|
|
|
/// expression, statements or conditions that use closures with blocks.
|
2019-03-05 16:50:33 +00:00
|
|
|
///
|
2020-05-17 15:36:26 +00:00
|
|
|
/// **Why is this bad?** Style, using blocks in the condition makes it hard to read.
|
2019-03-05 16:50:33 +00:00
|
|
|
///
|
|
|
|
/// **Known problems:** None.
|
|
|
|
///
|
2020-05-17 15:36:26 +00:00
|
|
|
/// **Examples:**
|
2019-03-05 16:50:33 +00:00
|
|
|
/// ```rust
|
2020-05-17 15:36:26 +00:00
|
|
|
/// // Bad
|
2019-03-05 22:23:50 +00:00
|
|
|
/// if { true } { /* ... */ }
|
2020-05-17 15:36:26 +00:00
|
|
|
///
|
|
|
|
/// // Good
|
|
|
|
/// if true { /* ... */ }
|
2019-03-05 16:50:33 +00:00
|
|
|
/// ```
|
|
|
|
///
|
2020-05-17 15:36:26 +00:00
|
|
|
/// // or
|
2019-03-05 16:50:33 +00:00
|
|
|
///
|
2020-05-17 15:36:26 +00:00
|
|
|
/// ```rust
|
|
|
|
/// # fn somefunc() -> bool { true };
|
|
|
|
/// // Bad
|
|
|
|
/// if { let x = somefunc(); x } { /* ... */ }
|
|
|
|
///
|
|
|
|
/// // Good
|
|
|
|
/// let res = { let x = somefunc(); x };
|
|
|
|
/// if res { /* ... */ }
|
2019-03-05 16:50:33 +00:00
|
|
|
/// ```
|
2020-05-17 15:36:26 +00:00
|
|
|
pub BLOCKS_IN_IF_CONDITIONS,
|
2018-03-28 13:24:26 +00:00
|
|
|
style,
|
2020-05-17 15:36:26 +00:00
|
|
|
"useless or complex blocks that can be eliminated in conditions"
|
2015-11-20 05:22:52 +00:00
|
|
|
}
|
|
|
|
|
2020-05-17 15:36:26 +00:00
|
|
|
declare_lint_pass!(BlocksInIfConditions => [BLOCKS_IN_IF_CONDITIONS]);
|
2015-11-20 05:22:52 +00:00
|
|
|
|
2019-06-19 18:36:23 +00:00
|
|
|
struct ExVisitor<'a, 'tcx> {
|
2019-12-27 07:12:26 +00:00
|
|
|
found_block: Option<&'tcx Expr<'tcx>>,
|
2020-06-25 20:41:36 +00:00
|
|
|
cx: &'a LateContext<'tcx>,
|
2015-11-20 05:22:52 +00:00
|
|
|
}
|
|
|
|
|
2019-06-19 18:36:23 +00:00
|
|
|
impl<'a, 'tcx> Visitor<'tcx> for ExVisitor<'a, 'tcx> {
|
2020-01-09 07:13:22 +00:00
|
|
|
type Map = Map<'tcx>;
|
|
|
|
|
2019-12-27 07:12:26 +00:00
|
|
|
fn visit_expr(&mut self, expr: &'tcx Expr<'tcx>) {
|
2019-09-27 15:16:06 +00:00
|
|
|
if let ExprKind::Closure(_, _, eid, _, _) = expr.kind {
|
2021-02-14 15:21:12 +00:00
|
|
|
// do not lint if the closure is called using an iterator (see #1141)
|
|
|
|
if_chain! {
|
|
|
|
if let Some(parent) = get_parent_expr(self.cx, expr);
|
|
|
|
if let ExprKind::MethodCall(_, _, args, _) = parent.kind;
|
|
|
|
let caller = self.cx.typeck_results().expr_ty(&args[0]);
|
2021-03-12 17:09:19 +00:00
|
|
|
if let Some(iter_id) = self.cx.tcx.get_diagnostic_item(sym::Iterator);
|
2021-02-14 15:21:12 +00:00
|
|
|
if implements_trait(self.cx, caller, iter_id, &[]);
|
|
|
|
then {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-12-08 00:56:03 +00:00
|
|
|
let body = self.cx.tcx.hir().body(eid);
|
2017-01-04 23:48:34 +00:00
|
|
|
let ex = &body.value;
|
2019-09-27 15:16:06 +00:00
|
|
|
if matches!(ex.kind, ExprKind::Block(_, _)) && !body.value.span.from_expansion() {
|
2017-01-04 23:48:34 +00:00
|
|
|
self.found_block = Some(ex);
|
2015-11-20 05:22:52 +00:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
walk_expr(self, expr);
|
|
|
|
}
|
2020-03-15 22:41:20 +00:00
|
|
|
fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
|
2017-05-12 10:02:42 +00:00
|
|
|
NestedVisitorMap::None
|
2016-12-06 10:32:21 +00:00
|
|
|
}
|
2015-11-20 05:22:52 +00:00
|
|
|
}
|
|
|
|
|
2017-10-20 12:41:24 +00:00
|
|
|
const BRACED_EXPR_MESSAGE: &str = "omit braces around single expression condition";
|
2020-01-06 06:30:43 +00:00
|
|
|
const COMPLEX_BLOCK_MESSAGE: &str = "in an `if` condition, avoid complex blocks or closures with blocks; \
|
2020-05-17 15:36:26 +00:00
|
|
|
instead, move the block or closure higher and bind it with a `let`";
|
2015-11-20 05:22:52 +00:00
|
|
|
|
2020-06-25 20:41:36 +00:00
|
|
|
impl<'tcx> LateLintPass<'tcx> for BlocksInIfConditions {
|
|
|
|
fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
|
2019-08-27 07:43:03 +00:00
|
|
|
if in_external_macro(cx.sess(), expr.span) {
|
|
|
|
return;
|
|
|
|
}
|
2021-01-01 18:38:11 +00:00
|
|
|
if let ExprKind::If(cond, _, _) = &expr.kind {
|
2020-02-04 15:08:15 +00:00
|
|
|
if let ExprKind::Block(block, _) = &cond.kind {
|
2020-01-06 16:39:50 +00:00
|
|
|
if block.rules == BlockCheckMode::DefaultBlock {
|
2015-12-23 01:12:08 +00:00
|
|
|
if block.stmts.is_empty() {
|
2018-12-29 16:32:09 +00:00
|
|
|
if let Some(ex) = &block.expr {
|
2015-12-23 01:12:08 +00:00
|
|
|
// don't dig into the expression here, just suggest that they remove
|
|
|
|
// the block
|
2019-08-19 16:30:32 +00:00
|
|
|
if expr.span.from_expansion() || differing_macro_contexts(expr.span, ex.span) {
|
2016-01-02 16:11:48 +00:00
|
|
|
return;
|
|
|
|
}
|
2020-02-04 15:08:15 +00:00
|
|
|
let mut applicability = Applicability::MachineApplicable;
|
|
|
|
span_lint_and_sugg(
|
2017-08-09 07:30:56 +00:00
|
|
|
cx,
|
2020-05-17 15:36:26 +00:00
|
|
|
BLOCKS_IN_IF_CONDITIONS,
|
2020-02-04 15:08:15 +00:00
|
|
|
cond.span,
|
2017-08-09 07:30:56 +00:00
|
|
|
BRACED_EXPR_MESSAGE,
|
2020-02-04 15:08:15 +00:00
|
|
|
"try",
|
|
|
|
format!(
|
|
|
|
"{}",
|
|
|
|
snippet_block_with_applicability(
|
|
|
|
cx,
|
|
|
|
ex.span,
|
|
|
|
"..",
|
|
|
|
Some(expr.span),
|
|
|
|
&mut applicability
|
|
|
|
)
|
2017-11-04 19:55:56 +00:00
|
|
|
),
|
2020-02-04 15:08:15 +00:00
|
|
|
applicability,
|
2017-08-09 07:30:56 +00:00
|
|
|
);
|
2015-12-23 01:12:08 +00:00
|
|
|
}
|
|
|
|
} else {
|
2018-11-27 20:14:15 +00:00
|
|
|
let span = block.expr.as_ref().map_or_else(|| block.stmts[0].span, |e| e.span);
|
2019-08-19 16:30:32 +00:00
|
|
|
if span.from_expansion() || differing_macro_contexts(expr.span, span) {
|
2016-01-02 16:11:48 +00:00
|
|
|
return;
|
|
|
|
}
|
2015-12-23 01:12:08 +00:00
|
|
|
// move block higher
|
2020-02-04 15:08:15 +00:00
|
|
|
let mut applicability = Applicability::MachineApplicable;
|
|
|
|
span_lint_and_sugg(
|
2017-08-09 07:30:56 +00:00
|
|
|
cx,
|
2020-05-17 15:36:26 +00:00
|
|
|
BLOCKS_IN_IF_CONDITIONS,
|
2020-02-04 15:08:15 +00:00
|
|
|
expr.span.with_hi(cond.span.hi()),
|
2017-08-09 07:30:56 +00:00
|
|
|
COMPLEX_BLOCK_MESSAGE,
|
2020-02-04 15:08:15 +00:00
|
|
|
"try",
|
|
|
|
format!(
|
|
|
|
"let res = {}; if res",
|
|
|
|
snippet_block_with_applicability(
|
|
|
|
cx,
|
|
|
|
block.span,
|
|
|
|
"..",
|
|
|
|
Some(expr.span),
|
|
|
|
&mut applicability
|
|
|
|
),
|
2017-11-04 19:55:56 +00:00
|
|
|
),
|
2020-02-04 15:08:15 +00:00
|
|
|
applicability,
|
2017-08-09 07:30:56 +00:00
|
|
|
);
|
2015-11-20 05:22:52 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
} else {
|
2018-11-27 20:14:15 +00:00
|
|
|
let mut visitor = ExVisitor { found_block: None, cx };
|
2020-02-04 15:08:15 +00:00
|
|
|
walk_expr(&mut visitor, cond);
|
2016-08-01 14:59:14 +00:00
|
|
|
if let Some(block) = visitor.found_block {
|
2020-05-17 15:36:26 +00:00
|
|
|
span_lint(cx, BLOCKS_IN_IF_CONDITIONS, block.span, COMPLEX_BLOCK_MESSAGE);
|
2015-11-20 05:22:52 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|