3 use hir::{db::HirDatabase, PathResolution, Semantics, TypeInfo};
5 base_db::{FileId, FileRange},
7 imports::insert_use::remove_path_if_in_use_stmt,
8 path_transform::PathTransform,
9 search::{FileReference, SearchScope},
10 syntax_helpers::{insert_whitespace_into_node::insert_ws_into, node_ext::expr_as_name_ref},
13 use itertools::{izip, Itertools};
15 ast::{self, edit_in_place::Indent, HasArgList, PathExpr},
16 ted, AstNode, SyntaxKind,
20 assist_context::{AssistContext, Assists},
24 // Assist: inline_into_callers
26 // Inline a function or method body into all of its callers where possible, creating a `let` statement per parameter
27 // unless the parameter can be inlined. The parameter will be inlined either if it the supplied argument is a simple local
28 // or if the parameter is only accessed inside the function body once.
29 // If all calls can be inlined the function will be removed.
32 // fn print(_: &str) {}
33 // fn foo$0(word: &str) {
34 // if !word.is_empty() {
45 // fn print(_: &str) {}
49 // let word = "안녕하세요";
50 // if !word.is_empty() {
56 // if !word.is_empty() {
62 pub(crate) fn inline_into_callers(acc: &mut Assists, ctx: &AssistContext<'_>) -> Option<()> {
63 let def_file = ctx.file_id();
64 let name = ctx.find_node_at_offset::<ast::Name>()?;
65 let ast_func = name.syntax().parent().and_then(ast::Fn::cast)?;
66 let func_body = ast_func.body()?;
67 let param_list = ast_func.param_list()?;
69 let function = ctx.sema.to_def(&ast_func)?;
71 let params = get_fn_params(ctx.sema.db, function, ¶m_list)?;
73 let usages = Definition::Function(function).usages(&ctx.sema);
74 if !usages.at_least_one() {
78 let is_recursive_fn = usages
80 .in_scope(SearchScope::file_range(FileRange {
82 range: func_body.syntax().text_range(),
86 cov_mark::hit!(inline_into_callers_recursive);
91 AssistId("inline_into_callers", AssistKind::RefactorInline),
92 "Inline into all callers",
93 name.syntax().text_range(),
95 let mut usages = usages.all();
96 let current_file_usage = usages.references.remove(&def_file);
98 let mut remove_def = true;
99 let mut inline_refs_for_file = |file_id, refs: Vec<FileReference>| {
100 builder.edit_file(file_id);
101 let count = refs.len();
102 // The collects are required as we are otherwise iterating while mutating 🙅♀️🙅♂️
103 let (name_refs, name_refs_use): (Vec<_>, Vec<_>) = refs
105 .filter_map(|file_ref| match file_ref.name {
106 ast::NameLike::NameRef(name_ref) => Some(name_ref),
109 .partition_map(|name_ref| {
110 match name_ref.syntax().ancestors().find_map(ast::UseTree::cast) {
111 Some(use_tree) => Either::Right(builder.make_mut(use_tree)),
112 None => Either::Left(name_ref),
115 let call_infos: Vec<_> = name_refs
117 .filter_map(CallInfo::from_name_ref)
119 let mut_node = builder.make_syntax_mut(call_info.node.syntax().clone());
120 (call_info, mut_node)
123 let replaced = call_infos
125 .map(|(call_info, mut_node)| {
127 inline(&ctx.sema, def_file, function, &func_body, ¶ms, &call_info);
128 ted::replace(mut_node, replacement.syntax());
131 if replaced + name_refs_use.len() == count {
132 // we replaced all usages in this file, so we can remove the imports
133 name_refs_use.into_iter().for_each(|use_tree| {
134 if let Some(path) = use_tree.path() {
135 remove_path_if_in_use_stmt(&path);
142 for (file_id, refs) in usages.into_iter() {
143 inline_refs_for_file(file_id, refs);
145 match current_file_usage {
146 Some(refs) => inline_refs_for_file(def_file, refs),
147 None => builder.edit_file(def_file),
150 builder.delete(ast_func.syntax().text_range());
156 // Assist: inline_call
158 // Inlines a function or method body creating a `let` statement per parameter unless the parameter
159 // can be inlined. The parameter will be inlined either if it the supplied argument is a simple local
160 // or if the parameter is only accessed inside the function body once.
163 // # //- minicore: option
164 // fn foo(name: Option<&str>) {
165 // let name = name.unwrap$0();
170 // fn foo(name: Option<&str>) {
171 // let name = match name {
173 // None => panic!("called `Option::unwrap()` on a `None` value"),
177 pub(crate) fn inline_call(acc: &mut Assists, ctx: &AssistContext<'_>) -> Option<()> {
178 let name_ref: ast::NameRef = ctx.find_node_at_offset()?;
179 let call_info = CallInfo::from_name_ref(name_ref.clone())?;
180 let (function, label) = match &call_info.node {
181 ast::CallableExpr::Call(call) => {
182 let path = match call.expr()? {
183 ast::Expr::PathExpr(path) => path.path(),
186 let function = match ctx.sema.resolve_path(&path)? {
187 PathResolution::Def(hir::ModuleDef::Function(f)) => f,
190 (function, format!("Inline `{}`", path))
192 ast::CallableExpr::MethodCall(call) => {
193 (ctx.sema.resolve_method_call(call)?, format!("Inline `{}`", name_ref))
197 let fn_source = ctx.sema.source(function)?;
198 let fn_body = fn_source.value.body()?;
199 let param_list = fn_source.value.param_list()?;
201 let FileRange { file_id, range } = fn_source.syntax().original_file_range(ctx.sema.db);
202 if file_id == ctx.file_id() && range.contains(ctx.offset()) {
203 cov_mark::hit!(inline_call_recursive);
206 let params = get_fn_params(ctx.sema.db, function, ¶m_list)?;
208 if call_info.arguments.len() != params.len() {
209 // Can't inline the function because they've passed the wrong number of
210 // arguments to this function
211 cov_mark::hit!(inline_call_incorrect_number_of_arguments);
215 let syntax = call_info.node.syntax().clone();
217 AssistId("inline_call", AssistKind::RefactorInline),
221 let replacement = inline(&ctx.sema, file_id, function, &fn_body, ¶ms, &call_info);
224 match call_info.node {
225 ast::CallableExpr::Call(it) => ast::Expr::CallExpr(it),
226 ast::CallableExpr::MethodCall(it) => ast::Expr::MethodCallExpr(it),
235 node: ast::CallableExpr,
236 arguments: Vec<ast::Expr>,
237 generic_arg_list: Option<ast::GenericArgList>,
241 fn from_name_ref(name_ref: ast::NameRef) -> Option<CallInfo> {
242 let parent = name_ref.syntax().parent()?;
243 if let Some(call) = ast::MethodCallExpr::cast(parent.clone()) {
244 let receiver = call.receiver()?;
245 let mut arguments = vec![receiver];
246 arguments.extend(call.arg_list()?.args());
248 generic_arg_list: call.generic_arg_list(),
249 node: ast::CallableExpr::MethodCall(call),
252 } else if let Some(segment) = ast::PathSegment::cast(parent) {
253 let path = segment.syntax().parent().and_then(ast::Path::cast)?;
254 let path = path.syntax().parent().and_then(ast::PathExpr::cast)?;
255 let call = path.syntax().parent().and_then(ast::CallExpr::cast)?;
258 arguments: call.arg_list()?.args().collect(),
259 node: ast::CallableExpr::Call(call),
260 generic_arg_list: segment.generic_arg_list(),
269 db: &dyn HirDatabase,
270 function: hir::Function,
271 param_list: &ast::ParamList,
272 ) -> Option<Vec<(ast::Pat, Option<ast::Type>, hir::Param)>> {
273 let mut assoc_fn_params = function.assoc_fn_params(db).into_iter();
275 let mut params = Vec::new();
276 if let Some(self_param) = param_list.self_param() {
277 // FIXME this should depend on the receiver as well as the self_param
280 self_param.amp_token().is_some(),
281 self_param.mut_token().is_some(),
286 assoc_fn_params.next()?,
289 for param in param_list.params() {
290 params.push((param.pat()?, param.ty(), assoc_fn_params.next()?));
297 sema: &Semantics<'_, RootDatabase>,
298 function_def_file_id: FileId,
299 function: hir::Function,
300 fn_body: &ast::BlockExpr,
301 params: &[(ast::Pat, Option<ast::Type>, hir::Param)],
302 CallInfo { node, arguments, generic_arg_list }: &CallInfo,
304 let body = if sema.hir_file_for(fn_body.syntax()).is_macro() {
305 cov_mark::hit!(inline_call_defined_in_macro);
306 if let Some(body) = ast::BlockExpr::cast(insert_ws_into(fn_body.syntax().clone())) {
309 fn_body.clone_for_update()
312 fn_body.clone_for_update()
314 // TODO: use if-let chains - https://github.com/rust-lang/rust/pull/94927
315 if let Some(i) = body.syntax().ancestors().find_map(ast::Impl::cast) {
316 if let Some(st) = i.self_ty() {
317 for tok in body.syntax().descendants_with_tokens().filter_map(|t| t.into_token()) {
318 if tok.kind() == SyntaxKind::SELF_TYPE_KW {
319 ted::replace(tok, st.syntax());
324 let usages_for_locals = |local| {
325 Definition::Local(local)
329 .remove(&function_def_file_id)
333 let param_use_nodes: Vec<Vec<_>> = params
335 .map(|(pat, _, param)| {
336 if !matches!(pat, ast::Pat::IdentPat(pat) if pat.is_simple_ident()) {
339 // FIXME: we need to fetch all locals declared in the parameter here
340 // not only the local if it is a simple binding
341 match param.as_local(sema.db) {
342 Some(l) => usages_for_locals(l)
343 .map(|FileReference { name, range, .. }| match name {
344 ast::NameLike::NameRef(_) => body
346 .covering_element(range)
349 .and_then(ast::PathExpr::cast),
352 .collect::<Option<Vec<_>>>()
353 .unwrap_or_default(),
359 if function.self_param(sema.db).is_some() {
360 let this = || make::name_ref("this").syntax().clone_for_update();
361 if let Some(self_local) = params[0].2.as_local(sema.db) {
362 usages_for_locals(self_local)
363 .flat_map(|FileReference { name, range, .. }| match name {
364 ast::NameLike::NameRef(_) => Some(body.syntax().covering_element(range)),
368 ted::replace(it, &this());
372 // Inline parameter expressions or generate `let` statements depending on whether inlining works or not.
373 for ((pat, param_ty, _), usages, expr) in izip!(params, param_use_nodes, arguments).rev() {
374 let inline_direct = |usage, replacement: &ast::Expr| {
375 if let Some(field) = path_expr_as_record_field(usage) {
376 cov_mark::hit!(inline_call_inline_direct_field);
377 field.replace_expr(replacement.clone_for_update());
379 ted::replace(usage.syntax(), &replacement.syntax().clone_for_update());
382 // izip confuses RA due to our lack of hygiene info currently losing us type info causing incorrect errors
383 let usages: &[ast::PathExpr] = &*usages;
384 let expr: &ast::Expr = expr;
386 // inline single use closure arguments
388 if matches!(expr, ast::Expr::ClosureExpr(_))
389 && usage.syntax().parent().and_then(ast::Expr::cast).is_some() =>
391 cov_mark::hit!(inline_call_inline_closure);
392 let expr = make::expr_paren(expr.clone());
393 inline_direct(usage, &expr);
395 // inline single use literals
396 [usage] if matches!(expr, ast::Expr::Literal(_)) => {
397 cov_mark::hit!(inline_call_inline_literal);
398 inline_direct(usage, expr);
400 // inline direct local arguments
401 [_, ..] if expr_as_name_ref(expr).is_some() => {
402 cov_mark::hit!(inline_call_inline_locals);
403 usages.iter().for_each(|usage| inline_direct(usage, expr));
405 // can't inline, emit a let statement
408 sema.type_of_expr(expr).filter(TypeInfo::has_adjustment).and(param_ty.clone());
409 if let Some(stmt_list) = body.stmt_list() {
410 stmt_list.push_front(
411 make::let_stmt(pat.clone(), ty, Some(expr.clone()))
419 if let Some(generic_arg_list) = generic_arg_list.clone() {
420 if let Some((target, source)) = &sema.scope(node.syntax()).zip(sema.scope(fn_body.syntax()))
422 PathTransform::function_call(target, source, function, generic_arg_list)
423 .apply(body.syntax());
427 let original_indentation = match node {
428 ast::CallableExpr::Call(it) => it.indent_level(),
429 ast::CallableExpr::MethodCall(it) => it.indent_level(),
431 body.reindent_to(original_indentation);
433 match body.tail_expr() {
434 Some(expr) if body.statements().next().is_none() => expr,
438 .and_then(ast::BinExpr::cast)
439 .and_then(|bin_expr| bin_expr.lhs())
441 Some(lhs) if lhs.syntax() == node.syntax() => {
442 make::expr_paren(ast::Expr::BlockExpr(body)).clone_for_update()
444 _ => ast::Expr::BlockExpr(body),
449 fn path_expr_as_record_field(usage: &PathExpr) -> Option<ast::RecordExprField> {
450 let path = usage.path()?;
451 let name_ref = path.as_single_name_ref()?;
452 ast::RecordExprField::for_name_ref(&name_ref)
457 use crate::tests::{check_assist, check_assist_not_applicable};
462 fn no_args_or_return_value_gets_inlined_without_block() {
466 fn foo() { println!("Hello, World!"); }
472 fn foo() { println!("Hello, World!"); }
474 { println!("Hello, World!"); };
481 fn not_applicable_when_incorrect_number_of_parameters_are_provided() {
482 cov_mark::check!(inline_call_incorrect_number_of_arguments);
483 check_assist_not_applicable(
486 fn add(a: u32, b: u32) -> u32 { a + b }
487 fn main() { let x = add$0(42); }
493 fn args_with_side_effects() {
497 fn foo(name: String) {
498 println!("Hello, {}!", name);
501 foo$0(String::from("Michael"));
505 fn foo(name: String) {
506 println!("Hello, {}!", name);
510 let name = String::from("Michael");
511 println!("Hello, {}!", name);
519 fn function_with_multiple_statements() {
523 fn foo(a: u32, b: u32) -> u32 {
534 fn foo(a: u32, b: u32) -> u32 {
553 fn function_with_self_param() {
560 fn add(self, a: u32) -> Self {
566 let x = Foo::add$0(Foo(3), 2);
573 fn add(self, a: u32) -> Self {
596 fn add(self, a: u32) -> Self {
602 let x = Foo(3).add$0(2);
609 fn add(self, a: u32) -> Self {
632 fn add(&self, a: u32) -> Self {
638 let x = Foo(3).add$0(2);
645 fn add(&self, a: u32) -> Self {
652 let ref this = Foo(3);
661 fn method_by_ref_mut() {
668 fn clear(&mut self) {
674 let mut foo = Foo(3);
682 fn clear(&mut self) {
688 let mut foo = Foo(3);
690 let ref mut this = foo;
699 fn function_multi_use_expr_in_param() {
703 fn square(x: u32) -> u32 {
708 let y = square$0(10 + x);
712 fn square(x: u32) -> u32 {
727 fn function_use_local_in_param() {
728 cov_mark::check!(inline_call_inline_locals);
732 fn square(x: u32) -> u32 {
737 let y = square$0(local);
741 fn square(x: u32) -> u32 {
746 let y = local * local;
753 fn method_in_impl() {
788 fn wraps_closure_in_paren() {
789 cov_mark::check!(inline_call_inline_closure);
839 fn inline_single_literal_expr() {
840 cov_mark::check!(inline_call_inline_literal);
844 fn foo(x: u32) -> u32{
853 fn foo(x: u32) -> u32{
865 fn inline_emits_type_for_coercion() {
869 fn foo(x: *const u32) -> u32 {
878 fn foo(x: *const u32) -> u32 {
884 let x: *const u32 = &222;
892 // FIXME: const generics aren't being substituted, this is blocked on better support for them
894 fn inline_substitutes_generics() {
898 fn foo<T, const N: usize>() {
902 fn bar<U, const M: usize>() {}
905 foo$0::<usize, {0}>();
909 fn foo<T, const N: usize>() {
913 fn bar<U, const M: usize>() {}
923 fn inline_callers() {
927 fn do_the_math$0(b: u32) -> u32 {
955 fn inline_callers_across_files() {
961 fn do_the_math$0(b: u32) -> u32 {
966 use super::do_the_math;
994 fn inline_callers_across_files_with_def_file() {
1000 fn do_the_math$0(b: u32) -> u32 {
1004 fn bar(a: u32, b: u32) -> u32 {
1008 use super::do_the_math;
1017 fn bar(a: u32, b: u32) -> u32 {
1035 fn inline_callers_recursive() {
1036 cov_mark::check!(inline_into_callers_recursive);
1037 check_assist_not_applicable(
1038 inline_into_callers,
1048 fn inline_call_recursive() {
1049 cov_mark::check!(inline_call_recursive);
1050 check_assist_not_applicable(
1061 fn inline_call_field_shorthand() {
1062 cov_mark::check!(inline_call_inline_direct_field);
1072 fn foo(field: u32, field1: u32, val2: u32, val3: u32) -> Foo {
1083 foo$0(bar, 0, baz, 0);
1093 fn foo(field: u32, field1: u32, val2: u32, val3: u32) -> Foo {
1116 fn inline_callers_wrapped_in_parentheses() {
1118 inline_into_callers,
1144 fn inline_call_wrapped_in_parentheses() {
1172 fn inline_call_defined_in_macro() {
1173 cov_mark::check!(inline_call_defined_in_macro);
1177 macro_rules! define_foo {
1178 () => { fn foo() -> u32 {
1189 macro_rules! define_foo {
1190 () => { fn foo() -> u32 {
1207 fn inline_call_with_self_type() {
1213 fn f() -> Self { Self(114514) }
1222 fn f() -> Self { Self(114514) }