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};
31 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::Module(module) => rename_mod(sema, module, new_name),
71 Definition::BuiltinType(_) => {
72 bail!("Cannot rename builtin type")
74 Definition::SelfType(_) => bail!("Cannot rename `Self`"),
75 def => rename_reference(sema, def, new_name),
79 /// Textual range of the identifier which will change when renaming this
80 /// `Definition`. Note that some definitions, like buitin types, can't be
82 pub fn range_for_rename(self, sema: &Semantics<RootDatabase>) -> Option<FileRange> {
83 let res = match self {
84 Definition::Macro(mac) => {
85 let src = mac.source(sema.db)?;
86 let name = match &src.value {
87 Either::Left(it) => it.name()?,
88 Either::Right(it) => it.name()?,
90 src.with_value(name.syntax()).original_file_range_opt(sema.db)
92 Definition::Field(field) => {
93 let src = field.source(sema.db)?;
95 FieldSource::Named(record_field) => {
96 let name = record_field.name()?;
97 src.with_value(name.syntax()).original_file_range_opt(sema.db)
99 FieldSource::Pos(_) => None,
102 Definition::Module(module) => {
103 let src = module.declaration_source(sema.db)?;
104 let name = src.value.name()?;
105 src.with_value(name.syntax()).original_file_range_opt(sema.db)
107 Definition::Function(it) => name_range(it, sema),
108 Definition::Adt(adt) => match adt {
109 hir::Adt::Struct(it) => name_range(it, sema),
110 hir::Adt::Union(it) => name_range(it, sema),
111 hir::Adt::Enum(it) => name_range(it, sema),
113 Definition::Variant(it) => name_range(it, sema),
114 Definition::Const(it) => name_range(it, sema),
115 Definition::Static(it) => name_range(it, sema),
116 Definition::Trait(it) => name_range(it, sema),
117 Definition::TypeAlias(it) => name_range(it, sema),
118 Definition::Local(local) => {
119 let src = local.source(sema.db);
120 let name = match &src.value {
121 Either::Left(bind_pat) => bind_pat.name()?,
122 Either::Right(_) => return None,
124 src.with_value(name.syntax()).original_file_range_opt(sema.db)
126 Definition::GenericParam(generic_param) => match generic_param {
127 hir::GenericParam::TypeParam(type_param) => {
128 let src = type_param.source(sema.db)?;
129 let name = match &src.value {
130 Either::Left(type_param) => type_param.name()?,
131 Either::Right(_trait) => return None,
133 src.with_value(name.syntax()).original_file_range_opt(sema.db)
135 hir::GenericParam::LifetimeParam(lifetime_param) => {
136 let src = lifetime_param.source(sema.db)?;
137 let lifetime = src.value.lifetime()?;
138 src.with_value(lifetime.syntax()).original_file_range_opt(sema.db)
140 hir::GenericParam::ConstParam(it) => name_range(it, sema),
142 Definition::Label(label) => {
143 let src = label.source(sema.db);
144 let lifetime = src.value.lifetime()?;
145 src.with_value(lifetime.syntax()).original_file_range_opt(sema.db)
147 Definition::BuiltinType(_) => return None,
148 Definition::SelfType(_) => return None,
149 Definition::BuiltinAttr(_) => return None,
150 Definition::ToolModule(_) => return None,
154 fn name_range<D>(def: D, sema: &Semantics<RootDatabase>) -> Option<FileRange>
157 D::Ast: ast::HasName,
159 let src = def.source(sema.db)?;
160 let name = src.value.name()?;
161 src.with_value(name.syntax()).original_file_range_opt(sema.db)
167 sema: &Semantics<RootDatabase>,
170 ) -> Result<SourceChange> {
171 if IdentifierKind::classify(new_name)? != IdentifierKind::Ident {
172 bail!("Invalid name `{0}`: cannot rename module to {0}", new_name);
175 let mut source_change = SourceChange::default();
177 let InFile { file_id, value: def_source } = module.definition_source(sema.db);
178 let file_id = file_id.original_file(sema.db);
179 if let ModuleSource::SourceFile(..) = def_source {
180 // mod is defined in path/to/dir/mod.rs
181 let path = if module.is_mod_rs(sema.db) {
182 format!("../{}/mod.rs", new_name)
184 format!("{}.rs", new_name)
186 let dst = AnchoredPathBuf { anchor: file_id, path };
187 let move_file = FileSystemEdit::MoveFile { src: file_id, dst };
188 source_change.push_file_system_edit(move_file);
191 if let Some(src) = module.declaration_source(sema.db) {
192 let file_id = src.file_id.original_file(sema.db);
193 match src.value.name() {
195 if let Some(file_range) =
196 src.with_value(name.syntax()).original_file_range_opt(sema.db)
198 source_change.insert_source_edit(
200 TextEdit::replace(file_range.range, new_name.to_string()),
204 _ => never!("Module source node is missing a name"),
208 let def = Definition::Module(module);
209 let usages = def.usages(sema).all();
210 let ref_edits = usages.iter().map(|(&file_id, references)| {
211 (file_id, source_edit_from_references(references, def, new_name))
213 source_change.extend(ref_edits);
219 sema: &Semantics<RootDatabase>,
222 ) -> Result<SourceChange> {
223 let ident_kind = IdentifierKind::classify(new_name)?;
227 Definition::GenericParam(hir::GenericParam::LifetimeParam(_)) | Definition::Label(_)
230 IdentifierKind::Ident | IdentifierKind::Underscore => {
231 cov_mark::hit!(rename_not_a_lifetime_ident_ref);
232 bail!("Invalid name `{}`: not a lifetime identifier", new_name);
234 IdentifierKind::Lifetime => cov_mark::hit!(rename_lifetime),
238 IdentifierKind::Lifetime => {
239 cov_mark::hit!(rename_not_an_ident_ref);
240 bail!("Invalid name `{}`: not an identifier", new_name);
242 IdentifierKind::Ident => cov_mark::hit!(rename_non_local),
243 IdentifierKind::Underscore => (),
247 let assoc_item = match def {
248 // HACK: resolve trait impl items to the item def of the trait definition
249 // so that we properly resolve all trait item references
250 Definition::Function(it) => it.as_assoc_item(sema.db),
251 Definition::TypeAlias(it) => it.as_assoc_item(sema.db),
252 Definition::Const(it) => it.as_assoc_item(sema.db),
255 def = match assoc_item {
257 .containing_trait_impl(sema.db)
259 trait_.items(sema.db).into_iter().find_map(|it| match (it, assoc) {
260 (hir::AssocItem::Function(trait_func), hir::AssocItem::Function(func))
261 if trait_func.name(sema.db) == func.name(sema.db) =>
263 Some(Definition::Function(trait_func))
265 (hir::AssocItem::Const(trait_konst), hir::AssocItem::Const(konst))
266 if trait_konst.name(sema.db) == konst.name(sema.db) =>
268 Some(Definition::Const(trait_konst))
271 hir::AssocItem::TypeAlias(trait_type_alias),
272 hir::AssocItem::TypeAlias(type_alias),
273 ) if trait_type_alias.name(sema.db) == type_alias.name(sema.db) => {
274 Some(Definition::TypeAlias(trait_type_alias))
282 let usages = def.usages(sema).all();
284 if !usages.is_empty() && ident_kind == IdentifierKind::Underscore {
285 cov_mark::hit!(rename_underscore_multiple);
286 bail!("Cannot rename reference to `_` as it is being referenced multiple times");
288 let mut source_change = SourceChange::default();
289 source_change.extend(usages.iter().map(|(&file_id, references)| {
290 (file_id, source_edit_from_references(references, def, new_name))
293 let (file_id, edit) = source_edit_from_def(sema, def, new_name)?;
294 source_change.insert_source_edit(file_id, edit);
298 pub fn source_edit_from_references(
299 references: &[FileReference],
303 let mut edit = TextEdit::builder();
304 // macros can cause multiple refs to occur for the same text range, so keep track of what we have edited so far
305 let mut edited_ranges = Vec::new();
306 for &FileReference { range, ref name, .. } in references {
307 let has_emitted_edit = match name {
308 // if the ranges differ then the node is inside a macro call, we can't really attempt
309 // to make special rewrites like shorthand syntax and such, so just rename the node in
311 ast::NameLike::NameRef(name_ref) if name_ref.syntax().text_range() == range => {
312 source_edit_from_name_ref(&mut edit, name_ref, new_name, def)
314 ast::NameLike::Name(name) if name.syntax().text_range() == range => {
315 source_edit_from_name(&mut edit, name, new_name)
319 if !has_emitted_edit {
320 if !edited_ranges.contains(&range.start()) {
321 edit.replace(range, new_name.to_string());
322 edited_ranges.push(range.start());
330 fn source_edit_from_name(edit: &mut TextEditBuilder, name: &ast::Name, new_name: &str) -> bool {
331 if ast::RecordPatField::for_field_name(name).is_some() {
332 if let Some(ident_pat) = name.syntax().parent().and_then(ast::IdentPat::cast) {
333 cov_mark::hit!(rename_record_pat_field_name_split);
334 // Foo { ref mut field } -> Foo { new_name: ref mut field }
335 // ^ insert `new_name: `
337 // FIXME: instead of splitting the shorthand, recursively trigger a rename of the
338 // other name https://github.com/rust-analyzer/rust-analyzer/issues/6547
339 edit.insert(ident_pat.syntax().text_range().start(), format!("{}: ", new_name));
347 fn source_edit_from_name_ref(
348 edit: &mut TextEditBuilder,
349 name_ref: &ast::NameRef,
353 if name_ref.super_token().is_some() {
357 if let Some(record_field) = ast::RecordExprField::for_name_ref(name_ref) {
358 let rcf_name_ref = record_field.name_ref();
359 let rcf_expr = record_field.expr();
360 match &(rcf_name_ref, rcf_expr.and_then(|it| expr_as_name_ref(&it))) {
361 // field: init-expr, check if we can use a field init shorthand
362 (Some(field_name), Some(init)) => {
363 if field_name == name_ref {
364 if init.text() == new_name {
365 cov_mark::hit!(test_rename_field_put_init_shorthand);
366 // Foo { field: local } -> Foo { local }
367 // ^^^^^^^ delete this
369 // same names, we can use a shorthand here instead.
370 // we do not want to erase attributes hence this range start
371 let s = field_name.syntax().text_range().start();
372 let e = init.syntax().text_range().start();
373 edit.delete(TextRange::new(s, e));
376 } else if init == name_ref {
377 if field_name.text() == new_name {
378 cov_mark::hit!(test_rename_local_put_init_shorthand);
379 // Foo { field: local } -> Foo { field }
380 // ^^^^^^^ delete this
382 // same names, we can use a shorthand here instead.
383 // we do not want to erase attributes hence this range start
384 let s = field_name.syntax().text_range().end();
385 let e = init.syntax().text_range().end();
386 edit.delete(TextRange::new(s, e));
392 (None, Some(_)) if matches!(def, Definition::Field(_)) => {
393 cov_mark::hit!(test_rename_field_in_field_shorthand);
394 // Foo { field } -> Foo { new_name: field }
395 // ^ insert `new_name: `
396 let offset = name_ref.syntax().text_range().start();
397 edit.insert(offset, format!("{}: ", new_name));
400 (None, Some(_)) if matches!(def, Definition::Local(_)) => {
401 cov_mark::hit!(test_rename_local_in_field_shorthand);
402 // Foo { field } -> Foo { field: new_name }
403 // ^ insert `: new_name`
404 let offset = name_ref.syntax().text_range().end();
405 edit.insert(offset, format!(": {}", new_name));
410 } else if let Some(record_field) = ast::RecordPatField::for_field_name_ref(name_ref) {
411 let rcf_name_ref = record_field.name_ref();
412 let rcf_pat = record_field.pat();
413 match (rcf_name_ref, rcf_pat) {
415 (Some(field_name), Some(ast::Pat::IdentPat(pat)))
416 if field_name == *name_ref && pat.at_token().is_none() =>
418 // field name is being renamed
419 if let Some(name) = pat.name() {
420 if name.text() == new_name {
421 cov_mark::hit!(test_rename_field_put_init_shorthand_pat);
422 // Foo { field: ref mut local } -> Foo { ref mut field }
423 // ^^^^^^^ delete this
424 // ^^^^^ replace this with `field`
426 // same names, we can use a shorthand here instead/
427 // we do not want to erase attributes hence this range start
428 let s = field_name.syntax().text_range().start();
429 let e = pat.syntax().text_range().start();
430 edit.delete(TextRange::new(s, e));
431 edit.replace(name.syntax().text_range(), new_name.to_string());
442 fn source_edit_from_def(
443 sema: &Semantics<RootDatabase>,
446 ) -> Result<(FileId, TextEdit)> {
447 let FileRange { file_id, range } = def
448 .range_for_rename(sema)
449 .ok_or_else(|| format_err!("No identifier available to rename"))?;
451 let mut edit = TextEdit::builder();
452 if let Definition::Local(local) = def {
453 if let Either::Left(pat) = local.source(sema.db).value {
454 // special cases required for renaming fields/locals in Record patterns
455 if let Some(pat_field) = pat.syntax().parent().and_then(ast::RecordPatField::cast) {
456 let name_range = pat.name().unwrap().syntax().text_range();
457 if let Some(name_ref) = pat_field.name_ref() {
458 if new_name == name_ref.text() && pat.at_token().is_none() {
459 // Foo { field: ref mut local } -> Foo { ref mut field }
460 // ^^^^^^ delete this
461 // ^^^^^ replace this with `field`
462 cov_mark::hit!(test_rename_local_put_init_shorthand_pat);
467 .cover_offset(pat.syntax().text_range().start()),
469 edit.replace(name_range, name_ref.text().to_string());
471 // Foo { field: ref mut local @ local 2} -> Foo { field: ref mut new_name @ local2 }
472 // Foo { field: ref mut local } -> Foo { field: ref mut new_name }
473 // ^^^^^ replace this with `new_name`
474 edit.replace(name_range, new_name.to_string());
477 // Foo { ref mut field } -> Foo { field: ref mut new_name }
478 // ^ insert `field: `
479 // ^^^^^ replace this with `new_name`
481 pat.syntax().text_range().start(),
482 format!("{}: ", pat_field.field_name().unwrap()),
484 edit.replace(name_range, new_name.to_string());
490 edit.replace(range, new_name.to_string());
492 Ok((file_id, edit.finish()))
495 #[derive(Copy, Clone, Debug, PartialEq)]
496 pub enum IdentifierKind {
502 impl IdentifierKind {
503 pub fn classify(new_name: &str) -> Result<IdentifierKind> {
504 match parser::LexedStr::single_token(new_name) {
505 Some(res) => match res {
506 (SyntaxKind::IDENT, _) => Ok(IdentifierKind::Ident),
507 (T![_], _) => Ok(IdentifierKind::Underscore),
508 (SyntaxKind::LIFETIME_IDENT, _) if new_name != "'static" && new_name != "'_" => {
509 Ok(IdentifierKind::Lifetime)
511 (SyntaxKind::LIFETIME_IDENT, _) => {
512 bail!("Invalid name `{}`: not a lifetime identifier", new_name)
514 (_, Some(syntax_error)) => bail!("Invalid name `{}`: {}", new_name, syntax_error),
515 (_, None) => bail!("Invalid name `{}`: not an identifier", new_name),
517 None => bail!("Invalid name `{}`: not an identifier", new_name),