use hir::ModuleDef; use ide_db::{ assists::{AssistId, AssistKind}, defs::Definition, helpers::mod_path_to_ast, imports::insert_use::{insert_use, ImportScope}, search::{FileReference, UsageSearchResult}, source_change::SourceChangeBuilder, }; use itertools::Itertools; use syntax::{ ast::{ self, edit::IndentLevel, edit_in_place::{AttrsOwnerEdit, Indent}, make, HasName, }, ted, AstNode, NodeOrToken, SyntaxNode, T, }; use crate::assist_context::{AssistContext, Assists}; // Assist: bool_to_enum // // This converts boolean local variables, fields, constants, and statics into a new // enum with two variants `Bool::True` and `Bool::False`, as well as replacing // all assignments with the variants and replacing all usages with `== Bool::True` or // `== Bool::False`. // // ``` // fn main() { // let $0bool = true; // // if bool { // println!("foo"); // } // } // ``` // -> // ``` // fn main() { // #[derive(PartialEq, Eq)] // enum Bool { True, False } // // let bool = Bool::True; // // if bool == Bool::True { // println!("foo"); // } // } // ``` pub(crate) fn bool_to_enum(acc: &mut Assists, ctx: &AssistContext<'_>) -> Option<()> { let BoolNodeData { target_node, name, ty_annotation, initializer, definition } = find_bool_node(ctx)?; let target_module = ctx.sema.scope(&target_node)?.module(); let target = name.syntax().text_range(); acc.add( AssistId("bool_to_enum", AssistKind::RefactorRewrite), "Convert boolean to enum", target, |edit| { if let Some(ty) = &ty_annotation { cov_mark::hit!(replaces_ty_annotation); edit.replace(ty.syntax().text_range(), "Bool"); } if let Some(initializer) = initializer { replace_bool_expr(edit, initializer); } let usages = definition.usages(&ctx.sema).all(); add_enum_def(edit, ctx, &usages, target_node, &target_module); replace_usages(edit, ctx, &usages, &target_module); }, ) } struct BoolNodeData { target_node: SyntaxNode, name: ast::Name, ty_annotation: Option, initializer: Option, definition: Definition, } /// Attempts to find an appropriate node to apply the action to. fn find_bool_node(ctx: &AssistContext<'_>) -> Option { let name: ast::Name = ctx.find_node_at_offset()?; if let Some(let_stmt) = name.syntax().ancestors().find_map(ast::LetStmt::cast) { let bind_pat = match let_stmt.pat()? { ast::Pat::IdentPat(pat) => pat, _ => { cov_mark::hit!(not_applicable_in_non_ident_pat); return None; } }; let def = ctx.sema.to_def(&bind_pat)?; if !def.ty(ctx.db()).is_bool() { cov_mark::hit!(not_applicable_non_bool_local); return None; } Some(BoolNodeData { target_node: let_stmt.syntax().clone(), name, ty_annotation: let_stmt.ty(), initializer: let_stmt.initializer(), definition: Definition::Local(def), }) } else if let Some(const_) = name.syntax().ancestors().find_map(ast::Const::cast) { let def = ctx.sema.to_def(&const_)?; if !def.ty(ctx.db()).is_bool() { cov_mark::hit!(not_applicable_non_bool_const); return None; } Some(BoolNodeData { target_node: const_.syntax().clone(), name, ty_annotation: const_.ty(), initializer: const_.body(), definition: Definition::Const(def), }) } else if let Some(static_) = name.syntax().ancestors().find_map(ast::Static::cast) { let def = ctx.sema.to_def(&static_)?; if !def.ty(ctx.db()).is_bool() { cov_mark::hit!(not_applicable_non_bool_static); return None; } Some(BoolNodeData { target_node: static_.syntax().clone(), name, ty_annotation: static_.ty(), initializer: static_.body(), definition: Definition::Static(def), }) } else { let field = name.syntax().ancestors().find_map(ast::RecordField::cast)?; if field.name()? != name { return None; } let strukt = field.syntax().ancestors().find_map(ast::Struct::cast)?; let def = ctx.sema.to_def(&field)?; if !def.ty(ctx.db()).is_bool() { cov_mark::hit!(not_applicable_non_bool_field); return None; } Some(BoolNodeData { target_node: strukt.syntax().clone(), name, ty_annotation: field.ty(), initializer: None, definition: Definition::Field(def), }) } } fn replace_bool_expr(edit: &mut SourceChangeBuilder, expr: ast::Expr) { let expr_range = expr.syntax().text_range(); let enum_expr = bool_expr_to_enum_expr(expr); edit.replace(expr_range, enum_expr.syntax().text()) } /// Converts an expression of type `bool` to one of the new enum type. fn bool_expr_to_enum_expr(expr: ast::Expr) -> ast::Expr { let true_expr = make::expr_path(make::path_from_text("Bool::True")).clone_for_update(); let false_expr = make::expr_path(make::path_from_text("Bool::False")).clone_for_update(); if let ast::Expr::Literal(literal) = &expr { match literal.kind() { ast::LiteralKind::Bool(true) => true_expr, ast::LiteralKind::Bool(false) => false_expr, _ => expr, } } else { make::expr_if( expr, make::tail_only_block_expr(true_expr), Some(ast::ElseBranch::Block(make::tail_only_block_expr(false_expr))), ) .clone_for_update() } } /// Replaces all usages of the target identifier, both when read and written to. fn replace_usages( edit: &mut SourceChangeBuilder, ctx: &AssistContext<'_>, usages: &UsageSearchResult, target_module: &hir::Module, ) { for (file_id, references) in usages.iter() { edit.edit_file(*file_id); // add imports across modules where needed references .iter() .filter_map(|FileReference { name, .. }| { ctx.sema.scope(name.syntax()).map(|scope| (name, scope.module())) }) .unique_by(|name_and_module| name_and_module.1) .filter(|(_, module)| module != target_module) .filter_map(|(name, module)| { let import_scope = ImportScope::find_insert_use_container(name.syntax(), &ctx.sema); let mod_path = module.find_use_path_prefixed( ctx.sema.db, ModuleDef::Module(*target_module), ctx.config.insert_use.prefix_kind, ctx.config.prefer_no_std, ); import_scope.zip(mod_path) }) .for_each(|(import_scope, mod_path)| { let import_scope = match import_scope { ImportScope::File(it) => ImportScope::File(edit.make_mut(it)), ImportScope::Module(it) => ImportScope::Module(edit.make_mut(it)), ImportScope::Block(it) => ImportScope::Block(edit.make_mut(it)), }; let path = make::path_concat(mod_path_to_ast(&mod_path), make::path_from_text("Bool")); insert_use(&import_scope, path, &ctx.config.insert_use); }); // replace the usages in expressions references .into_iter() .filter_map(|FileReference { range, name, .. }| match name { ast::NameLike::NameRef(name) => Some((*range, name)), _ => None, }) .rev() .for_each(|(range, name_ref)| { if let Some(initializer) = find_assignment_usage(name_ref) { cov_mark::hit!(replaces_assignment); replace_bool_expr(edit, initializer); } else if let Some((prefix_expr, inner_expr)) = find_negated_usage(name_ref) { cov_mark::hit!(replaces_negation); edit.replace( prefix_expr.syntax().text_range(), format!("{} == Bool::False", inner_expr), ); } else if let Some((record_field, initializer)) = find_record_expr_usage(name_ref) { cov_mark::hit!(replaces_record_expr); let record_field = edit.make_mut(record_field); let enum_expr = bool_expr_to_enum_expr(initializer); record_field.replace_expr(enum_expr); } else if name_ref.syntax().ancestors().find_map(ast::UseTree::cast).is_none() { // for any other usage in an expression, replace it with a check that it is the true variant edit.replace(range, format!("{} == Bool::True", name_ref.text())); } }) } } fn find_assignment_usage(name_ref: &ast::NameRef) -> Option { let bin_expr = name_ref.syntax().ancestors().find_map(ast::BinExpr::cast)?; if let Some(ast::BinaryOp::Assignment { op: None }) = bin_expr.op_kind() { bin_expr.rhs() } else { None } } fn find_negated_usage(name_ref: &ast::NameRef) -> Option<(ast::PrefixExpr, ast::Expr)> { let prefix_expr = name_ref.syntax().ancestors().find_map(ast::PrefixExpr::cast)?; if let Some(ast::UnaryOp::Not) = prefix_expr.op_kind() { let inner_expr = prefix_expr.expr()?; Some((prefix_expr, inner_expr)) } else { None } } fn find_record_expr_usage(name_ref: &ast::NameRef) -> Option<(ast::RecordExprField, ast::Expr)> { let record_field = name_ref.syntax().ancestors().find_map(ast::RecordExprField::cast)?; let initializer = record_field.expr()?; Some((record_field, initializer)) } /// Adds the definition of the new enum before the target node. fn add_enum_def( edit: &mut SourceChangeBuilder, ctx: &AssistContext<'_>, usages: &UsageSearchResult, target_node: SyntaxNode, target_module: &hir::Module, ) { let make_enum_pub = usages .iter() .flat_map(|(_, refs)| refs) .filter_map(|FileReference { name, .. }| { ctx.sema.scope(name.syntax()).map(|scope| scope.module()) }) .any(|module| &module != target_module); let enum_def = make_bool_enum(make_enum_pub); let indent = IndentLevel::from_node(&target_node); enum_def.reindent_to(indent); ted::insert_all( ted::Position::before(&edit.make_syntax_mut(target_node)), vec![ enum_def.syntax().clone().into(), make::tokens::whitespace(&format!("\n\n{indent}")).into(), ], ); } fn make_bool_enum(make_pub: bool) -> ast::Enum { let enum_def = make::enum_( if make_pub { Some(make::visibility_pub()) } else { None }, make::name("Bool"), make::variant_list(vec![ make::variant(make::name("True"), None), make::variant(make::name("False"), None), ]), ) .clone_for_update(); let derive_eq = make::attr_outer(make::meta_token_tree( make::ext::ident_path("derive"), make::token_tree( T!['('], vec![ NodeOrToken::Token(make::tokens::ident("PartialEq")), NodeOrToken::Token(make::token(T![,])), NodeOrToken::Token(make::tokens::single_space()), NodeOrToken::Token(make::tokens::ident("Eq")), ], ), )) .clone_for_update(); enum_def.add_attr(derive_eq); enum_def } #[cfg(test)] mod tests { use super::*; use crate::tests::{check_assist, check_assist_not_applicable}; #[test] fn local_variable_with_usage() { check_assist( bool_to_enum, r#" fn main() { let $0foo = true; if foo { println!("foo"); } } "#, r#" fn main() { #[derive(PartialEq, Eq)] enum Bool { True, False } let foo = Bool::True; if foo == Bool::True { println!("foo"); } } "#, ) } #[test] fn local_variable_with_usage_negated() { cov_mark::check!(replaces_negation); check_assist( bool_to_enum, r#" fn main() { let $0foo = true; if !foo { println!("foo"); } } "#, r#" fn main() { #[derive(PartialEq, Eq)] enum Bool { True, False } let foo = Bool::True; if foo == Bool::False { println!("foo"); } } "#, ) } #[test] fn local_variable_with_type_annotation() { cov_mark::check!(replaces_ty_annotation); check_assist( bool_to_enum, r#" fn main() { let $0foo: bool = false; } "#, r#" fn main() { #[derive(PartialEq, Eq)] enum Bool { True, False } let foo: Bool = Bool::False; } "#, ) } #[test] fn local_variable_with_non_literal_initializer() { check_assist( bool_to_enum, r#" fn main() { let $0foo = 1 == 2; } "#, r#" fn main() { #[derive(PartialEq, Eq)] enum Bool { True, False } let foo = if 1 == 2 { Bool::True } else { Bool::False }; } "#, ) } #[test] fn local_variable_binexpr_usage() { check_assist( bool_to_enum, r#" fn main() { let $0foo = false; let bar = true; if !foo && bar { println!("foobar"); } } "#, r#" fn main() { #[derive(PartialEq, Eq)] enum Bool { True, False } let foo = Bool::False; let bar = true; if foo == Bool::False && bar { println!("foobar"); } } "#, ) } #[test] fn local_variable_unop_usage() { check_assist( bool_to_enum, r#" fn main() { let $0foo = true; if *&foo { println!("foobar"); } } "#, r#" fn main() { #[derive(PartialEq, Eq)] enum Bool { True, False } let foo = Bool::True; if *&foo == Bool::True { println!("foobar"); } } "#, ) } #[test] fn local_variable_assigned_later() { cov_mark::check!(replaces_assignment); check_assist( bool_to_enum, r#" fn main() { let $0foo: bool; foo = true; } "#, r#" fn main() { #[derive(PartialEq, Eq)] enum Bool { True, False } let foo: Bool; foo = Bool::True; } "#, ) } #[test] fn local_variable_does_not_apply_recursively() { check_assist( bool_to_enum, r#" fn main() { let $0foo = true; let bar = !foo; if bar { println!("bar"); } } "#, r#" fn main() { #[derive(PartialEq, Eq)] enum Bool { True, False } let foo = Bool::True; let bar = foo == Bool::False; if bar { println!("bar"); } } "#, ) } #[test] fn local_variable_non_bool() { cov_mark::check!(not_applicable_non_bool_local); check_assist_not_applicable( bool_to_enum, r#" fn main() { let $0foo = 1; } "#, ) } #[test] fn local_variable_cursor_not_on_ident() { check_assist_not_applicable( bool_to_enum, r#" fn main() { let foo = $0true; } "#, ) } #[test] fn local_variable_non_ident_pat() { cov_mark::check!(not_applicable_in_non_ident_pat); check_assist_not_applicable( bool_to_enum, r#" fn main() { let ($0foo, bar) = (true, false); } "#, ) } #[test] fn field_basic() { cov_mark::check!(replaces_record_expr); check_assist( bool_to_enum, r#" struct Foo { $0bar: bool, baz: bool, } fn main() { let foo = Foo { bar: true, baz: false }; if foo.bar { println!("foo"); } } "#, r#" #[derive(PartialEq, Eq)] enum Bool { True, False } struct Foo { bar: Bool, baz: bool, } fn main() { let foo = Foo { bar: Bool::True, baz: false }; if foo.bar == Bool::True { println!("foo"); } } "#, ) } #[test] fn field_in_mod_properly_indented() { check_assist( bool_to_enum, r#" mod foo { struct Bar { $0baz: bool, } impl Bar { fn new(baz: bool) -> Self { Self { baz } } } } "#, r#" mod foo { #[derive(PartialEq, Eq)] enum Bool { True, False } struct Bar { baz: Bool, } impl Bar { fn new(baz: bool) -> Self { Self { baz: if baz { Bool::True } else { Bool::False } } } } } "#, ) } #[test] fn field_multiple_initializations() { check_assist( bool_to_enum, r#" struct Foo { $0bar: bool, baz: bool, } fn main() { let foo1 = Foo { bar: true, baz: false }; let foo2 = Foo { bar: false, baz: false }; if foo1.bar && foo2.bar { println!("foo"); } } "#, r#" #[derive(PartialEq, Eq)] enum Bool { True, False } struct Foo { bar: Bool, baz: bool, } fn main() { let foo1 = Foo { bar: Bool::True, baz: false }; let foo2 = Foo { bar: Bool::False, baz: false }; if foo1.bar == Bool::True && foo2.bar == Bool::True { println!("foo"); } } "#, ) } #[test] fn field_non_bool() { cov_mark::check!(not_applicable_non_bool_field); check_assist_not_applicable( bool_to_enum, r#" struct Foo { $0bar: usize, } fn main() { let foo = Foo { bar: 1 }; } "#, ) } #[test] fn const_basic() { check_assist( bool_to_enum, r#" const $0FOO: bool = false; fn main() { if FOO { println!("foo"); } } "#, r#" #[derive(PartialEq, Eq)] enum Bool { True, False } const FOO: Bool = Bool::False; fn main() { if FOO == Bool::True { println!("foo"); } } "#, ) } #[test] fn const_in_module() { check_assist( bool_to_enum, r#" fn main() { if foo::FOO { println!("foo"); } } mod foo { pub const $0FOO: bool = true; } "#, r#" use foo::Bool; fn main() { if foo::FOO == Bool::True { println!("foo"); } } mod foo { #[derive(PartialEq, Eq)] pub enum Bool { True, False } pub const FOO: Bool = Bool::True; } "#, ) } #[test] fn const_in_module_with_import() { check_assist( bool_to_enum, r#" fn main() { use foo::FOO; if FOO { println!("foo"); } } mod foo { pub const $0FOO: bool = true; } "#, r#" use crate::foo::Bool; fn main() { use foo::FOO; if FOO == Bool::True { println!("foo"); } } mod foo { #[derive(PartialEq, Eq)] pub enum Bool { True, False } pub const FOO: Bool = Bool::True; } "#, ) } #[test] fn const_cross_file() { check_assist( bool_to_enum, r#" //- /main.rs mod foo; fn main() { if foo::FOO { println!("foo"); } } //- /foo.rs pub const $0FOO: bool = true; "#, r#" //- /main.rs use foo::Bool; mod foo; fn main() { if foo::FOO == Bool::True { println!("foo"); } } //- /foo.rs #[derive(PartialEq, Eq)] pub enum Bool { True, False } pub const FOO: Bool = Bool::True; "#, ) } #[test] fn const_cross_file_and_module() { check_assist( bool_to_enum, r#" //- /main.rs mod foo; fn main() { use foo::bar; if bar::BAR { println!("foo"); } } //- /foo.rs pub mod bar { pub const $0BAR: bool = false; } "#, r#" //- /main.rs use crate::foo::bar::Bool; mod foo; fn main() { use foo::bar; if bar::BAR == Bool::True { println!("foo"); } } //- /foo.rs pub mod bar { #[derive(PartialEq, Eq)] pub enum Bool { True, False } pub const BAR: Bool = Bool::False; } "#, ) } #[test] fn const_non_bool() { cov_mark::check!(not_applicable_non_bool_const); check_assist_not_applicable( bool_to_enum, r#" const $0FOO: &str = "foo"; fn main() { println!("{FOO}"); } "#, ) } #[test] fn static_basic() { check_assist( bool_to_enum, r#" static mut $0BOOL: bool = true; fn main() { unsafe { BOOL = false }; if unsafe { BOOL } { println!("foo"); } } "#, r#" #[derive(PartialEq, Eq)] enum Bool { True, False } static mut BOOL: Bool = Bool::True; fn main() { unsafe { BOOL = Bool::False }; if unsafe { BOOL == Bool::True } { println!("foo"); } } "#, ) } #[test] fn static_non_bool() { cov_mark::check!(not_applicable_non_bool_static); check_assist_not_applicable( bool_to_enum, r#" static mut $0FOO: usize = 0; fn main() { if unsafe { FOO } == 0 { println!("foo"); } } "#, ) } #[test] fn not_applicable_to_other_names() { check_assist_not_applicable(bool_to_enum, "fn $0main() {}") } }