1 //! FIXME: write short doc here
3 use base_db::SourceDatabaseExt;
4 use hir::{Module, ModuleDef, ModuleSource, Semantics};
6 defs::{Definition, NameClass, NameRefClass},
16 algo::find_node_at_offset,
17 ast::{self, NameOwner},
18 lex_single_syntax_kind, match_ast, AstNode, SyntaxKind, SyntaxNode, SyntaxToken,
21 use text_edit::TextEdit;
24 references::find_all_refs, FilePosition, FileSystemEdit, RangeInfo, Reference, ReferenceKind,
25 SourceChange, SourceFileEdit, TextRange, TextSize,
29 pub struct RenameError(pub(crate) String);
31 impl fmt::Display for RenameError {
32 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
33 Display::fmt(&self.0, f)
37 impl Error for RenameError {}
41 position: FilePosition,
43 ) -> Result<RangeInfo<SourceChange>, RenameError> {
44 let sema = Semantics::new(db);
45 rename_with_semantics(&sema, position, new_name)
48 pub(crate) fn rename_with_semantics(
49 sema: &Semantics<RootDatabase>,
50 position: FilePosition,
52 ) -> Result<RangeInfo<SourceChange>, RenameError> {
53 match lex_single_syntax_kind(new_name) {
54 Some(res) => match res {
55 (SyntaxKind::IDENT, _) => (),
56 (SyntaxKind::UNDERSCORE, _) => (),
57 (SyntaxKind::SELF_KW, _) => return rename_to_self(&sema, position),
58 (_, Some(syntax_error)) => {
59 return Err(RenameError(format!("Invalid name `{}`: {}", new_name, syntax_error)))
62 return Err(RenameError(format!("Invalid name `{}`: not an identifier", new_name)))
65 None => return Err(RenameError(format!("Invalid name `{}`: not an identifier", new_name))),
68 let source_file = sema.parse(position.file_id);
69 let syntax = source_file.syntax();
70 if let Some(module) = find_module_at_offset(&sema, position, syntax) {
71 rename_mod(&sema, position, module, new_name)
72 } else if let Some(self_token) =
73 syntax.token_at_offset(position.offset).find(|t| t.kind() == SyntaxKind::SELF_KW)
75 rename_self_to_param(&sema, position, self_token, new_name)
77 rename_reference(&sema, position, new_name)
81 fn find_module_at_offset(
82 sema: &Semantics<RootDatabase>,
83 position: FilePosition,
86 let ident = syntax.token_at_offset(position.offset).find(|t| t.kind() == SyntaxKind::IDENT)?;
88 let module = match_ast! {
89 match (ident.parent()) {
90 ast::NameRef(name_ref) => {
91 match NameRefClass::classify(sema, &name_ref)? {
92 NameRefClass::Definition(Definition::ModuleDef(ModuleDef::Module(module))) => module,
97 match NameClass::classify(&sema, &name)? {
98 NameClass::Definition(Definition::ModuleDef(ModuleDef::Module(module))) => module,
109 fn source_edit_from_reference(reference: Reference, new_name: &str) -> SourceFileEdit {
110 let mut replacement_text = String::new();
111 let file_id = reference.file_range.file_id;
112 let range = match reference.kind {
113 ReferenceKind::FieldShorthandForField => {
114 mark::hit!(test_rename_struct_field_for_shorthand);
115 replacement_text.push_str(new_name);
116 replacement_text.push_str(": ");
117 TextRange::new(reference.file_range.range.start(), reference.file_range.range.start())
119 ReferenceKind::FieldShorthandForLocal => {
120 mark::hit!(test_rename_local_for_field_shorthand);
121 replacement_text.push_str(": ");
122 replacement_text.push_str(new_name);
123 TextRange::new(reference.file_range.range.end(), reference.file_range.range.end())
126 replacement_text.push_str(new_name);
127 reference.file_range.range
130 SourceFileEdit { file_id, edit: TextEdit::replace(range, replacement_text) }
134 sema: &Semantics<RootDatabase>,
135 position: FilePosition,
138 ) -> Result<RangeInfo<SourceChange>, RenameError> {
139 let mut source_file_edits = Vec::new();
140 let mut file_system_edits = Vec::new();
142 let src = module.definition_source(sema.db);
143 let file_id = src.file_id.original_file(sema.db);
145 ModuleSource::SourceFile(..) => {
146 // mod is defined in path/to/dir/mod.rs
147 let dst = if module.is_mod_rs(sema.db) {
148 format!("../{}/mod.rs", new_name)
150 format!("{}.rs", new_name)
152 let move_file = FileSystemEdit::MoveFile { src: file_id, anchor: file_id, dst };
153 file_system_edits.push(move_file);
155 ModuleSource::Module(..) => {}
158 if let Some(src) = module.declaration_source(sema.db) {
159 let file_id = src.file_id.original_file(sema.db);
160 let name = src.value.name().unwrap();
161 let edit = SourceFileEdit {
163 edit: TextEdit::replace(name.syntax().text_range(), new_name.into()),
165 source_file_edits.push(edit);
168 let RangeInfo { range, info: refs } = find_all_refs(sema, position, None)
169 .ok_or_else(|| RenameError("No references found at position".to_string()))?;
173 .map(|reference| source_edit_from_reference(reference, new_name));
174 source_file_edits.extend(ref_edits);
176 Ok(RangeInfo::new(range, SourceChange::from_edits(source_file_edits, file_system_edits)))
180 sema: &Semantics<RootDatabase>,
181 position: FilePosition,
182 ) -> Result<RangeInfo<SourceChange>, RenameError> {
183 let source_file = sema.parse(position.file_id);
184 let syn = source_file.syntax();
186 let fn_def = find_node_at_offset::<ast::Fn>(syn, position.offset)
187 .ok_or_else(|| RenameError("No surrounding method declaration found".to_string()))?;
189 fn_def.param_list().ok_or_else(|| RenameError("Method has no parameters".to_string()))?;
190 if params.self_param().is_some() {
191 return Err(RenameError("Method already has a self parameter".to_string()));
194 params.params().next().ok_or_else(|| RenameError("Method has no parameters".into()))?;
195 let mutable = match first_param.ty() {
196 Some(ast::Type::RefType(rt)) => rt.mut_token().is_some(),
197 _ => return Err(RenameError("Not renaming other types".to_string())),
200 let RangeInfo { range, info: refs } = find_all_refs(sema, position, None)
201 .ok_or_else(|| RenameError("No reference found at position".to_string()))?;
203 let param_range = first_param.syntax().text_range();
204 let (param_ref, usages): (Vec<Reference>, Vec<Reference>) = refs
206 .partition(|reference| param_range.intersect(reference.file_range.range).is_some());
208 if param_ref.is_empty() {
209 return Err(RenameError("Parameter to rename not found".to_string()));
212 let mut edits = usages
214 .map(|reference| source_edit_from_reference(reference, "self"))
215 .collect::<Vec<_>>();
217 edits.push(SourceFileEdit {
218 file_id: position.file_id,
219 edit: TextEdit::replace(
221 String::from(if mutable { "&mut self" } else { "&self" }),
225 Ok(RangeInfo::new(range, SourceChange::from(edits)))
228 fn text_edit_from_self_param(
230 self_param: &ast::SelfParam,
232 ) -> Option<TextEdit> {
233 fn target_type_name(impl_def: &ast::Impl) -> Option<String> {
234 if let Some(ast::Type::PathType(p)) = impl_def.self_ty() {
235 return Some(p.path()?.segment()?.name_ref()?.text().to_string());
240 let impl_def = find_node_at_offset::<ast::Impl>(syn, self_param.syntax().text_range().start())?;
241 let type_name = target_type_name(&impl_def)?;
243 let mut replacement_text = String::from(new_name);
244 replacement_text.push_str(": ");
245 replacement_text.push_str(self_param.mut_token().map_or("&", |_| "&mut "));
246 replacement_text.push_str(type_name.as_str());
248 Some(TextEdit::replace(self_param.syntax().text_range(), replacement_text))
251 fn rename_self_to_param(
252 sema: &Semantics<RootDatabase>,
253 position: FilePosition,
254 self_token: SyntaxToken,
256 ) -> Result<RangeInfo<SourceChange>, RenameError> {
257 let source_file = sema.parse(position.file_id);
258 let syn = source_file.syntax();
260 let text = sema.db.file_text(position.file_id);
261 let fn_def = find_node_at_offset::<ast::Fn>(syn, position.offset)
262 .ok_or_else(|| RenameError("No surrounding method declaration found".to_string()))?;
263 let search_range = fn_def.syntax().text_range();
265 let mut edits: Vec<SourceFileEdit> = vec![];
267 for (idx, _) in text.match_indices("self") {
268 let offset: TextSize = idx.try_into().unwrap();
269 if !search_range.contains_inclusive(offset) {
272 if let Some(ref usage) =
273 syn.token_at_offset(offset).find(|t| t.kind() == SyntaxKind::SELF_KW)
275 let edit = if let Some(ref self_param) = ast::SelfParam::cast(usage.parent()) {
276 text_edit_from_self_param(syn, self_param, new_name)
277 .ok_or_else(|| RenameError("No target type found".to_string()))?
279 TextEdit::replace(usage.text_range(), String::from(new_name))
281 edits.push(SourceFileEdit { file_id: position.file_id, edit });
285 let range = ast::SelfParam::cast(self_token.parent())
286 .map_or(self_token.text_range(), |p| p.syntax().text_range());
288 Ok(RangeInfo::new(range, SourceChange::from(edits)))
292 sema: &Semantics<RootDatabase>,
293 position: FilePosition,
295 ) -> Result<RangeInfo<SourceChange>, RenameError> {
296 let RangeInfo { range, info: refs } = match find_all_refs(sema, position, None) {
297 Some(range_info) => range_info,
298 None => return Err(RenameError("No references found at position".to_string())),
303 .map(|reference| source_edit_from_reference(reference, new_name))
304 .collect::<Vec<_>>();
307 return Err(RenameError("No references found at position".to_string()));
310 Ok(RangeInfo::new(range, SourceChange::from(edit)))
315 use expect_test::{expect, Expect};
316 use stdx::trim_indent;
317 use test_utils::{assert_eq_text, mark};
318 use text_edit::TextEdit;
320 use crate::{fixture, FileId};
322 fn check(new_name: &str, ra_fixture_before: &str, ra_fixture_after: &str) {
323 let ra_fixture_after = &trim_indent(ra_fixture_after);
324 let (analysis, position) = fixture::position(ra_fixture_before);
325 let rename_result = analysis
326 .rename(position, new_name)
327 .unwrap_or_else(|err| panic!("Rename to '{}' was cancelled: {}", new_name, err));
328 match rename_result {
329 Ok(source_change) => {
330 let mut text_edit_builder = TextEdit::builder();
331 let mut file_id: Option<FileId> = None;
332 for edit in source_change.info.source_file_edits {
333 file_id = Some(edit.file_id);
334 for indel in edit.edit.into_iter() {
335 text_edit_builder.replace(indel.delete, indel.insert);
338 let mut result = analysis.file_text(file_id.unwrap()).unwrap().to_string();
339 text_edit_builder.finish().apply(&mut result);
340 assert_eq_text!(ra_fixture_after, &*result);
343 if ra_fixture_after.starts_with("error:") {
344 let error_message = ra_fixture_after
347 .skip("error:".len())
348 .collect::<String>();
349 assert_eq!(error_message.trim(), err.to_string());
352 panic!("Rename to '{}' failed unexpectedly: {}", new_name, err)
358 fn check_expect(new_name: &str, ra_fixture: &str, expect: Expect) {
359 let (analysis, position) = fixture::position(ra_fixture);
360 let source_change = analysis
361 .rename(position, new_name)
363 .expect("Expect returned RangeInfo to be Some, but was None");
364 expect.assert_debug_eq(&source_change)
368 fn test_rename_to_underscore() {
369 check("_", r#"fn main() { let i<|> = 1; }"#, r#"fn main() { let _ = 1; }"#);
373 fn test_rename_to_raw_identifier() {
374 check("r#fn", r#"fn main() { let i<|> = 1; }"#, r#"fn main() { let r#fn = 1; }"#);
378 fn test_rename_to_invalid_identifier1() {
381 r#"fn main() { let i<|> = 1; }"#,
382 "error: Invalid name `invalid!`: not an identifier",
387 fn test_rename_to_invalid_identifier2() {
390 r#"fn main() { let i<|> = 1; }"#,
391 "error: Invalid name `multiple tokens`: not an identifier",
396 fn test_rename_to_invalid_identifier3() {
399 r#"fn main() { let i<|> = 1; }"#,
400 "error: Invalid name `let`: not an identifier",
405 fn test_rename_for_local() {
434 fn test_rename_unresolved_reference() {
437 r#"fn main() { let _ = unresolved_ref<|>; }"#,
438 "error: No references found at position",
443 fn test_rename_for_macro_args() {
447 macro_rules! foo {($i:ident) => {$i} }
454 macro_rules! foo {($i:ident) => {$i} }
464 fn test_rename_for_macro_args_rev() {
468 macro_rules! foo {($i:ident) => {$i} }
475 macro_rules! foo {($i:ident) => {$i} }
485 fn test_rename_for_macro_define_fn() {
489 macro_rules! define_fn {($id:ident) => { fn $id{} }}
496 macro_rules! define_fn {($id:ident) => { fn $id{} }}
506 fn test_rename_for_macro_define_fn_rev() {
510 macro_rules! define_fn {($id:ident) => { fn $id{} }}
517 macro_rules! define_fn {($id:ident) => { fn $id{} }}
527 fn test_rename_for_param_inside() {
528 check("j", r#"fn foo(i : u32) -> u32 { i<|> }"#, r#"fn foo(j : u32) -> u32 { j }"#);
532 fn test_rename_refs_for_fn_param() {
533 check("j", r#"fn foo(i<|> : u32) -> u32 { i }"#, r#"fn foo(j : u32) -> u32 { j }"#);
537 fn test_rename_for_mut_param() {
538 check("j", r#"fn foo(mut i<|> : u32) -> u32 { i }"#, r#"fn foo(mut j : u32) -> u32 { j }"#);
542 fn test_rename_struct_field() {
546 struct Foo { i<|>: i32 }
549 fn new(i: i32) -> Self {
555 struct Foo { j: i32 }
558 fn new(i: i32) -> Self {
567 fn test_rename_struct_field_for_shorthand() {
568 mark::check!(test_rename_struct_field_for_shorthand);
572 struct Foo { i<|>: i32 }
575 fn new(i: i32) -> Self {
581 struct Foo { j: i32 }
584 fn new(i: i32) -> Self {
593 fn test_rename_local_for_field_shorthand() {
594 mark::check!(test_rename_local_for_field_shorthand);
598 struct Foo { i: i32 }
601 fn new(i<|>: i32) -> Self {
607 struct Foo { i: i32 }
610 fn new(j: i32) -> Self {
619 fn test_field_shorthand_correct_struct() {
623 struct Foo { i<|>: i32 }
624 struct Bar { i: i32 }
627 fn new(i: i32) -> Self {
633 struct Foo { j: i32 }
634 struct Bar { i: i32 }
637 fn new(i: i32) -> Self {
646 fn test_shadow_local_for_struct_shorthand() {
650 struct Foo { i: i32 }
652 fn baz(i<|>: i32) -> Self {
661 struct Foo { i: i32 }
663 fn baz(j: i32) -> Self {
664 let x = Foo { i: j };
675 fn test_rename_mod() {
726 fn test_rename_mod_in_use_tree() {
736 pub struct FooContent;
739 use crate::foo<|>::FooContent;
792 fn test_rename_mod_in_dir() {
828 dst: "../foo2/mod.rs",
839 fn test_rename_unusually_nested_mod() {
844 mod outer { mod fo<|>o; }
887 fn test_module_rename_in_path() {
891 mod <|>foo { pub fn bar() {} }
893 fn main() { foo::bar(); }
896 mod baz { pub fn bar() {} }
898 fn main() { baz::bar(); }
904 fn test_rename_mod_filename_and_path() {
971 fn test_enum_variant_from_module_1() {
976 pub enum Foo { Bar<|> }
979 fn func(f: foo::Foo) {
990 fn func(f: foo::Foo) {
1000 fn test_enum_variant_from_module_2() {
1005 pub struct Foo { pub bar<|>: uint }
1008 fn foo(f: foo::Foo) {
1014 pub struct Foo { pub baz: uint }
1017 fn foo(f: foo::Foo) {
1025 fn test_parameter_to_self() {
1029 struct Foo { i: i32 }
1032 fn f(foo<|>: &mut Foo) -> i32 {
1038 struct Foo { i: i32 }
1041 fn f(&mut self) -> i32 {
1050 fn test_self_to_parameter() {
1054 struct Foo { i: i32 }
1057 fn f(&mut <|>self) -> i32 {
1063 struct Foo { i: i32 }
1066 fn f(foo: &mut Foo) -> i32 {
1075 fn test_self_in_path_to_parameter() {
1079 struct Foo { i: i32 }
1082 fn f(&self) -> i32 {
1089 struct Foo { i: i32 }
1092 fn f(foo: &Foo) -> i32 {