use ide_db::FxHashSet; use syntax::{ ast::{self, edit_in_place::GenericParamsOwnerEdit, make, HasGenericParams}, ted::{self, Position}, AstNode, TextRange, }; use crate::{assist_context::SourceChangeBuilder, AssistContext, AssistId, AssistKind, Assists}; static ASSIST_NAME: &str = "introduce_named_lifetime"; static ASSIST_LABEL: &str = "Introduce named lifetime"; // Assist: introduce_named_lifetime // // Change an anonymous lifetime to a named lifetime. // // ``` // impl Cursor<'_$0> { // fn node(self) -> &SyntaxNode { // match self { // Cursor::Replace(node) | Cursor::Before(node) => node, // } // } // } // ``` // -> // ``` // impl<'a> Cursor<'a> { // fn node(self) -> &SyntaxNode { // match self { // Cursor::Replace(node) | Cursor::Before(node) => node, // } // } // } // ``` pub(crate) fn introduce_named_lifetime(acc: &mut Assists, ctx: &AssistContext<'_>) -> Option<()> { // FIXME: How can we handle renaming any one of multiple anonymous lifetimes? // FIXME: should also add support for the case fun(f: &Foo) -> &$0Foo let lifetime = ctx.find_node_at_offset::().filter(|lifetime| lifetime.text() == "'_")?; let lifetime_loc = lifetime.lifetime_ident_token()?.text_range(); if let Some(fn_def) = lifetime.syntax().ancestors().find_map(ast::Fn::cast) { generate_fn_def_assist(acc, fn_def, lifetime_loc, lifetime) } else if let Some(impl_def) = lifetime.syntax().ancestors().find_map(ast::Impl::cast) { generate_impl_def_assist(acc, impl_def, lifetime_loc, lifetime) } else { None } } /// Generate the assist for the fn def case fn generate_fn_def_assist( acc: &mut Assists, fn_def: ast::Fn, lifetime_loc: TextRange, lifetime: ast::Lifetime, ) -> Option<()> { let param_list: ast::ParamList = fn_def.param_list()?; let new_lifetime_param = generate_unique_lifetime_param_name(fn_def.generic_param_list())?; let self_param = // use the self if it's a reference and has no explicit lifetime param_list.self_param().filter(|p| p.lifetime().is_none() && p.amp_token().is_some()); // compute the location which implicitly has the same lifetime as the anonymous lifetime let loc_needing_lifetime = if let Some(self_param) = self_param { // if we have a self reference, use that Some(NeedsLifetime::SelfParam(self_param)) } else { // otherwise, if there's a single reference parameter without a named liftime, use that let fn_params_without_lifetime: Vec<_> = param_list .params() .filter_map(|param| match param.ty() { Some(ast::Type::RefType(ascribed_type)) if ascribed_type.lifetime().is_none() => { Some(NeedsLifetime::RefType(ascribed_type)) } _ => None, }) .collect(); match fn_params_without_lifetime.len() { 1 => Some(fn_params_without_lifetime.into_iter().next()?), 0 => None, // multiple unnnamed is invalid. assist is not applicable _ => return None, } }; acc.add(AssistId(ASSIST_NAME, AssistKind::Refactor), ASSIST_LABEL, lifetime_loc, |builder| { let fn_def = builder.make_mut(fn_def); let lifetime = builder.make_mut(lifetime); let loc_needing_lifetime = loc_needing_lifetime.and_then(|it| it.make_mut(builder).to_position()); fn_def.get_or_create_generic_param_list().add_generic_param( make::lifetime_param(new_lifetime_param.clone()).clone_for_update().into(), ); ted::replace(lifetime.syntax(), new_lifetime_param.clone_for_update().syntax()); if let Some(position) = loc_needing_lifetime { ted::insert(position, new_lifetime_param.clone_for_update().syntax()); } }) } /// Generate the assist for the impl def case fn generate_impl_def_assist( acc: &mut Assists, impl_def: ast::Impl, lifetime_loc: TextRange, lifetime: ast::Lifetime, ) -> Option<()> { let new_lifetime_param = generate_unique_lifetime_param_name(impl_def.generic_param_list())?; acc.add(AssistId(ASSIST_NAME, AssistKind::Refactor), ASSIST_LABEL, lifetime_loc, |builder| { let impl_def = builder.make_mut(impl_def); let lifetime = builder.make_mut(lifetime); impl_def.get_or_create_generic_param_list().add_generic_param( make::lifetime_param(new_lifetime_param.clone()).clone_for_update().into(), ); ted::replace(lifetime.syntax(), new_lifetime_param.clone_for_update().syntax()); }) } /// Given a type parameter list, generate a unique lifetime parameter name /// which is not in the list fn generate_unique_lifetime_param_name( existing_type_param_list: Option, ) -> Option { match existing_type_param_list { Some(type_params) => { let used_lifetime_params: FxHashSet<_> = type_params.lifetime_params().map(|p| p.syntax().text().to_string()).collect(); ('a'..='z').map(|it| format!("'{it}")).find(|it| !used_lifetime_params.contains(it)) } None => Some("'a".to_string()), } .map(|it| make::lifetime(&it)) } enum NeedsLifetime { SelfParam(ast::SelfParam), RefType(ast::RefType), } impl NeedsLifetime { fn make_mut(self, builder: &mut SourceChangeBuilder) -> Self { match self { Self::SelfParam(it) => Self::SelfParam(builder.make_mut(it)), Self::RefType(it) => Self::RefType(builder.make_mut(it)), } } fn to_position(self) -> Option { match self { Self::SelfParam(it) => Some(Position::after(it.amp_token()?)), Self::RefType(it) => Some(Position::after(it.amp_token()?)), } } } #[cfg(test)] mod tests { use super::*; use crate::tests::{check_assist, check_assist_not_applicable}; #[test] fn test_example_case() { check_assist( introduce_named_lifetime, r#"impl Cursor<'_$0> { fn node(self) -> &SyntaxNode { match self { Cursor::Replace(node) | Cursor::Before(node) => node, } } }"#, r#"impl<'a> Cursor<'a> { fn node(self) -> &SyntaxNode { match self { Cursor::Replace(node) | Cursor::Before(node) => node, } } }"#, ); } #[test] fn test_example_case_simplified() { check_assist( introduce_named_lifetime, r#"impl Cursor<'_$0> {"#, r#"impl<'a> Cursor<'a> {"#, ); } #[test] fn test_example_case_cursor_after_tick() { check_assist( introduce_named_lifetime, r#"impl Cursor<'$0_> {"#, r#"impl<'a> Cursor<'a> {"#, ); } #[test] fn test_impl_with_other_type_param() { check_assist( introduce_named_lifetime, "impl fmt::Display for SepByBuilder<'_$0, I> where I: Iterator, I::Item: fmt::Display, {", "impl fmt::Display for SepByBuilder<'a, I> where I: Iterator, I::Item: fmt::Display, {", ) } #[test] fn test_example_case_cursor_before_tick() { check_assist( introduce_named_lifetime, r#"impl Cursor<$0'_> {"#, r#"impl<'a> Cursor<'a> {"#, ); } #[test] fn test_not_applicable_cursor_position() { check_assist_not_applicable(introduce_named_lifetime, r#"impl Cursor<'_>$0 {"#); check_assist_not_applicable(introduce_named_lifetime, r#"impl Cursor$0<'_> {"#); } #[test] fn test_not_applicable_lifetime_already_name() { check_assist_not_applicable(introduce_named_lifetime, r#"impl Cursor<'a$0> {"#); check_assist_not_applicable(introduce_named_lifetime, r#"fn my_fun<'a>() -> X<'a$0>"#); } #[test] fn test_with_type_parameter() { check_assist( introduce_named_lifetime, r#"impl Cursor"#, r#"impl Cursor"#, ); } #[test] fn test_with_existing_lifetime_name_conflict() { check_assist( introduce_named_lifetime, r#"impl<'a, 'b> Cursor<'a, 'b, '_$0>"#, r#"impl<'a, 'b, 'c> Cursor<'a, 'b, 'c>"#, ); } #[test] fn test_function_return_value_anon_lifetime_param() { check_assist( introduce_named_lifetime, r#"fn my_fun() -> X<'_$0>"#, r#"fn my_fun<'a>() -> X<'a>"#, ); } #[test] fn test_function_return_value_anon_reference_lifetime() { check_assist( introduce_named_lifetime, r#"fn my_fun() -> &'_$0 X"#, r#"fn my_fun<'a>() -> &'a X"#, ); } #[test] fn test_function_param_anon_lifetime() { check_assist( introduce_named_lifetime, r#"fn my_fun(x: X<'_$0>)"#, r#"fn my_fun<'a>(x: X<'a>)"#, ); } #[test] fn test_function_add_lifetime_to_params() { check_assist( introduce_named_lifetime, r#"fn my_fun(f: &Foo) -> X<'_$0>"#, r#"fn my_fun<'a>(f: &'a Foo) -> X<'a>"#, ); } #[test] fn test_function_add_lifetime_to_params_in_presence_of_other_lifetime() { check_assist( introduce_named_lifetime, r#"fn my_fun<'other>(f: &Foo, b: &'other Bar) -> X<'_$0>"#, r#"fn my_fun<'other, 'a>(f: &'a Foo, b: &'other Bar) -> X<'a>"#, ); } #[test] fn test_function_not_applicable_without_self_and_multiple_unnamed_param_lifetimes() { // this is not permitted under lifetime elision rules check_assist_not_applicable( introduce_named_lifetime, r#"fn my_fun(f: &Foo, b: &Bar) -> X<'_$0>"#, ); } #[test] fn test_function_add_lifetime_to_self_ref_param() { check_assist( introduce_named_lifetime, r#"fn my_fun<'other>(&self, f: &Foo, b: &'other Bar) -> X<'_$0>"#, r#"fn my_fun<'other, 'a>(&'a self, f: &Foo, b: &'other Bar) -> X<'a>"#, ); } #[test] fn test_function_add_lifetime_to_param_with_non_ref_self() { check_assist( introduce_named_lifetime, r#"fn my_fun<'other>(self, f: &Foo, b: &'other Bar) -> X<'_$0>"#, r#"fn my_fun<'other, 'a>(self, f: &'a Foo, b: &'other Bar) -> X<'a>"#, ); } #[test] fn test_function_add_lifetime_to_self_ref_mut() { check_assist( introduce_named_lifetime, r#"fn foo(&mut self) -> &'_$0 ()"#, r#"fn foo<'a>(&'a mut self) -> &'a ()"#, ); } }