1 //! FIXME: write short doc here
3 use hir::{Module, ModuleDef, ModuleSource, Semantics};
4 use ide_db::base_db::SourceDatabaseExt;
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(
110 sema: &Semantics<RootDatabase>,
111 reference: Reference,
113 ) -> SourceFileEdit {
114 let mut replacement_text = String::new();
115 let file_id = reference.file_range.file_id;
116 let range = match reference.kind {
117 ReferenceKind::FieldShorthandForField => {
118 mark::hit!(test_rename_struct_field_for_shorthand);
119 replacement_text.push_str(new_name);
120 replacement_text.push_str(": ");
121 TextRange::new(reference.file_range.range.start(), reference.file_range.range.start())
123 ReferenceKind::FieldShorthandForLocal => {
124 mark::hit!(test_rename_local_for_field_shorthand);
125 replacement_text.push_str(": ");
126 replacement_text.push_str(new_name);
127 TextRange::new(reference.file_range.range.end(), reference.file_range.range.end())
129 ReferenceKind::RecordExprField => {
130 replacement_text.push_str(new_name);
131 let mut range = reference.file_range.range;
132 if let Some(field_expr) = syntax::algo::find_node_at_range::<ast::RecordExprField>(
133 sema.parse(file_id).syntax(),
134 reference.file_range.range,
136 // use shorthand initializer if we were to write foo: foo
137 if let Some(name) = field_expr.expr().and_then(|e| e.name_ref()) {
138 if &name.to_string() == new_name {
139 range = field_expr.syntax().text_range();
146 replacement_text.push_str(new_name);
147 reference.file_range.range
150 SourceFileEdit { file_id, edit: TextEdit::replace(range, replacement_text) }
154 sema: &Semantics<RootDatabase>,
155 position: FilePosition,
158 ) -> Result<RangeInfo<SourceChange>, RenameError> {
159 let mut source_file_edits = Vec::new();
160 let mut file_system_edits = Vec::new();
162 let src = module.definition_source(sema.db);
163 let file_id = src.file_id.original_file(sema.db);
165 ModuleSource::SourceFile(..) => {
166 // mod is defined in path/to/dir/mod.rs
167 let dst = if module.is_mod_rs(sema.db) {
168 format!("../{}/mod.rs", new_name)
170 format!("{}.rs", new_name)
172 let move_file = FileSystemEdit::MoveFile { src: file_id, anchor: file_id, dst };
173 file_system_edits.push(move_file);
175 ModuleSource::Module(..) => {}
178 if let Some(src) = module.declaration_source(sema.db) {
179 let file_id = src.file_id.original_file(sema.db);
180 let name = src.value.name().unwrap();
181 let edit = SourceFileEdit {
183 edit: TextEdit::replace(name.syntax().text_range(), new_name.into()),
185 source_file_edits.push(edit);
188 let RangeInfo { range, info: refs } = find_all_refs(sema, position, None)
189 .ok_or_else(|| RenameError("No references found at position".to_string()))?;
193 .map(|reference| source_edit_from_reference(sema, reference, new_name));
194 source_file_edits.extend(ref_edits);
196 Ok(RangeInfo::new(range, SourceChange::from_edits(source_file_edits, file_system_edits)))
200 sema: &Semantics<RootDatabase>,
201 position: FilePosition,
202 ) -> Result<RangeInfo<SourceChange>, RenameError> {
203 let source_file = sema.parse(position.file_id);
204 let syn = source_file.syntax();
206 let fn_def = find_node_at_offset::<ast::Fn>(syn, position.offset)
207 .ok_or_else(|| RenameError("No surrounding method declaration found".to_string()))?;
209 fn_def.param_list().ok_or_else(|| RenameError("Method has no parameters".to_string()))?;
210 if params.self_param().is_some() {
211 return Err(RenameError("Method already has a self parameter".to_string()));
214 params.params().next().ok_or_else(|| RenameError("Method has no parameters".into()))?;
215 let mutable = match first_param.ty() {
216 Some(ast::Type::RefType(rt)) => rt.mut_token().is_some(),
217 _ => return Err(RenameError("Not renaming other types".to_string())),
220 let RangeInfo { range, info: refs } = find_all_refs(sema, position, None)
221 .ok_or_else(|| RenameError("No reference found at position".to_string()))?;
223 let param_range = first_param.syntax().text_range();
224 let (param_ref, usages): (Vec<Reference>, Vec<Reference>) = refs
226 .partition(|reference| param_range.intersect(reference.file_range.range).is_some());
228 if param_ref.is_empty() {
229 return Err(RenameError("Parameter to rename not found".to_string()));
232 let mut edits = usages
234 .map(|reference| source_edit_from_reference(sema, reference, "self"))
235 .collect::<Vec<_>>();
237 edits.push(SourceFileEdit {
238 file_id: position.file_id,
239 edit: TextEdit::replace(
241 String::from(if mutable { "&mut self" } else { "&self" }),
245 Ok(RangeInfo::new(range, SourceChange::from(edits)))
248 fn text_edit_from_self_param(
250 self_param: &ast::SelfParam,
252 ) -> Option<TextEdit> {
253 fn target_type_name(impl_def: &ast::Impl) -> Option<String> {
254 if let Some(ast::Type::PathType(p)) = impl_def.self_ty() {
255 return Some(p.path()?.segment()?.name_ref()?.text().to_string());
260 let impl_def = find_node_at_offset::<ast::Impl>(syn, self_param.syntax().text_range().start())?;
261 let type_name = target_type_name(&impl_def)?;
263 let mut replacement_text = String::from(new_name);
264 replacement_text.push_str(": ");
265 replacement_text.push_str(self_param.mut_token().map_or("&", |_| "&mut "));
266 replacement_text.push_str(type_name.as_str());
268 Some(TextEdit::replace(self_param.syntax().text_range(), replacement_text))
271 fn rename_self_to_param(
272 sema: &Semantics<RootDatabase>,
273 position: FilePosition,
274 self_token: SyntaxToken,
276 ) -> Result<RangeInfo<SourceChange>, RenameError> {
277 let source_file = sema.parse(position.file_id);
278 let syn = source_file.syntax();
280 let text = sema.db.file_text(position.file_id);
281 let fn_def = find_node_at_offset::<ast::Fn>(syn, position.offset)
282 .ok_or_else(|| RenameError("No surrounding method declaration found".to_string()))?;
283 let search_range = fn_def.syntax().text_range();
285 let mut edits: Vec<SourceFileEdit> = vec![];
287 for (idx, _) in text.match_indices("self") {
288 let offset: TextSize = idx.try_into().unwrap();
289 if !search_range.contains_inclusive(offset) {
292 if let Some(ref usage) =
293 syn.token_at_offset(offset).find(|t| t.kind() == SyntaxKind::SELF_KW)
295 let edit = if let Some(ref self_param) = ast::SelfParam::cast(usage.parent()) {
296 text_edit_from_self_param(syn, self_param, new_name)
297 .ok_or_else(|| RenameError("No target type found".to_string()))?
299 TextEdit::replace(usage.text_range(), String::from(new_name))
301 edits.push(SourceFileEdit { file_id: position.file_id, edit });
305 let range = ast::SelfParam::cast(self_token.parent())
306 .map_or(self_token.text_range(), |p| p.syntax().text_range());
308 Ok(RangeInfo::new(range, SourceChange::from(edits)))
312 sema: &Semantics<RootDatabase>,
313 position: FilePosition,
315 ) -> Result<RangeInfo<SourceChange>, RenameError> {
316 let RangeInfo { range, info: refs } = match find_all_refs(sema, position, None) {
317 Some(range_info) => range_info,
318 None => return Err(RenameError("No references found at position".to_string())),
323 .map(|reference| source_edit_from_reference(sema, reference, new_name))
324 .collect::<Vec<_>>();
327 return Err(RenameError("No references found at position".to_string()));
330 Ok(RangeInfo::new(range, SourceChange::from(edit)))
335 use expect_test::{expect, Expect};
336 use stdx::trim_indent;
337 use test_utils::{assert_eq_text, mark};
338 use text_edit::TextEdit;
340 use crate::{fixture, FileId};
342 fn check(new_name: &str, ra_fixture_before: &str, ra_fixture_after: &str) {
343 let ra_fixture_after = &trim_indent(ra_fixture_after);
344 let (analysis, position) = fixture::position(ra_fixture_before);
345 let rename_result = analysis
346 .rename(position, new_name)
347 .unwrap_or_else(|err| panic!("Rename to '{}' was cancelled: {}", new_name, err));
348 match rename_result {
349 Ok(source_change) => {
350 let mut text_edit_builder = TextEdit::builder();
351 let mut file_id: Option<FileId> = None;
352 for edit in source_change.info.source_file_edits {
353 file_id = Some(edit.file_id);
354 for indel in edit.edit.into_iter() {
355 text_edit_builder.replace(indel.delete, indel.insert);
358 let mut result = analysis.file_text(file_id.unwrap()).unwrap().to_string();
359 text_edit_builder.finish().apply(&mut result);
360 assert_eq_text!(ra_fixture_after, &*result);
363 if ra_fixture_after.starts_with("error:") {
364 let error_message = ra_fixture_after
367 .skip("error:".len())
368 .collect::<String>();
369 assert_eq!(error_message.trim(), err.to_string());
372 panic!("Rename to '{}' failed unexpectedly: {}", new_name, err)
378 fn check_expect(new_name: &str, ra_fixture: &str, expect: Expect) {
379 let (analysis, position) = fixture::position(ra_fixture);
380 let source_change = analysis
381 .rename(position, new_name)
383 .expect("Expect returned RangeInfo to be Some, but was None");
384 expect.assert_debug_eq(&source_change)
388 fn test_rename_to_underscore() {
389 check("_", r#"fn main() { let i<|> = 1; }"#, r#"fn main() { let _ = 1; }"#);
393 fn test_rename_to_raw_identifier() {
394 check("r#fn", r#"fn main() { let i<|> = 1; }"#, r#"fn main() { let r#fn = 1; }"#);
398 fn test_rename_to_invalid_identifier1() {
401 r#"fn main() { let i<|> = 1; }"#,
402 "error: Invalid name `invalid!`: not an identifier",
407 fn test_rename_to_invalid_identifier2() {
410 r#"fn main() { let i<|> = 1; }"#,
411 "error: Invalid name `multiple tokens`: not an identifier",
416 fn test_rename_to_invalid_identifier3() {
419 r#"fn main() { let i<|> = 1; }"#,
420 "error: Invalid name `let`: not an identifier",
425 fn test_rename_for_local() {
454 fn test_rename_unresolved_reference() {
457 r#"fn main() { let _ = unresolved_ref<|>; }"#,
458 "error: No references found at position",
463 fn test_rename_for_macro_args() {
467 macro_rules! foo {($i:ident) => {$i} }
474 macro_rules! foo {($i:ident) => {$i} }
484 fn test_rename_for_macro_args_rev() {
488 macro_rules! foo {($i:ident) => {$i} }
495 macro_rules! foo {($i:ident) => {$i} }
505 fn test_rename_for_macro_define_fn() {
509 macro_rules! define_fn {($id:ident) => { fn $id{} }}
516 macro_rules! define_fn {($id:ident) => { fn $id{} }}
526 fn test_rename_for_macro_define_fn_rev() {
530 macro_rules! define_fn {($id:ident) => { fn $id{} }}
537 macro_rules! define_fn {($id:ident) => { fn $id{} }}
547 fn test_rename_for_param_inside() {
548 check("j", r#"fn foo(i : u32) -> u32 { i<|> }"#, r#"fn foo(j : u32) -> u32 { j }"#);
552 fn test_rename_refs_for_fn_param() {
553 check("j", r#"fn foo(i<|> : u32) -> u32 { i }"#, r#"fn foo(j : u32) -> u32 { j }"#);
557 fn test_rename_for_mut_param() {
558 check("j", r#"fn foo(mut i<|> : u32) -> u32 { i }"#, r#"fn foo(mut j : u32) -> u32 { j }"#);
562 fn test_rename_struct_field() {
566 struct Foo { i<|>: i32 }
569 fn new(i: i32) -> Self {
575 struct Foo { j: i32 }
578 fn new(i: i32) -> Self {
587 fn test_rename_struct_field_for_shorthand() {
588 mark::check!(test_rename_struct_field_for_shorthand);
592 struct Foo { i<|>: i32 }
595 fn new(i: i32) -> Self {
601 struct Foo { j: i32 }
604 fn new(i: i32) -> Self {
613 fn test_rename_local_for_field_shorthand() {
614 mark::check!(test_rename_local_for_field_shorthand);
618 struct Foo { i: i32 }
621 fn new(i<|>: i32) -> Self {
627 struct Foo { i: i32 }
630 fn new(j: i32) -> Self {
639 fn test_field_shorthand_correct_struct() {
643 struct Foo { i<|>: i32 }
644 struct Bar { i: i32 }
647 fn new(i: i32) -> Self {
653 struct Foo { j: i32 }
654 struct Bar { i: i32 }
657 fn new(i: i32) -> Self {
666 fn test_shadow_local_for_struct_shorthand() {
670 struct Foo { i: i32 }
672 fn baz(i<|>: i32) -> Self {
681 struct Foo { i: i32 }
683 fn baz(j: i32) -> Self {
684 let x = Foo { i: j };
695 fn test_rename_mod() {
746 fn test_rename_mod_in_use_tree() {
756 pub struct FooContent;
759 use crate::foo<|>::FooContent;
812 fn test_rename_mod_in_dir() {
848 dst: "../foo2/mod.rs",
859 fn test_rename_unusually_nested_mod() {
864 mod outer { mod fo<|>o; }
907 fn test_module_rename_in_path() {
911 mod <|>foo { pub fn bar() {} }
913 fn main() { foo::bar(); }
916 mod baz { pub fn bar() {} }
918 fn main() { baz::bar(); }
924 fn test_rename_mod_filename_and_path() {
991 fn test_enum_variant_from_module_1() {
996 pub enum Foo { Bar<|> }
999 fn func(f: foo::Foo) {
1007 pub enum Foo { Baz }
1010 fn func(f: foo::Foo) {
1020 fn test_enum_variant_from_module_2() {
1025 pub struct Foo { pub bar<|>: uint }
1028 fn foo(f: foo::Foo) {
1034 pub struct Foo { pub baz: uint }
1037 fn foo(f: foo::Foo) {
1045 fn test_parameter_to_self() {
1049 struct Foo { i: i32 }
1052 fn f(foo<|>: &mut Foo) -> i32 {
1058 struct Foo { i: i32 }
1061 fn f(&mut self) -> i32 {
1070 fn test_self_to_parameter() {
1074 struct Foo { i: i32 }
1077 fn f(&mut <|>self) -> i32 {
1083 struct Foo { i: i32 }
1086 fn f(foo: &mut Foo) -> i32 {
1095 fn test_self_in_path_to_parameter() {
1099 struct Foo { i: i32 }
1102 fn f(&self) -> i32 {
1109 struct Foo { i: i32 }
1112 fn f(foo: &Foo) -> i32 {
1122 fn test_initializer_use_field_init_shorthand() {
1126 struct Foo { i<|>: i32 }
1128 fn foo(bar: i32) -> Foo {
1133 struct Foo { bar: i32 }
1135 fn foo(bar: i32) -> Foo {
1143 fn test_rename_binding_in_destructure_pat_shorthand() {
1152 let Foo { i } = foo;
1162 let Foo { i: bar } = foo;
1170 fn test_rename_binding_in_destructure_pat() {
1179 let Foo { i: b } = foo;
1189 let Foo { i: bar } = foo;