rust-clippy/clippy_lints/src/collapsible_if.rs

171 lines
5.1 KiB
Rust
Raw Normal View History

//! Checks for if expressions that contain only an if expression.
//!
//! For example, the lint would catch:
//!
2016-12-21 09:00:13 +00:00
//! ```rust,ignore
//! if x {
//! if y {
//! println!("Hello world");
//! }
//! }
//! ```
//!
//! This lint is **warn** by default
2018-11-27 20:14:15 +00:00
use if_chain::if_chain;
2020-03-01 03:23:33 +00:00
use rustc_ast::ast;
2020-01-12 06:08:41 +00:00
use rustc_lint::{EarlyContext, EarlyLintPass};
2020-01-11 11:37:08 +00:00
use rustc_session::{declare_lint_pass, declare_tool_lint};
2018-11-27 20:14:15 +00:00
use crate::utils::sugg::Sugg;
2019-08-19 16:30:32 +00:00
use crate::utils::{snippet_block, snippet_block_with_applicability, span_lint_and_sugg, span_lint_and_then};
use rustc_errors::Applicability;
2018-03-28 13:24:26 +00:00
declare_clippy_lint! {
/// **What it does:** Checks for nested `if` statements which can be collapsed
/// by `&&`-combining their conditions and for `else { if ... }` expressions
/// that
/// can be collapsed to `else if ...`.
///
/// **Why is this bad?** Each `if`-statement adds one level of nesting, which
/// makes code look more complex than it really is.
///
/// **Known problems:** None.
///
/// **Example:**
/// ```rust,ignore
/// if x {
/// if y {
/// …
/// }
/// }
///
/// // or
///
/// if x {
/// …
/// } else {
/// if y {
/// …
/// }
/// }
/// ```
///
/// Should be written:
///
/// ```rust.ignore
/// if x && y {
/// …
/// }
///
/// // or
///
/// if x {
/// …
/// } else if y {
/// …
/// }
/// ```
pub COLLAPSIBLE_IF,
2018-03-28 13:24:26 +00:00
style,
2019-01-31 01:15:29 +00:00
"`if`s that can be collapsed (e.g., `if x { if y { ... } }` and `else { if x { ... } }`)"
}
2019-04-08 20:43:55 +00:00
declare_lint_pass!(CollapsibleIf => [COLLAPSIBLE_IF]);
impl EarlyLintPass for CollapsibleIf {
2018-07-23 11:01:12 +00:00
fn check_expr(&mut self, cx: &EarlyContext<'_>, expr: &ast::Expr) {
2019-08-19 16:30:32 +00:00
if !expr.span.from_expansion() {
2015-09-17 05:27:18 +00:00
check_if(cx, expr)
}
}
}
2018-07-23 11:01:12 +00:00
fn check_if(cx: &EarlyContext<'_>, expr: &ast::Expr) {
2019-09-27 15:16:06 +00:00
if let ast::ExprKind::If(check, then, else_) = &expr.kind {
if let Some(else_) = else_ {
check_collapsible_maybe_if_let(cx, else_);
2019-09-27 15:16:06 +00:00
} else if let ast::ExprKind::Let(..) = check.kind {
// Prevent triggering on `if let a = b { if c { .. } }`.
} else {
check_collapsible_no_if_let(cx, expr, check, then);
}
}
}
2018-10-16 20:20:27 +00:00
fn block_starts_with_comment(cx: &EarlyContext<'_>, expr: &ast::Block) -> bool {
// We trim all opening braces and whitespaces and then check if the next string is a comment.
let trimmed_block_text = snippet_block(cx, expr.span, "..", None)
.trim_start_matches(|c: char| c.is_whitespace() || c == '{')
2018-11-27 20:14:15 +00:00
.to_owned();
trimmed_block_text.starts_with("//") || trimmed_block_text.starts_with("/*")
2018-10-16 20:20:27 +00:00
}
2018-07-23 11:01:12 +00:00
fn check_collapsible_maybe_if_let(cx: &EarlyContext<'_>, else_: &ast::Expr) {
if_chain! {
2019-09-27 15:16:06 +00:00
if let ast::ExprKind::Block(ref block, _) = else_.kind;
2018-10-16 20:20:27 +00:00
if !block_starts_with_comment(cx, block);
if let Some(else_) = expr_block(block);
2019-08-19 16:30:32 +00:00
if !else_.span.from_expansion();
2019-09-27 15:16:06 +00:00
if let ast::ExprKind::If(..) = else_.kind;
then {
let mut applicability = Applicability::MachineApplicable;
span_lint_and_sugg(
cx,
COLLAPSIBLE_IF,
block.span,
"this `else { if .. }` block can be collapsed",
"try",
snippet_block_with_applicability(cx, else_.span, "..", Some(block.span), &mut applicability).into_owned(),
applicability,
);
2016-01-04 04:26:12 +00:00
}
}
}
2018-07-23 11:01:12 +00:00
fn check_collapsible_no_if_let(cx: &EarlyContext<'_>, expr: &ast::Expr, check: &ast::Expr, then: &ast::Block) {
if_chain! {
2018-10-16 20:20:27 +00:00
if !block_starts_with_comment(cx, then);
if let Some(inner) = expr_block(then);
2019-09-27 15:16:06 +00:00
if let ast::ExprKind::If(ref check_inner, ref content, None) = inner.kind;
then {
2019-09-27 15:16:06 +00:00
if let ast::ExprKind::Let(..) = check_inner.kind {
// Prevent triggering on `if c { if let a = b { .. } }`.
return;
}
if expr.span.ctxt() != inner.span.ctxt() {
return;
}
2020-01-06 06:30:43 +00:00
span_lint_and_then(cx, COLLAPSIBLE_IF, expr.span, "this `if` statement can be collapsed", |db| {
let lhs = Sugg::ast(cx, check, "..");
let rhs = Sugg::ast(cx, check_inner, "..");
db.span_suggestion(
2018-09-18 15:07:54 +00:00
expr.span,
"try",
format!(
"if {} {}",
lhs.and(&rhs),
snippet_block(cx, content.span, "..", Some(expr.span)),
2018-09-18 15:07:54 +00:00
),
Applicability::MachineApplicable, // snippet
2018-09-18 15:07:54 +00:00
);
});
}
}
}
2016-12-21 09:00:13 +00:00
/// If the block contains only one expression, return it.
fn expr_block(block: &ast::Block) -> Option<&ast::Expr> {
let mut it = block.stmts.iter();
if let (Some(stmt), None) = (it.next(), it.next()) {
2019-09-27 15:16:06 +00:00
match stmt.kind {
2017-09-05 09:33:04 +00:00
ast::StmtKind::Expr(ref expr) | ast::StmtKind::Semi(ref expr) => Some(expr),
_ => None,
2016-01-04 04:26:12 +00:00
}
} else {
None
}
}