Skip to content

Commit 34e654c

Browse files
borsbors
committed
Auto merge of #13733 - WaffleLapkin:remove_parens, r=Veykril
feat: Add "Remove redundant parentheses" assist ![Peek 2022-12-08 22-22](https://user-images.githubusercontent.com/38225716/206542898-d6c97468-d615-4c5b-8650-f89b9c0321a0.gif) Can be quite handy when refactoring :)
2 parents 83e2639 + ba6f0be commit 34e654c

File tree

5 files changed

+226
-0
lines changed

5 files changed

+226
-0
lines changed

‎crates/ide-assists/src/handlers/remove_parentheses.rs

+91
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
use syntax::{ast, AstNode};
2+
3+
use crate::{AssistContext, AssistId, AssistKind, Assists};
4+
5+
// Assist: remove_parentheses
6+
//
7+
// Removes redundant parentheses.
8+
//
9+
// ```
10+
// fn main() {
11+
// _ = $0(2) + 2;
12+
// }
13+
// ```
14+
// ->
15+
// ```
16+
// fn main() {
17+
// _ = 2 + 2;
18+
// }
19+
// ```
20+
pub(crate) fn remove_parentheses(acc: &mut Assists, ctx: &AssistContext<'_>) -> Option<()> {
21+
let parens = ctx.find_node_at_offset::<ast::ParenExpr>()?;
22+
23+
let cursor_in_range =
24+
parens.l_paren_token()?.text_range().contains_range(ctx.selection_trimmed())
25+
|| parens.r_paren_token()?.text_range().contains_range(ctx.selection_trimmed());
26+
if !cursor_in_range {
27+
return None;
28+
}
29+
30+
let expr = parens.expr()?;
31+
32+
let parent = ast::Expr::cast(parens.syntax().parent()?);
33+
let is_ok_to_remove = expr.precedence() >= parent.as_ref().and_then(ast::Expr::precedence);
34+
if !is_ok_to_remove {
35+
return None;
36+
}
37+
38+
let target = parens.syntax().text_range();
39+
acc.add(
40+
AssistId("remove_parentheses", AssistKind::Refactor),
41+
"Remove redundant parentheses",
42+
target,
43+
|builder| builder.replace_ast(parens.into(), expr),
44+
)
45+
}
46+
47+
#[cfg(test)]
48+
mod tests {
49+
use crate::tests::{check_assist, check_assist_not_applicable};
50+
51+
use super::*;
52+
53+
#[test]
54+
fn remove_parens_simple() {
55+
check_assist(remove_parentheses, r#"fn f() { $0(2) + 2; }"#, r#"fn f() { 2 + 2; }"#);
56+
check_assist(remove_parentheses, r#"fn f() { ($02) + 2; }"#, r#"fn f() { 2 + 2; }"#);
57+
check_assist(remove_parentheses, r#"fn f() { (2)$0 + 2; }"#, r#"fn f() { 2 + 2; }"#);
58+
check_assist(remove_parentheses, r#"fn f() { (2$0) + 2; }"#, r#"fn f() { 2 + 2; }"#);
59+
}
60+
61+
#[test]
62+
fn remove_parens_precedence() {
63+
check_assist(
64+
remove_parentheses,
65+
r#"fn f() { $0(2 * 3) + 1; }"#,
66+
r#"fn f() { 2 * 3 + 1; }"#,
67+
);
68+
check_assist(remove_parentheses, r#"fn f() { ( $0(2) ); }"#, r#"fn f() { ( 2 ); }"#);
69+
check_assist(remove_parentheses, r#"fn f() { $0(2?)?; }"#, r#"fn f() { 2??; }"#);
70+
check_assist(remove_parentheses, r#"fn f() { f(($02 + 2)); }"#, r#"fn f() { f(2 + 2); }"#);
71+
check_assist(
72+
remove_parentheses,
73+
r#"fn f() { (1<2)&&$0(3>4); }"#,
74+
r#"fn f() { (1<2)&&3>4; }"#,
75+
);
76+
}
77+
78+
#[test]
79+
fn remove_parens_doesnt_apply_precedence() {
80+
check_assist_not_applicable(remove_parentheses, r#"fn f() { $0(2 + 2) * 8; }"#);
81+
check_assist_not_applicable(remove_parentheses, r#"fn f() { $0(2 + 2).f(); }"#);
82+
check_assist_not_applicable(remove_parentheses, r#"fn f() { $0(2 + 2).await; }"#);
83+
check_assist_not_applicable(remove_parentheses, r#"fn f() { $0!(2..2); }"#);
84+
}
85+
86+
#[test]
87+
fn remove_parens_doesnt_apply_with_cursor_not_on_paren() {
88+
check_assist_not_applicable(remove_parentheses, r#"fn f() { (2 +$0 2) }"#);
89+
check_assist_not_applicable(remove_parentheses, r#"fn f() {$0 (2 + 2) }"#);
90+
}
91+
}

‎crates/ide-assists/src/lib.rs

+2
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,7 @@ mod handlers {
179179
mod remove_dbg;
180180
mod remove_mut;
181181
mod remove_unused_param;
182+
mod remove_parentheses;
182183
mod reorder_fields;
183184
mod reorder_impl_items;
184185
mod replace_try_expr_with_match;
@@ -280,6 +281,7 @@ mod handlers {
280281
remove_dbg::remove_dbg,
281282
remove_mut::remove_mut,
282283
remove_unused_param::remove_unused_param,
284+
remove_parentheses::remove_parentheses,
283285
reorder_fields::reorder_fields,
284286
reorder_impl_items::reorder_impl_items,
285287
replace_try_expr_with_match::replace_try_expr_with_match,

‎crates/ide-assists/src/tests/generated.rs

+17
Original file line numberDiff line numberDiff line change
@@ -1978,6 +1978,23 @@ impl Walrus {
19781978
)
19791979
}
19801980

1981+
#[test]
1982+
fn doctest_remove_parentheses() {
1983+
check_doc_test(
1984+
"remove_parentheses",
1985+
r#####"
1986+
fn main() {
1987+
_ = $0(2) + 2;
1988+
}
1989+
"#####,
1990+
r#####"
1991+
fn main() {
1992+
_ = 2 + 2;
1993+
}
1994+
"#####,
1995+
)
1996+
}
1997+
19811998
#[test]
19821999
fn doctest_remove_unused_param() {
19832000
check_doc_test(

‎crates/syntax/src/ast.rs

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ mod operators;
99
pub mod edit;
1010
pub mod edit_in_place;
1111
pub mod make;
12+
pub mod prec;
1213

1314
use std::marker::PhantomData;
1415

‎crates/syntax/src/ast/prec.rs

+115
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
//! Precedence representation.
2+
3+
use crate::ast::{self, BinExpr, Expr};
4+
5+
/// Precedence of an expression.
6+
#[derive(Debug, Copy, Clone, Ord, PartialOrd, Eq, PartialEq)]
7+
pub enum ExprPrecedence {
8+
// N.B.: Order is important
9+
Closure,
10+
Jump,
11+
Range,
12+
Bin(BinOpPresedence),
13+
Prefix,
14+
Postfix,
15+
Paren,
16+
}
17+
18+
/// Precedence of a binary operator.
19+
#[derive(Debug, Copy, Clone, Ord, PartialOrd, Eq, PartialEq)]
20+
pub enum BinOpPresedence {
21+
// N.B.: Order is important
22+
/// `=`, `+=`, `-=`, `*=`, `/=`, `%=`, `|=`, `&=`
23+
Assign,
24+
/// `||`
25+
LOr,
26+
/// `&&`
27+
LAnd,
28+
/// `<`, `<=`, `>`, `>=`, `==` and `!=`
29+
Cmp,
30+
/// `|`
31+
BitOr,
32+
/// `^`
33+
BitXor,
34+
/// `&`
35+
BitAnd,
36+
/// `<<` and `>>`
37+
Shift,
38+
/// `+` and `-`
39+
Add,
40+
/// `*`, `/` and `%`
41+
Mul,
42+
/// `as`
43+
As,
44+
}
45+
46+
impl Expr {
47+
/// Returns precedence of this expression.
48+
/// Usefull to preserve semantics in assists.
49+
///
50+
/// Returns `None` if this is a [`BinExpr`] and its [`op_kind`] returns `None`.
51+
///
52+
/// [`op_kind`]: BinExpr::op_kind
53+
/// [`BinExpr`]: Expr::BinExpr
54+
pub fn precedence(&self) -> Option<ExprPrecedence> {
55+
// Copied from <https://github.com/rust-lang/rust/blob/b6852428a8ea9728369b64b9964cad8e258403d3/compiler/rustc_ast/src/util/parser.rs#L296>
56+
use Expr::*;
57+
58+
let prec = match self {
59+
ClosureExpr(_) => ExprPrecedence::Closure,
60+
61+
ContinueExpr(_) | ReturnExpr(_) | YieldExpr(_) | BreakExpr(_) => ExprPrecedence::Jump,
62+
63+
RangeExpr(_) => ExprPrecedence::Range,
64+
65+
BinExpr(bin_expr) => return bin_expr.precedence().map(ExprPrecedence::Bin),
66+
CastExpr(_) => ExprPrecedence::Bin(BinOpPresedence::As),
67+
68+
BoxExpr(_) | RefExpr(_) | LetExpr(_) | PrefixExpr(_) => ExprPrecedence::Prefix,
69+
70+
AwaitExpr(_) | CallExpr(_) | MethodCallExpr(_) | FieldExpr(_) | IndexExpr(_)
71+
| TryExpr(_) | MacroExpr(_) => ExprPrecedence::Postfix,
72+
73+
ArrayExpr(_) | TupleExpr(_) | Literal(_) | PathExpr(_) | ParenExpr(_) | IfExpr(_)
74+
| WhileExpr(_) | ForExpr(_) | LoopExpr(_) | MatchExpr(_) | BlockExpr(_)
75+
| RecordExpr(_) | UnderscoreExpr(_) => ExprPrecedence::Paren,
76+
};
77+
78+
Some(prec)
79+
}
80+
}
81+
82+
impl BinExpr {
83+
/// Returns precedence of this binary expression.
84+
/// Usefull to preserve semantics in assists.
85+
///
86+
/// Returns `None` if [`op_kind`] returns `None`.
87+
///
88+
/// [`op_kind`]: BinExpr::op_kind
89+
pub fn precedence(&self) -> Option<BinOpPresedence> {
90+
use ast::{ArithOp::*, BinaryOp::*, LogicOp::*};
91+
92+
let prec = match self.op_kind()? {
93+
LogicOp(op) => match op {
94+
And => BinOpPresedence::LAnd,
95+
Or => BinOpPresedence::LOr,
96+
},
97+
ArithOp(op) => match op {
98+
Add => BinOpPresedence::Add,
99+
Mul => BinOpPresedence::Mul,
100+
Sub => BinOpPresedence::Add,
101+
Div => BinOpPresedence::Mul,
102+
Rem => BinOpPresedence::Mul,
103+
Shl => BinOpPresedence::Shift,
104+
Shr => BinOpPresedence::Shift,
105+
BitXor => BinOpPresedence::BitXor,
106+
BitOr => BinOpPresedence::BitOr,
107+
BitAnd => BinOpPresedence::BitAnd,
108+
},
109+
CmpOp(_) => BinOpPresedence::Cmp,
110+
Assignment { .. } => BinOpPresedence::Assign,
111+
};
112+
113+
Some(prec)
114+
}
115+
}

0 commit comments

Comments
 (0)