crates/ide_db/src/rename.rs

   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.
   5 //!
   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
   9 //! file system.
  10 //!
  11 //! Another can of worms are macros:
  12 //!
  13 //! ```
  14 //! macro_rules! m { () => { fn f() {} } }
  15 //! m!();
  16 //! fn main() {
  17 //!     f() // <- rename me
  18 //! }
  19 //! ```
  20 //!
  21 //! The correct behavior in such cases is probably to show a dialog to the user.
  22 //! Our current behavior is ¯\_(ツ)_/¯.
  23 use std::fmt;
  24
  25 use base_db::{AnchoredPathBuf, FileId, FileRange};
  26 use either::Either;
  27 use hir::{AsAssocItem, FieldSource, HasSource, InFile, ModuleSource, Semantics};
  28 use stdx::never;
  29 use syntax::{
  30     ast::{self, HasName},
  31     lex_single_syntax_kind, AstNode, SyntaxKind, TextRange, T,
  32 };
  33 use text_edit::{TextEdit, TextEditBuilder};
  34
  35 use crate::{
  36     defs::Definition,
  37     helpers::node_ext::expr_as_name_ref,
  38     search::FileReference,
  39     source_change::{FileSystemEdit, SourceChange},
  40     RootDatabase,
  41 };
  42
  43 pub type Result<T, E = RenameError> = std::result::Result<T, E>;
  44
  45 #[derive(Debug)]
  46 pub struct RenameError(pub String);
  47
  48 impl fmt::Display for RenameError {
  49     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  50         fmt::Display::fmt(&self.0, f)
  51     }
  52 }
  53
  54 #[macro_export]
  55 macro_rules! _format_err {
  56     ($fmt:expr) => { RenameError(format!($fmt)) };
  57     ($fmt:expr, $($arg:tt)+) => { RenameError(format!($fmt, $($arg)+)) }
  58 }
  59 pub use _format_err as format_err;
  60
  61 #[macro_export]
  62 macro_rules! _bail {
  63     ($($tokens:tt)*) => { return Err(format_err!($($tokens)*)) }
  64 }
  65 pub use _bail as bail;
  66
  67 impl Definition {
  68     pub fn rename(&self, sema: &Semantics<RootDatabase>, new_name: &str) -> Result<SourceChange> {
  69         match *self {
  70             Definition::Module(module) => rename_mod(sema, module, new_name),
  71             Definition::BuiltinType(_) => {
  72                 bail!("Cannot rename builtin type")
  73             }
  74             Definition::SelfType(_) => bail!("Cannot rename `Self`"),
  75             def => rename_reference(sema, def, new_name),
  76         }
  77     }
  78
  79     /// Textual range of the identifier which will change when renaming this
  80     /// `Definition`. Note that some definitions, like buitin types, can't be
  81     /// renamed.
  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()?,
  89                 };
  90                 src.with_value(name.syntax()).original_file_range_opt(sema.db)
  91             }
  92             Definition::Field(field) => {
  93                 let src = field.source(sema.db)?;
  94                 match &src.value {
  95                     FieldSource::Named(record_field) => {
  96                         let name = record_field.name()?;
  97                         src.with_value(name.syntax()).original_file_range_opt(sema.db)
  98                     }
  99                     FieldSource::Pos(_) => None,
 100                 }
 101             }
 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)
 106             }
 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),
 112             },
 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::BuiltinType(_) => return None,
 119             Definition::SelfType(_) => return None,
 120             Definition::Local(local) => {
 121                 let src = local.source(sema.db);
 122                 let name = match &src.value {
 123                     Either::Left(bind_pat) => bind_pat.name()?,
 124                     Either::Right(_) => return None,
 125                 };
 126                 src.with_value(name.syntax()).original_file_range_opt(sema.db)
 127             }
 128             Definition::GenericParam(generic_param) => match generic_param {
 129                 hir::GenericParam::TypeParam(type_param) => {
 130                     let src = type_param.source(sema.db)?;
 131                     let name = match &src.value {
 132                         Either::Left(type_param) => type_param.name()?,
 133                         Either::Right(_trait) => return None,
 134                     };
 135                     src.with_value(name.syntax()).original_file_range_opt(sema.db)
 136                 }
 137                 hir::GenericParam::LifetimeParam(lifetime_param) => {
 138                     let src = lifetime_param.source(sema.db)?;
 139                     let lifetime = src.value.lifetime()?;
 140                     src.with_value(lifetime.syntax()).original_file_range_opt(sema.db)
 141                 }
 142                 hir::GenericParam::ConstParam(it) => name_range(it, sema),
 143             },
 144             Definition::Label(label) => {
 145                 let src = label.source(sema.db);
 146                 let lifetime = src.value.lifetime()?;
 147                 src.with_value(lifetime.syntax()).original_file_range_opt(sema.db)
 148             }
 149         };
 150         return res;
 151
 152         fn name_range<D>(def: D, sema: &Semantics<RootDatabase>) -> Option<FileRange>
 153         where
 154             D: HasSource,
 155             D::Ast: ast::HasName,
 156         {
 157             let src = def.source(sema.db)?;
 158             let name = src.value.name()?;
 159             src.with_value(name.syntax()).original_file_range_opt(sema.db)
 160         }
 161     }
 162 }
 163
 164 fn rename_mod(
 165     sema: &Semantics<RootDatabase>,
 166     module: hir::Module,
 167     new_name: &str,
 168 ) -> Result<SourceChange> {
 169     if IdentifierKind::classify(new_name)? != IdentifierKind::Ident {
 170         bail!("Invalid name `{0}`: cannot rename module to {0}", new_name);
 171     }
 172
 173     let mut source_change = SourceChange::default();
 174
 175     let InFile { file_id, value: def_source } = module.definition_source(sema.db);
 176     let file_id = file_id.original_file(sema.db);
 177     if let ModuleSource::SourceFile(..) = def_source {
 178         // mod is defined in path/to/dir/mod.rs
 179         let path = if module.is_mod_rs(sema.db) {
 180             format!("../{}/mod.rs", new_name)
 181         } else {
 182             format!("{}.rs", new_name)
 183         };
 184         let dst = AnchoredPathBuf { anchor: file_id, path };
 185         let move_file = FileSystemEdit::MoveFile { src: file_id, dst };
 186         source_change.push_file_system_edit(move_file);
 187     }
 188
 189     if let Some(InFile { file_id, value: decl_source }) = module.declaration_source(sema.db) {
 190         let file_id = file_id.original_file(sema.db);
 191         match decl_source.name() {
 192             Some(name) => source_change.insert_source_edit(
 193                 file_id,
 194                 TextEdit::replace(name.syntax().text_range(), new_name.to_string()),
 195             ),
 196             _ => never!("Module source node is missing a name"),
 197         }
 198     }
 199     let def = Definition::Module(module);
 200     let usages = def.usages(sema).all();
 201     let ref_edits = usages.iter().map(|(&file_id, references)| {
 202         (file_id, source_edit_from_references(references, def, new_name))
 203     });
 204     source_change.extend(ref_edits);
 205
 206     Ok(source_change)
 207 }
 208
 209 fn rename_reference(
 210     sema: &Semantics<RootDatabase>,
 211     mut def: Definition,
 212     new_name: &str,
 213 ) -> Result<SourceChange> {
 214     let ident_kind = IdentifierKind::classify(new_name)?;
 215
 216     if matches!(
 217         def,
 218         Definition::GenericParam(hir::GenericParam::LifetimeParam(_)) | Definition::Label(_)
 219     ) {
 220         match ident_kind {
 221             IdentifierKind::Ident | IdentifierKind::Underscore => {
 222                 cov_mark::hit!(rename_not_a_lifetime_ident_ref);
 223                 bail!("Invalid name `{}`: not a lifetime identifier", new_name);
 224             }
 225             IdentifierKind::Lifetime => cov_mark::hit!(rename_lifetime),
 226         }
 227     } else {
 228         match ident_kind {
 229             IdentifierKind::Lifetime => {
 230                 cov_mark::hit!(rename_not_an_ident_ref);
 231                 bail!("Invalid name `{}`: not an identifier", new_name);
 232             }
 233             IdentifierKind::Ident => cov_mark::hit!(rename_non_local),
 234             IdentifierKind::Underscore => (),
 235         }
 236     }
 237
 238     let assoc_item = match def {
 239         // HACK: resolve trait impl items to the item def of the trait definition
 240         // so that we properly resolve all trait item references
 241         Definition::Function(it) => it.as_assoc_item(sema.db),
 242         Definition::TypeAlias(it) => it.as_assoc_item(sema.db),
 243         Definition::Const(it) => it.as_assoc_item(sema.db),
 244         _ => None,
 245     };
 246     def = match assoc_item {
 247         Some(assoc) => assoc
 248             .containing_trait_impl(sema.db)
 249             .and_then(|trait_| {
 250                 trait_.items(sema.db).into_iter().find_map(|it| match (it, assoc) {
 251                     (hir::AssocItem::Function(trait_func), hir::AssocItem::Function(func))
 252                         if trait_func.name(sema.db) == func.name(sema.db) =>
 253                     {
 254                         Some(Definition::Function(trait_func))
 255                     }
 256                     (hir::AssocItem::Const(trait_konst), hir::AssocItem::Const(konst))
 257                         if trait_konst.name(sema.db) == konst.name(sema.db) =>
 258                     {
 259                         Some(Definition::Const(trait_konst))
 260                     }
 261                     (
 262                         hir::AssocItem::TypeAlias(trait_type_alias),
 263                         hir::AssocItem::TypeAlias(type_alias),
 264                     ) if trait_type_alias.name(sema.db) == type_alias.name(sema.db) => {
 265                         Some(Definition::TypeAlias(trait_type_alias))
 266                     }
 267                     _ => None,
 268                 })
 269             })
 270             .unwrap_or(def),
 271         None => def,
 272     };
 273     let usages = def.usages(sema).all();
 274
 275     if !usages.is_empty() && ident_kind == IdentifierKind::Underscore {
 276         cov_mark::hit!(rename_underscore_multiple);
 277         bail!("Cannot rename reference to `_` as it is being referenced multiple times");
 278     }
 279     let mut source_change = SourceChange::default();
 280     source_change.extend(usages.iter().map(|(&file_id, references)| {
 281         (file_id, source_edit_from_references(references, def, new_name))
 282     }));
 283
 284     let (file_id, edit) = source_edit_from_def(sema, def, new_name)?;
 285     source_change.insert_source_edit(file_id, edit);
 286     Ok(source_change)
 287 }
 288
 289 pub fn source_edit_from_references(
 290     references: &[FileReference],
 291     def: Definition,
 292     new_name: &str,
 293 ) -> TextEdit {
 294     let mut edit = TextEdit::builder();
 295     // macros can cause multiple refs to occur for the same text range, so keep track of what we have edited so far
 296     let mut edited_ranges = Vec::new();
 297     for &FileReference { range, ref name, .. } in references {
 298         let has_emitted_edit = match name {
 299             // if the ranges differ then the node is inside a macro call, we can't really attempt
 300             // to make special rewrites like shorthand syntax and such, so just rename the node in
 301             // the macro input
 302             ast::NameLike::NameRef(name_ref) if name_ref.syntax().text_range() == range => {
 303                 source_edit_from_name_ref(&mut edit, name_ref, new_name, def)
 304             }
 305             ast::NameLike::Name(name) if name.syntax().text_range() == range => {
 306                 source_edit_from_name(&mut edit, name, new_name)
 307             }
 308             _ => false,
 309         };
 310         if !has_emitted_edit {
 311             if !edited_ranges.contains(&range.start()) {
 312                 edit.replace(range, new_name.to_string());
 313                 edited_ranges.push(range.start());
 314             }
 315         }
 316     }
 317
 318     edit.finish()
 319 }
 320
 321 fn source_edit_from_name(edit: &mut TextEditBuilder, name: &ast::Name, new_name: &str) -> bool {
 322     if ast::RecordPatField::for_field_name(name).is_some() {
 323         if let Some(ident_pat) = name.syntax().parent().and_then(ast::IdentPat::cast) {
 324             cov_mark::hit!(rename_record_pat_field_name_split);
 325             // Foo { ref mut field } -> Foo { new_name: ref mut field }
 326             //      ^ insert `new_name: `
 327
 328             // FIXME: instead of splitting the shorthand, recursively trigger a rename of the
 329             // other name https://github.com/rust-analyzer/rust-analyzer/issues/6547
 330             edit.insert(ident_pat.syntax().text_range().start(), format!("{}: ", new_name));
 331             return true;
 332         }
 333     }
 334
 335     false
 336 }
 337
 338 fn source_edit_from_name_ref(
 339     edit: &mut TextEditBuilder,
 340     name_ref: &ast::NameRef,
 341     new_name: &str,
 342     def: Definition,
 343 ) -> bool {
 344     if let Some(record_field) = ast::RecordExprField::for_name_ref(name_ref) {
 345         let rcf_name_ref = record_field.name_ref();
 346         let rcf_expr = record_field.expr();
 347         match &(rcf_name_ref, rcf_expr.and_then(|it| expr_as_name_ref(&it))) {
 348             // field: init-expr, check if we can use a field init shorthand
 349             (Some(field_name), Some(init)) => {
 350                 if field_name == name_ref {
 351                     if init.text() == new_name {
 352                         cov_mark::hit!(test_rename_field_put_init_shorthand);
 353                         // Foo { field: local } -> Foo { local }
 354                         //       ^^^^^^^ delete this
 355
 356                         // same names, we can use a shorthand here instead.
 357                         // we do not want to erase attributes hence this range start
 358                         let s = field_name.syntax().text_range().start();
 359                         let e = init.syntax().text_range().start();
 360                         edit.delete(TextRange::new(s, e));
 361                         return true;
 362                     }
 363                 } else if init == name_ref {
 364                     if field_name.text() == new_name {
 365                         cov_mark::hit!(test_rename_local_put_init_shorthand);
 366                         // Foo { field: local } -> Foo { field }
 367                         //            ^^^^^^^ delete this
 368
 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().end();
 372                         let e = init.syntax().text_range().end();
 373                         edit.delete(TextRange::new(s, e));
 374                         return true;
 375                     }
 376                 }
 377             }
 378             // init shorthand
 379             (None, Some(_)) if matches!(def, Definition::Field(_)) => {
 380                 cov_mark::hit!(test_rename_field_in_field_shorthand);
 381                 // Foo { field } -> Foo { new_name: field }
 382                 //       ^ insert `new_name: `
 383                 let offset = name_ref.syntax().text_range().start();
 384                 edit.insert(offset, format!("{}: ", new_name));
 385                 return true;
 386             }
 387             (None, Some(_)) if matches!(def, Definition::Local(_)) => {
 388                 cov_mark::hit!(test_rename_local_in_field_shorthand);
 389                 // Foo { field } -> Foo { field: new_name }
 390                 //            ^ insert `: new_name`
 391                 let offset = name_ref.syntax().text_range().end();
 392                 edit.insert(offset, format!(": {}", new_name));
 393                 return true;
 394             }
 395             _ => (),
 396         }
 397     } else if let Some(record_field) = ast::RecordPatField::for_field_name_ref(name_ref) {
 398         let rcf_name_ref = record_field.name_ref();
 399         let rcf_pat = record_field.pat();
 400         match (rcf_name_ref, rcf_pat) {
 401             // field: rename
 402             (Some(field_name), Some(ast::Pat::IdentPat(pat)))
 403                 if field_name == *name_ref && pat.at_token().is_none() =>
 404             {
 405                 // field name is being renamed
 406                 if let Some(name) = pat.name() {
 407                     if name.text() == new_name {
 408                         cov_mark::hit!(test_rename_field_put_init_shorthand_pat);
 409                         // Foo { field: ref mut local } -> Foo { ref mut field }
 410                         //       ^^^^^^^ delete this
 411                         //                      ^^^^^ replace this with `field`
 412
 413                         // same names, we can use a shorthand here instead/
 414                         // we do not want to erase attributes hence this range start
 415                         let s = field_name.syntax().text_range().start();
 416                         let e = pat.syntax().text_range().start();
 417                         edit.delete(TextRange::new(s, e));
 418                         edit.replace(name.syntax().text_range(), new_name.to_string());
 419                         return true;
 420                     }
 421                 }
 422             }
 423             _ => (),
 424         }
 425     }
 426     false
 427 }
 428
 429 fn source_edit_from_def(
 430     sema: &Semantics<RootDatabase>,
 431     def: Definition,
 432     new_name: &str,
 433 ) -> Result<(FileId, TextEdit)> {
 434     let FileRange { file_id, range } = def
 435         .range_for_rename(sema)
 436         .ok_or_else(|| format_err!("No identifier available to rename"))?;
 437
 438     let mut edit = TextEdit::builder();
 439     if let Definition::Local(local) = def {
 440         if let Either::Left(pat) = local.source(sema.db).value {
 441             // special cases required for renaming fields/locals in Record patterns
 442             if let Some(pat_field) = pat.syntax().parent().and_then(ast::RecordPatField::cast) {
 443                 let name_range = pat.name().unwrap().syntax().text_range();
 444                 if let Some(name_ref) = pat_field.name_ref() {
 445                     if new_name == name_ref.text() && pat.at_token().is_none() {
 446                         // Foo { field: ref mut local } -> Foo { ref mut field }
 447                         //       ^^^^^^ delete this
 448                         //                      ^^^^^ replace this with `field`
 449                         cov_mark::hit!(test_rename_local_put_init_shorthand_pat);
 450                         edit.delete(
 451                             name_ref
 452                                 .syntax()
 453                                 .text_range()
 454                                 .cover_offset(pat.syntax().text_range().start()),
 455                         );
 456                         edit.replace(name_range, name_ref.text().to_string());
 457                     } else {
 458                         // Foo { field: ref mut local @ local 2} -> Foo { field: ref mut new_name @ local2 }
 459                         // Foo { field: ref mut local } -> Foo { field: ref mut new_name }
 460                         //                      ^^^^^ replace this with `new_name`
 461                         edit.replace(name_range, new_name.to_string());
 462                     }
 463                 } else {
 464                     // Foo { ref mut field } -> Foo { field: ref mut new_name }
 465                     //      ^ insert `field: `
 466                     //               ^^^^^ replace this with `new_name`
 467                     edit.insert(
 468                         pat.syntax().text_range().start(),
 469                         format!("{}: ", pat_field.field_name().unwrap()),
 470                     );
 471                     edit.replace(name_range, new_name.to_string());
 472                 }
 473             }
 474         }
 475     }
 476     if edit.is_empty() {
 477         edit.replace(range, new_name.to_string());
 478     }
 479     Ok((file_id, edit.finish()))
 480 }
 481
 482 #[derive(Copy, Clone, Debug, PartialEq)]
 483 pub enum IdentifierKind {
 484     Ident,
 485     Lifetime,
 486     Underscore,
 487 }
 488
 489 impl IdentifierKind {
 490     pub fn classify(new_name: &str) -> Result<IdentifierKind> {
 491         match lex_single_syntax_kind(new_name) {
 492             Some(res) => match res {
 493                 (SyntaxKind::IDENT, _) => Ok(IdentifierKind::Ident),
 494                 (T![_], _) => Ok(IdentifierKind::Underscore),
 495                 (SyntaxKind::LIFETIME_IDENT, _) if new_name != "'static" && new_name != "'_" => {
 496                     Ok(IdentifierKind::Lifetime)
 497                 }
 498                 (SyntaxKind::LIFETIME_IDENT, _) => {
 499                     bail!("Invalid name `{}`: not a lifetime identifier", new_name)
 500                 }
 501                 (_, Some(syntax_error)) => bail!("Invalid name `{}`: {}", new_name, syntax_error),
 502                 (_, None) => bail!("Invalid name `{}`: not an identifier", new_name),
 503             },
 504             None => bail!("Invalid name `{}`: not an identifier", new_name),
 505         }
 506     }
 507 }