use itertools::Itertools; use stdx::format_to; use syntax::{ ast::{self, AstNode, GenericParamsOwner, NameOwner, StructKind, VisibilityOwner}, SmolStr, }; use crate::{ utils::{find_impl_block, find_struct_impl}, AssistContext, AssistId, AssistKind, Assists, }; // Assist: generate_new // // Adds a new inherent impl for a type. // // ``` // struct Ctx { // data: T,$0 // } // ``` // -> // ``` // struct Ctx { // data: T, // } // // impl Ctx { // fn $0new(data: T) -> Self { Self { data } } // } // // ``` pub(crate) fn generate_new(acc: &mut Assists, ctx: &AssistContext) -> Option<()> { let strukt = ctx.find_node_at_offset::()?; // We want to only apply this to non-union structs with named fields let field_list = match strukt.kind() { StructKind::Record(named) => named, _ => return None, }; // Return early if we've found an existing new fn let impl_def = find_struct_impl(&ctx, &ast::AdtDef::Struct(strukt.clone()), "new")?; let target = strukt.syntax().text_range(); acc.add(AssistId("generate_new", AssistKind::Generate), "Generate `new`", target, |builder| { let mut buf = String::with_capacity(512); if impl_def.is_some() { buf.push('\n'); } let vis = strukt.visibility().map_or(String::new(), |v| format!("{} ", v)); let params = field_list .fields() .filter_map(|f| Some(format!("{}: {}", f.name()?.syntax(), f.ty()?.syntax()))) .format(", "); let fields = field_list.fields().filter_map(|f| f.name()).format(", "); format_to!(buf, " {}fn new({}) -> Self {{ Self {{ {} }} }}", vis, params, fields); let start_offset = impl_def .and_then(|impl_def| find_impl_block(impl_def, &mut buf)) .unwrap_or_else(|| { buf = generate_impl_text(&strukt, &buf); strukt.syntax().text_range().end() }); match ctx.config.snippet_cap { None => builder.insert(start_offset, buf), Some(cap) => { buf = buf.replace("fn new", "fn $0new"); builder.insert_snippet(cap, start_offset, buf); } } }) } // Generates the surrounding `impl Type { }` including type and lifetime // parameters fn generate_impl_text(strukt: &ast::Struct, code: &str) -> String { let type_params = strukt.generic_param_list(); let mut buf = String::with_capacity(code.len()); buf.push_str("\n\nimpl"); if let Some(type_params) = &type_params { format_to!(buf, "{}", type_params.syntax()); } buf.push(' '); buf.push_str(strukt.name().unwrap().text()); if let Some(type_params) = type_params { let lifetime_params = type_params .lifetime_params() .filter_map(|it| it.lifetime()) .map(|it| SmolStr::from(it.text())); let type_params = type_params.type_params().filter_map(|it| it.name()).map(|it| SmolStr::from(it.text())); format_to!(buf, "<{}>", lifetime_params.chain(type_params).format(", ")) } format_to!(buf, " {{\n{}\n}}\n", code); buf } #[cfg(test)] mod tests { use crate::tests::{check_assist, check_assist_not_applicable, check_assist_target}; use super::*; #[test] #[rustfmt::skip] fn test_generate_new() { // Check output of generation check_assist( generate_new, "struct Foo {$0}", "struct Foo {} impl Foo { fn $0new() -> Self { Self { } } } ", ); check_assist( generate_new, "struct Foo {$0}", "struct Foo {} impl Foo { fn $0new() -> Self { Self { } } } ", ); check_assist( generate_new, "struct Foo<'a, T: Foo<'a>> {$0}", "struct Foo<'a, T: Foo<'a>> {} impl<'a, T: Foo<'a>> Foo<'a, T> { fn $0new() -> Self { Self { } } } ", ); check_assist( generate_new, "struct Foo { baz: String $0}", "struct Foo { baz: String } impl Foo { fn $0new(baz: String) -> Self { Self { baz } } } ", ); check_assist( generate_new, "struct Foo { baz: String, qux: Vec $0}", "struct Foo { baz: String, qux: Vec } impl Foo { fn $0new(baz: String, qux: Vec) -> Self { Self { baz, qux } } } ", ); // Check that visibility modifiers don't get brought in for fields check_assist( generate_new, "struct Foo { pub baz: String, pub qux: Vec $0}", "struct Foo { pub baz: String, pub qux: Vec } impl Foo { fn $0new(baz: String, qux: Vec) -> Self { Self { baz, qux } } } ", ); // Check that it reuses existing impls check_assist( generate_new, "struct Foo {$0} impl Foo {} ", "struct Foo {} impl Foo { fn $0new() -> Self { Self { } } } ", ); check_assist( generate_new, "struct Foo {$0} impl Foo { fn qux(&self) {} } ", "struct Foo {} impl Foo { fn $0new() -> Self { Self { } } fn qux(&self) {} } ", ); check_assist( generate_new, "struct Foo {$0} impl Foo { fn qux(&self) {} fn baz() -> i32 { 5 } } ", "struct Foo {} impl Foo { fn $0new() -> Self { Self { } } fn qux(&self) {} fn baz() -> i32 { 5 } } ", ); // Check visibility of new fn based on struct check_assist( generate_new, "pub struct Foo {$0}", "pub struct Foo {} impl Foo { pub fn $0new() -> Self { Self { } } } ", ); check_assist( generate_new, "pub(crate) struct Foo {$0}", "pub(crate) struct Foo {} impl Foo { pub(crate) fn $0new() -> Self { Self { } } } ", ); } #[test] fn generate_new_not_applicable_if_fn_exists() { check_assist_not_applicable( generate_new, " struct Foo {$0} impl Foo { fn new() -> Self { Self } }", ); check_assist_not_applicable( generate_new, " struct Foo {$0} impl Foo { fn New() -> Self { Self } }", ); } #[test] fn generate_new_target() { check_assist_target( generate_new, " struct SomeThingIrrelevant; /// Has a lifetime parameter struct Foo<'a, T: Foo<'a>> {$0} struct EvenMoreIrrelevant; ", "/// Has a lifetime parameter struct Foo<'a, T: Foo<'a>> {}", ); } #[test] fn test_unrelated_new() { check_assist( generate_new, r##" pub struct AstId { file_id: HirFileId, file_ast_id: FileAstId, } impl AstId { pub fn new(file_id: HirFileId, file_ast_id: FileAstId) -> AstId { AstId { file_id, file_ast_id } } } pub struct Source { pub file_id: HirFileId,$0 pub ast: T, } impl Source { pub fn map U, U>(self, f: F) -> Source { Source { file_id: self.file_id, ast: f(self.ast) } } } "##, r##" pub struct AstId { file_id: HirFileId, file_ast_id: FileAstId, } impl AstId { pub fn new(file_id: HirFileId, file_ast_id: FileAstId) -> AstId { AstId { file_id, file_ast_id } } } pub struct Source { pub file_id: HirFileId, pub ast: T, } impl Source { pub fn $0new(file_id: HirFileId, ast: T) -> Self { Self { file_id, ast } } pub fn map U, U>(self, f: F) -> Source { Source { file_id: self.file_id, ast: f(self.ast) } } } "##, ); } }