1 //! Rename infrastructure for rust-analyzer. It is used primarily for the
2 //! literal "rename" in the ide (look for tests there), but it is also available
3 //! as a general-purpose service. For example, it is used by the fix for the
4 //! "incorrect case" diagnostic.
6 //! It leverages the [`crate::search`] functionality to find what needs to be
7 //! renamed. The actual renames are tricky -- field shorthands need special
8 //! attention, and, when renaming modules, you also want to rename files on the
11 //! Another can of worms are macros:
14 //! macro_rules! m { () => { fn f() {} } }
17 //! f() // <- rename me
21 //! The correct behavior in such cases is probably to show a dialog to the user.
22 //! Our current behavior is ¯\_(ツ)_/¯.
25 use base_db::{AnchoredPathBuf, FileId, FileRange};
27 use hir::{AsAssocItem, FieldSource, HasSource, InFile, ModuleSource, Semantics};
30 ast::{self, NameOwner},
31 lex_single_syntax_kind, AstNode, SyntaxKind, TextRange, T,
33 use text_edit::{TextEdit, TextEditBuilder};
37 helpers::node_ext::expr_as_name_ref,
38 search::FileReference,
39 source_change::{FileSystemEdit, SourceChange},
43 pub type Result<T, E = RenameError> = std::result::Result<T, E>;
46 pub struct RenameError(pub String);
48 impl fmt::Display for RenameError {
49 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
50 fmt::Display::fmt(&self.0, f)
55 macro_rules! _format_err {
56 ($fmt:expr) => { RenameError(format!($fmt)) };
57 ($fmt:expr, $($arg:tt)+) => { RenameError(format!($fmt, $($arg)+)) }
59 pub use _format_err as format_err;
63 ($($tokens:tt)*) => { return Err(format_err!($($tokens)*)) }
65 pub use _bail as bail;
68 pub fn rename(&self, sema: &Semantics<RootDatabase>, new_name: &str) -> Result<SourceChange> {
70 Definition::ModuleDef(hir::ModuleDef::Module(module)) => {
71 rename_mod(sema, module, new_name)
73 Definition::ModuleDef(hir::ModuleDef::BuiltinType(_)) => {
74 bail!("Cannot rename builtin type")
76 Definition::SelfType(_) => bail!("Cannot rename `Self`"),
77 def => rename_reference(sema, def, new_name),
81 /// Textual range of the identifier which will change when renaming this
82 /// `Definition`. Note that some definitions, like buitin types, can't be
84 pub fn range_for_rename(self, sema: &Semantics<RootDatabase>) -> Option<FileRange> {
85 let res = match self {
86 Definition::Macro(mac) => {
87 let src = mac.source(sema.db)?;
88 let name = match &src.value {
89 Either::Left(it) => it.name()?,
90 Either::Right(it) => it.name()?,
92 src.with_value(name.syntax()).original_file_range_opt(sema.db)
94 Definition::Field(field) => {
95 let src = field.source(sema.db)?;
97 FieldSource::Named(record_field) => {
98 let name = record_field.name()?;
99 src.with_value(name.syntax()).original_file_range_opt(sema.db)
101 FieldSource::Pos(_) => None,
104 Definition::ModuleDef(module_def) => match module_def {
105 hir::ModuleDef::Module(module) => {
106 let src = module.declaration_source(sema.db)?;
107 let name = src.value.name()?;
108 src.with_value(name.syntax()).original_file_range_opt(sema.db)
110 hir::ModuleDef::Function(it) => name_range(it, sema),
111 hir::ModuleDef::Adt(adt) => match adt {
112 hir::Adt::Struct(it) => name_range(it, sema),
113 hir::Adt::Union(it) => name_range(it, sema),
114 hir::Adt::Enum(it) => name_range(it, sema),
116 hir::ModuleDef::Variant(it) => name_range(it, sema),
117 hir::ModuleDef::Const(it) => name_range(it, sema),
118 hir::ModuleDef::Static(it) => name_range(it, sema),
119 hir::ModuleDef::Trait(it) => name_range(it, sema),
120 hir::ModuleDef::TypeAlias(it) => name_range(it, sema),
121 hir::ModuleDef::BuiltinType(_) => return None,
123 Definition::SelfType(_) => return None,
124 Definition::Local(local) => {
125 let src = local.source(sema.db);
126 let name = match &src.value {
127 Either::Left(bind_pat) => bind_pat.name()?,
128 Either::Right(_) => return None,
130 src.with_value(name.syntax()).original_file_range_opt(sema.db)
132 Definition::GenericParam(generic_param) => match generic_param {
133 hir::GenericParam::TypeParam(type_param) => {
134 let src = type_param.source(sema.db)?;
135 let name = match &src.value {
136 Either::Left(type_param) => type_param.name()?,
137 Either::Right(_trait) => return None,
139 src.with_value(name.syntax()).original_file_range_opt(sema.db)
141 hir::GenericParam::LifetimeParam(lifetime_param) => {
142 let src = lifetime_param.source(sema.db)?;
143 let lifetime = src.value.lifetime()?;
144 src.with_value(lifetime.syntax()).original_file_range_opt(sema.db)
146 hir::GenericParam::ConstParam(it) => name_range(it, sema),
148 Definition::Label(label) => {
149 let src = label.source(sema.db);
150 let lifetime = src.value.lifetime()?;
151 src.with_value(lifetime.syntax()).original_file_range_opt(sema.db)
156 fn name_range<D>(def: D, sema: &Semantics<RootDatabase>) -> Option<FileRange>
159 D::Ast: ast::NameOwner,
161 let src = def.source(sema.db)?;
162 let name = src.value.name()?;
163 src.with_value(name.syntax()).original_file_range_opt(sema.db)
169 sema: &Semantics<RootDatabase>,
172 ) -> Result<SourceChange> {
173 if IdentifierKind::classify(new_name)? != IdentifierKind::Ident {
174 bail!("Invalid name `{0}`: cannot rename module to {0}", new_name);
177 let mut source_change = SourceChange::default();
179 let InFile { file_id, value: def_source } = module.definition_source(sema.db);
180 let file_id = file_id.original_file(sema.db);
181 if let ModuleSource::SourceFile(..) = def_source {
182 // mod is defined in path/to/dir/mod.rs
183 let path = if module.is_mod_rs(sema.db) {
184 format!("../{}/mod.rs", new_name)
186 format!("{}.rs", new_name)
188 let dst = AnchoredPathBuf { anchor: file_id, path };
189 let move_file = FileSystemEdit::MoveFile { src: file_id, dst };
190 source_change.push_file_system_edit(move_file);
193 if let Some(InFile { file_id, value: decl_source }) = module.declaration_source(sema.db) {
194 let file_id = file_id.original_file(sema.db);
195 match decl_source.name() {
196 Some(name) => source_change.insert_source_edit(
198 TextEdit::replace(name.syntax().text_range(), new_name.to_string()),
200 _ => never!("Module source node is missing a name"),
203 let def = Definition::ModuleDef(hir::ModuleDef::Module(module));
204 let usages = def.usages(sema).all();
205 let ref_edits = usages.iter().map(|(&file_id, references)| {
206 (file_id, source_edit_from_references(references, def, new_name))
208 source_change.extend(ref_edits);
214 sema: &Semantics<RootDatabase>,
217 ) -> Result<SourceChange> {
218 let ident_kind = IdentifierKind::classify(new_name)?;
222 Definition::GenericParam(hir::GenericParam::LifetimeParam(_)) | Definition::Label(_)
225 IdentifierKind::Ident | IdentifierKind::Underscore => {
226 cov_mark::hit!(rename_not_a_lifetime_ident_ref);
227 bail!("Invalid name `{}`: not a lifetime identifier", new_name);
229 IdentifierKind::Lifetime => cov_mark::hit!(rename_lifetime),
233 IdentifierKind::Lifetime => {
234 cov_mark::hit!(rename_not_an_ident_ref);
235 bail!("Invalid name `{}`: not an identifier", new_name);
237 IdentifierKind::Ident => cov_mark::hit!(rename_non_local),
238 IdentifierKind::Underscore => (),
243 // HACK: resolve trait impl items to the item def of the trait definition
244 // so that we properly resolve all trait item references
245 Definition::ModuleDef(mod_def) => mod_def
246 .as_assoc_item(sema.db)
247 .and_then(|it| it.containing_trait_impl(sema.db))
249 it.items(sema.db).into_iter().find_map(|it| match (it, mod_def) {
250 (hir::AssocItem::Function(trait_func), hir::ModuleDef::Function(func))
251 if trait_func.name(sema.db) == func.name(sema.db) =>
253 Some(Definition::ModuleDef(hir::ModuleDef::Function(trait_func)))
255 (hir::AssocItem::Const(trait_konst), hir::ModuleDef::Const(konst))
256 if trait_konst.name(sema.db) == konst.name(sema.db) =>
258 Some(Definition::ModuleDef(hir::ModuleDef::Const(trait_konst)))
261 hir::AssocItem::TypeAlias(trait_type_alias),
262 hir::ModuleDef::TypeAlias(type_alias),
263 ) if trait_type_alias.name(sema.db) == type_alias.name(sema.db) => {
264 Some(Definition::ModuleDef(hir::ModuleDef::TypeAlias(trait_type_alias)))
272 let usages = def.usages(sema).all();
274 if !usages.is_empty() && ident_kind == IdentifierKind::Underscore {
275 cov_mark::hit!(rename_underscore_multiple);
276 bail!("Cannot rename reference to `_` as it is being referenced multiple times");
278 let mut source_change = SourceChange::default();
279 source_change.extend(usages.iter().map(|(&file_id, references)| {
280 (file_id, source_edit_from_references(references, def, new_name))
283 let (file_id, edit) = source_edit_from_def(sema, def, new_name)?;
284 source_change.insert_source_edit(file_id, edit);
288 pub fn source_edit_from_references(
289 references: &[FileReference],
293 let mut edit = TextEdit::builder();
294 for reference in references {
295 let has_emitted_edit = match &reference.name {
296 // if the ranges differ then the node is inside a macro call, we can't really attempt
297 // to make special rewrites like shorthand syntax and such, so just rename the node in
299 ast::NameLike::NameRef(name_ref)
300 if name_ref.syntax().text_range() == reference.range =>
302 source_edit_from_name_ref(&mut edit, name_ref, new_name, def)
304 ast::NameLike::Name(name) if name.syntax().text_range() == reference.range => {
305 source_edit_from_name(&mut edit, name, new_name)
309 if !has_emitted_edit {
310 edit.replace(reference.range, new_name.to_string());
317 fn source_edit_from_name(edit: &mut TextEditBuilder, name: &ast::Name, new_name: &str) -> bool {
318 if let Some(_) = ast::RecordPatField::for_field_name(name) {
319 if let Some(ident_pat) = name.syntax().parent().and_then(ast::IdentPat::cast) {
320 cov_mark::hit!(rename_record_pat_field_name_split);
321 // Foo { ref mut field } -> Foo { new_name: ref mut field }
322 // ^ insert `new_name: `
324 // FIXME: instead of splitting the shorthand, recursively trigger a rename of the
325 // other name https://github.com/rust-analyzer/rust-analyzer/issues/6547
326 edit.insert(ident_pat.syntax().text_range().start(), format!("{}: ", new_name));
334 fn source_edit_from_name_ref(
335 edit: &mut TextEditBuilder,
336 name_ref: &ast::NameRef,
340 if let Some(record_field) = ast::RecordExprField::for_name_ref(name_ref) {
341 let rcf_name_ref = record_field.name_ref();
342 let rcf_expr = record_field.expr();
343 match &(rcf_name_ref, rcf_expr.and_then(|it| expr_as_name_ref(&it))) {
344 // field: init-expr, check if we can use a field init shorthand
345 (Some(field_name), Some(init)) => {
346 if field_name == name_ref {
347 if init.text() == new_name {
348 cov_mark::hit!(test_rename_field_put_init_shorthand);
349 // Foo { field: local } -> Foo { local }
350 // ^^^^^^^ delete this
352 // same names, we can use a shorthand here instead.
353 // we do not want to erase attributes hence this range start
354 let s = field_name.syntax().text_range().start();
355 let e = init.syntax().text_range().start();
356 edit.delete(TextRange::new(s, e));
359 } else if init == name_ref {
360 if field_name.text() == new_name {
361 cov_mark::hit!(test_rename_local_put_init_shorthand);
362 // Foo { field: local } -> Foo { field }
363 // ^^^^^^^ delete this
365 // same names, we can use a shorthand here instead.
366 // we do not want to erase attributes hence this range start
367 let s = field_name.syntax().text_range().end();
368 let e = init.syntax().text_range().end();
369 edit.delete(TextRange::new(s, e));
375 (None, Some(_)) if matches!(def, Definition::Field(_)) => {
376 cov_mark::hit!(test_rename_field_in_field_shorthand);
377 // Foo { field } -> Foo { new_name: field }
378 // ^ insert `new_name: `
379 let offset = name_ref.syntax().text_range().start();
380 edit.insert(offset, format!("{}: ", new_name));
383 (None, Some(_)) if matches!(def, Definition::Local(_)) => {
384 cov_mark::hit!(test_rename_local_in_field_shorthand);
385 // Foo { field } -> Foo { field: new_name }
386 // ^ insert `: new_name`
387 let offset = name_ref.syntax().text_range().end();
388 edit.insert(offset, format!(": {}", new_name));
393 } else if let Some(record_field) = ast::RecordPatField::for_field_name_ref(name_ref) {
394 let rcf_name_ref = record_field.name_ref();
395 let rcf_pat = record_field.pat();
396 match (rcf_name_ref, rcf_pat) {
398 (Some(field_name), Some(ast::Pat::IdentPat(pat)))
399 if field_name == *name_ref && pat.at_token().is_none() =>
401 // field name is being renamed
402 if let Some(name) = pat.name() {
403 if name.text() == new_name {
404 cov_mark::hit!(test_rename_field_put_init_shorthand_pat);
405 // Foo { field: ref mut local } -> Foo { ref mut field }
406 // ^^^^^^^ delete this
407 // ^^^^^ replace this with `field`
409 // same names, we can use a shorthand here instead/
410 // we do not want to erase attributes hence this range start
411 let s = field_name.syntax().text_range().start();
412 let e = pat.syntax().text_range().start();
413 edit.delete(TextRange::new(s, e));
414 edit.replace(name.syntax().text_range(), new_name.to_string());
425 fn source_edit_from_def(
426 sema: &Semantics<RootDatabase>,
429 ) -> Result<(FileId, TextEdit)> {
430 let FileRange { file_id, range } = def
431 .range_for_rename(sema)
432 .ok_or_else(|| format_err!("No identifier available to rename"))?;
434 let mut edit = TextEdit::builder();
435 if let Definition::Local(local) = def {
436 if let Either::Left(pat) = local.source(sema.db).value {
437 // special cases required for renaming fields/locals in Record patterns
438 if let Some(pat_field) = pat.syntax().parent().and_then(ast::RecordPatField::cast) {
439 let name_range = pat.name().unwrap().syntax().text_range();
440 if let Some(name_ref) = pat_field.name_ref() {
441 if new_name == name_ref.text() && pat.at_token().is_none() {
442 // Foo { field: ref mut local } -> Foo { ref mut field }
443 // ^^^^^^ delete this
444 // ^^^^^ replace this with `field`
445 cov_mark::hit!(test_rename_local_put_init_shorthand_pat);
450 .cover_offset(pat.syntax().text_range().start()),
452 edit.replace(name_range, name_ref.text().to_string());
454 // Foo { field: ref mut local @ local 2} -> Foo { field: ref mut new_name @ local2 }
455 // Foo { field: ref mut local } -> Foo { field: ref mut new_name }
456 // ^^^^^ replace this with `new_name`
457 edit.replace(name_range, new_name.to_string());
460 // Foo { ref mut field } -> Foo { field: ref mut new_name }
461 // ^ insert `field: `
462 // ^^^^^ replace this with `new_name`
464 pat.syntax().text_range().start(),
465 format!("{}: ", pat_field.field_name().unwrap()),
467 edit.replace(name_range, new_name.to_string());
473 edit.replace(range, new_name.to_string());
475 Ok((file_id, edit.finish()))
478 #[derive(Copy, Clone, Debug, PartialEq)]
479 pub enum IdentifierKind {
485 impl IdentifierKind {
486 pub fn classify(new_name: &str) -> Result<IdentifierKind> {
487 match lex_single_syntax_kind(new_name) {
488 Some(res) => match res {
489 (SyntaxKind::IDENT, _) => Ok(IdentifierKind::Ident),
490 (T![_], _) => Ok(IdentifierKind::Underscore),
491 (SyntaxKind::LIFETIME_IDENT, _) if new_name != "'static" && new_name != "'_" => {
492 Ok(IdentifierKind::Lifetime)
494 (SyntaxKind::LIFETIME_IDENT, _) => {
495 bail!("Invalid name `{}`: not a lifetime identifier", new_name)
497 (_, Some(syntax_error)) => bail!("Invalid name `{}`: {}", new_name, syntax_error),
498 (_, None) => bail!("Invalid name `{}`: not an identifier", new_name),
500 None => bail!("Invalid name `{}`: not an identifier", new_name),