1 //! FIXME: write short doc here
3 use base_db::SourceDatabaseExt;
4 use hir::{Module, ModuleDef, ModuleSource, Semantics};
6 defs::{classify_name, classify_name_ref, 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);
46 match lex_single_syntax_kind(new_name) {
47 Some(res) => match res {
48 (SyntaxKind::IDENT, _) => (),
49 (SyntaxKind::UNDERSCORE, _) => (),
50 (SyntaxKind::SELF_KW, _) => return rename_to_self(&sema, position),
51 (_, Some(syntax_error)) => {
52 return Err(RenameError(format!("Invalid name `{}`: {}", new_name, syntax_error)))
55 return Err(RenameError(format!("Invalid name `{}`: not an identifier", new_name)))
58 None => return Err(RenameError(format!("Invalid name `{}`: not an identifier", new_name))),
61 let source_file = sema.parse(position.file_id);
62 let syntax = source_file.syntax();
63 if let Some(module) = find_module_at_offset(&sema, position, syntax) {
64 rename_mod(&sema, position, module, new_name)
65 } else if let Some(self_token) =
66 syntax.token_at_offset(position.offset).find(|t| t.kind() == SyntaxKind::SELF_KW)
68 rename_self_to_param(&sema, position, self_token, new_name)
70 rename_reference(&sema, position, new_name)
74 fn find_module_at_offset(
75 sema: &Semantics<RootDatabase>,
76 position: FilePosition,
79 let ident = syntax.token_at_offset(position.offset).find(|t| t.kind() == SyntaxKind::IDENT)?;
81 let module = match_ast! {
82 match (ident.parent()) {
83 ast::NameRef(name_ref) => {
84 match classify_name_ref(sema, &name_ref)? {
85 NameRefClass::Definition(Definition::ModuleDef(ModuleDef::Module(module))) => module,
90 match classify_name(&sema, &name)? {
91 NameClass::Definition(Definition::ModuleDef(ModuleDef::Module(module))) => module,
102 fn source_edit_from_reference(reference: Reference, new_name: &str) -> SourceFileEdit {
103 let mut replacement_text = String::new();
104 let file_id = reference.file_range.file_id;
105 let range = match reference.kind {
106 ReferenceKind::FieldShorthandForField => {
107 mark::hit!(test_rename_struct_field_for_shorthand);
108 replacement_text.push_str(new_name);
109 replacement_text.push_str(": ");
110 TextRange::new(reference.file_range.range.start(), reference.file_range.range.start())
112 ReferenceKind::FieldShorthandForLocal => {
113 mark::hit!(test_rename_local_for_field_shorthand);
114 replacement_text.push_str(": ");
115 replacement_text.push_str(new_name);
116 TextRange::new(reference.file_range.range.end(), reference.file_range.range.end())
119 replacement_text.push_str(new_name);
120 reference.file_range.range
123 SourceFileEdit { file_id, edit: TextEdit::replace(range, replacement_text) }
127 sema: &Semantics<RootDatabase>,
128 position: FilePosition,
131 ) -> Result<RangeInfo<SourceChange>, RenameError> {
132 let mut source_file_edits = Vec::new();
133 let mut file_system_edits = Vec::new();
135 let src = module.definition_source(sema.db);
136 let file_id = src.file_id.original_file(sema.db);
138 ModuleSource::SourceFile(..) => {
139 // mod is defined in path/to/dir/mod.rs
140 let dst = if module.is_mod_rs(sema.db) {
141 format!("../{}/mod.rs", new_name)
143 format!("{}.rs", new_name)
145 let move_file = FileSystemEdit::MoveFile { src: file_id, anchor: file_id, dst };
146 file_system_edits.push(move_file);
148 ModuleSource::Module(..) => {}
151 if let Some(src) = module.declaration_source(sema.db) {
152 let file_id = src.file_id.original_file(sema.db);
153 let name = src.value.name().unwrap();
154 let edit = SourceFileEdit {
156 edit: TextEdit::replace(name.syntax().text_range(), new_name.into()),
158 source_file_edits.push(edit);
161 let RangeInfo { range, info: refs } = find_all_refs(sema, position, None)
162 .ok_or_else(|| RenameError("No references found at position".to_string()))?;
166 .map(|reference| source_edit_from_reference(reference, new_name));
167 source_file_edits.extend(ref_edits);
169 Ok(RangeInfo::new(range, SourceChange::from_edits(source_file_edits, file_system_edits)))
173 sema: &Semantics<RootDatabase>,
174 position: FilePosition,
175 ) -> Result<RangeInfo<SourceChange>, RenameError> {
176 let source_file = sema.parse(position.file_id);
177 let syn = source_file.syntax();
179 let fn_def = find_node_at_offset::<ast::Fn>(syn, position.offset)
180 .ok_or_else(|| RenameError("No surrounding method declaration found".to_string()))?;
182 fn_def.param_list().ok_or_else(|| RenameError("Method has no parameters".to_string()))?;
183 if params.self_param().is_some() {
184 return Err(RenameError("Method already has a self parameter".to_string()));
187 params.params().next().ok_or_else(|| RenameError("Method has no parameters".into()))?;
188 let mutable = match first_param.ty() {
189 Some(ast::Type::RefType(rt)) => rt.mut_token().is_some(),
190 _ => return Err(RenameError("Not renaming other types".to_string())),
193 let RangeInfo { range, info: refs } = find_all_refs(sema, position, None)
194 .ok_or_else(|| RenameError("No reference found at position".to_string()))?;
196 let param_range = first_param.syntax().text_range();
197 let (param_ref, usages): (Vec<Reference>, Vec<Reference>) = refs
199 .partition(|reference| param_range.intersect(reference.file_range.range).is_some());
201 if param_ref.is_empty() {
202 return Err(RenameError("Parameter to rename not found".to_string()));
205 let mut edits = usages
207 .map(|reference| source_edit_from_reference(reference, "self"))
208 .collect::<Vec<_>>();
210 edits.push(SourceFileEdit {
211 file_id: position.file_id,
212 edit: TextEdit::replace(
214 String::from(if mutable { "&mut self" } else { "&self" }),
218 Ok(RangeInfo::new(range, SourceChange::from(edits)))
221 fn text_edit_from_self_param(
223 self_param: &ast::SelfParam,
225 ) -> Option<TextEdit> {
226 fn target_type_name(impl_def: &ast::Impl) -> Option<String> {
227 if let Some(ast::Type::PathType(p)) = impl_def.self_ty() {
228 return Some(p.path()?.segment()?.name_ref()?.text().to_string());
233 let impl_def = find_node_at_offset::<ast::Impl>(syn, self_param.syntax().text_range().start())?;
234 let type_name = target_type_name(&impl_def)?;
236 let mut replacement_text = String::from(new_name);
237 replacement_text.push_str(": ");
238 replacement_text.push_str(self_param.mut_token().map_or("&", |_| "&mut "));
239 replacement_text.push_str(type_name.as_str());
241 Some(TextEdit::replace(self_param.syntax().text_range(), replacement_text))
244 fn rename_self_to_param(
245 sema: &Semantics<RootDatabase>,
246 position: FilePosition,
247 self_token: SyntaxToken,
249 ) -> Result<RangeInfo<SourceChange>, RenameError> {
250 let source_file = sema.parse(position.file_id);
251 let syn = source_file.syntax();
253 let text = sema.db.file_text(position.file_id);
254 let fn_def = find_node_at_offset::<ast::Fn>(syn, position.offset)
255 .ok_or_else(|| RenameError("No surrounding method declaration found".to_string()))?;
256 let search_range = fn_def.syntax().text_range();
258 let mut edits: Vec<SourceFileEdit> = vec![];
260 for (idx, _) in text.match_indices("self") {
261 let offset: TextSize = idx.try_into().unwrap();
262 if !search_range.contains_inclusive(offset) {
265 if let Some(ref usage) =
266 syn.token_at_offset(offset).find(|t| t.kind() == SyntaxKind::SELF_KW)
268 let edit = if let Some(ref self_param) = ast::SelfParam::cast(usage.parent()) {
269 text_edit_from_self_param(syn, self_param, new_name)
270 .ok_or_else(|| RenameError("No target type found".to_string()))?
272 TextEdit::replace(usage.text_range(), String::from(new_name))
274 edits.push(SourceFileEdit { file_id: position.file_id, edit });
278 let range = ast::SelfParam::cast(self_token.parent())
279 .map_or(self_token.text_range(), |p| p.syntax().text_range());
281 Ok(RangeInfo::new(range, SourceChange::from(edits)))
285 sema: &Semantics<RootDatabase>,
286 position: FilePosition,
288 ) -> Result<RangeInfo<SourceChange>, RenameError> {
289 let RangeInfo { range, info: refs } = match find_all_refs(sema, position, None) {
290 Some(range_info) => range_info,
291 None => return Err(RenameError("No references found at position".to_string())),
296 .map(|reference| source_edit_from_reference(reference, new_name))
297 .collect::<Vec<_>>();
300 return Err(RenameError("No references found at position".to_string()));
303 Ok(RangeInfo::new(range, SourceChange::from(edit)))
308 use expect_test::{expect, Expect};
309 use stdx::trim_indent;
310 use test_utils::{assert_eq_text, mark};
311 use text_edit::TextEdit;
313 use crate::{fixture, FileId};
315 fn check(new_name: &str, ra_fixture_before: &str, ra_fixture_after: &str) {
316 let ra_fixture_after = &trim_indent(ra_fixture_after);
317 let (analysis, position) = fixture::position(ra_fixture_before);
318 let rename_result = analysis
319 .rename(position, new_name)
320 .unwrap_or_else(|err| panic!("Rename to '{}' was cancelled: {}", new_name, err));
321 match rename_result {
322 Ok(source_change) => {
323 let mut text_edit_builder = TextEdit::builder();
324 let mut file_id: Option<FileId> = None;
325 for edit in source_change.info.source_file_edits {
326 file_id = Some(edit.file_id);
327 for indel in edit.edit.into_iter() {
328 text_edit_builder.replace(indel.delete, indel.insert);
331 let mut result = analysis.file_text(file_id.unwrap()).unwrap().to_string();
332 text_edit_builder.finish().apply(&mut result);
333 assert_eq_text!(ra_fixture_after, &*result);
336 if ra_fixture_after.starts_with("error:") {
337 let error_message = ra_fixture_after
340 .skip("error:".len())
341 .collect::<String>();
342 assert_eq!(error_message.trim(), err.to_string());
345 panic!("Rename to '{}' failed unexpectedly: {}", new_name, err)
351 fn check_expect(new_name: &str, ra_fixture: &str, expect: Expect) {
352 let (analysis, position) = fixture::position(ra_fixture);
353 let source_change = analysis
354 .rename(position, new_name)
356 .expect("Expect returned RangeInfo to be Some, but was None");
357 expect.assert_debug_eq(&source_change)
361 fn test_rename_to_underscore() {
362 check("_", r#"fn main() { let i<|> = 1; }"#, r#"fn main() { let _ = 1; }"#);
366 fn test_rename_to_raw_identifier() {
367 check("r#fn", r#"fn main() { let i<|> = 1; }"#, r#"fn main() { let r#fn = 1; }"#);
371 fn test_rename_to_invalid_identifier1() {
374 r#"fn main() { let i<|> = 1; }"#,
375 "error: Invalid name `invalid!`: not an identifier",
380 fn test_rename_to_invalid_identifier2() {
383 r#"fn main() { let i<|> = 1; }"#,
384 "error: Invalid name `multiple tokens`: not an identifier",
389 fn test_rename_to_invalid_identifier3() {
392 r#"fn main() { let i<|> = 1; }"#,
393 "error: Invalid name `let`: not an identifier",
398 fn test_rename_for_local() {
427 fn test_rename_unresolved_reference() {
430 r#"fn main() { let _ = unresolved_ref<|>; }"#,
431 "error: No references found at position",
436 fn test_rename_for_macro_args() {
440 macro_rules! foo {($i:ident) => {$i} }
447 macro_rules! foo {($i:ident) => {$i} }
457 fn test_rename_for_macro_args_rev() {
461 macro_rules! foo {($i:ident) => {$i} }
468 macro_rules! foo {($i:ident) => {$i} }
478 fn test_rename_for_macro_define_fn() {
482 macro_rules! define_fn {($id:ident) => { fn $id{} }}
489 macro_rules! define_fn {($id:ident) => { fn $id{} }}
499 fn test_rename_for_macro_define_fn_rev() {
503 macro_rules! define_fn {($id:ident) => { fn $id{} }}
510 macro_rules! define_fn {($id:ident) => { fn $id{} }}
520 fn test_rename_for_param_inside() {
521 check("j", r#"fn foo(i : u32) -> u32 { i<|> }"#, r#"fn foo(j : u32) -> u32 { j }"#);
525 fn test_rename_refs_for_fn_param() {
526 check("j", r#"fn foo(i<|> : u32) -> u32 { i }"#, r#"fn foo(j : u32) -> u32 { j }"#);
530 fn test_rename_for_mut_param() {
531 check("j", r#"fn foo(mut i<|> : u32) -> u32 { i }"#, r#"fn foo(mut j : u32) -> u32 { j }"#);
535 fn test_rename_struct_field() {
539 struct Foo { i<|>: i32 }
542 fn new(i: i32) -> Self {
548 struct Foo { j: i32 }
551 fn new(i: i32) -> Self {
560 fn test_rename_struct_field_for_shorthand() {
561 mark::check!(test_rename_struct_field_for_shorthand);
565 struct Foo { i<|>: i32 }
568 fn new(i: i32) -> Self {
574 struct Foo { j: i32 }
577 fn new(i: i32) -> Self {
586 fn test_rename_local_for_field_shorthand() {
587 mark::check!(test_rename_local_for_field_shorthand);
591 struct Foo { i: i32 }
594 fn new(i<|>: i32) -> Self {
600 struct Foo { i: i32 }
603 fn new(j: i32) -> Self {
612 fn test_field_shorthand_correct_struct() {
616 struct Foo { i<|>: i32 }
617 struct Bar { i: i32 }
620 fn new(i: i32) -> Self {
626 struct Foo { j: i32 }
627 struct Bar { i: i32 }
630 fn new(i: i32) -> Self {
639 fn test_shadow_local_for_struct_shorthand() {
643 struct Foo { i: i32 }
645 fn baz(i<|>: i32) -> Self {
654 struct Foo { i: i32 }
656 fn baz(j: i32) -> Self {
657 let x = Foo { i: j };
668 fn test_rename_mod() {
719 fn test_rename_mod_in_use_tree() {
729 pub struct FooContent;
732 use crate::foo<|>::FooContent;
785 fn test_rename_mod_in_dir() {
821 dst: "../foo2/mod.rs",
832 fn test_rename_unusually_nested_mod() {
837 mod outer { mod fo<|>o; }
880 fn test_module_rename_in_path() {
884 mod <|>foo { pub fn bar() {} }
886 fn main() { foo::bar(); }
889 mod baz { pub fn bar() {} }
891 fn main() { baz::bar(); }
897 fn test_rename_mod_filename_and_path() {
964 fn test_enum_variant_from_module_1() {
969 pub enum Foo { Bar<|> }
972 fn func(f: foo::Foo) {
983 fn func(f: foo::Foo) {
993 fn test_enum_variant_from_module_2() {
998 pub struct Foo { pub bar<|>: uint }
1001 fn foo(f: foo::Foo) {
1007 pub struct Foo { pub baz: uint }
1010 fn foo(f: foo::Foo) {
1018 fn test_parameter_to_self() {
1022 struct Foo { i: i32 }
1025 fn f(foo<|>: &mut Foo) -> i32 {
1031 struct Foo { i: i32 }
1034 fn f(&mut self) -> i32 {
1043 fn test_self_to_parameter() {
1047 struct Foo { i: i32 }
1050 fn f(&mut <|>self) -> i32 {
1056 struct Foo { i: i32 }
1059 fn f(foo: &mut Foo) -> i32 {
1068 fn test_self_in_path_to_parameter() {
1072 struct Foo { i: i32 }
1075 fn f(&self) -> i32 {
1082 struct Foo { i: i32 }
1085 fn f(foo: &Foo) -> i32 {