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::ModuleDef(hir::ModuleDef::Module(module)) => {
  71                 rename_mod(sema, module, new_name)
  72             }
  73             Definition::ModuleDef(hir::ModuleDef::BuiltinType(_)) => {
  74                 bail!("Cannot rename builtin type")
  75             }
  76             Definition::SelfType(_) => bail!("Cannot rename `Self`"),
  77             def => rename_reference(sema, def, new_name),
  78         }
  79     }
  80
  81     /// Textual range of the identifier which will change when renaming this
  82     /// `Definition`. Note that some definitions, like buitin types, can't be
  83     /// renamed.
  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()?,
  91                 };
  92                 src.with_value(name.syntax()).original_file_range_opt(sema.db)
  93             }
  94             Definition::Field(field) => {
  95                 let src = field.source(sema.db)?;
  96                 match &src.value {
  97                     FieldSource::Named(record_field) => {
  98                         let name = record_field.name()?;
  99                         src.with_value(name.syntax()).original_file_range_opt(sema.db)
 100                     }
 101                     FieldSource::Pos(_) => None,
 102                 }
 103             }
 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)
 109                 }
 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),
 115                 },
 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,
 122             },
 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,
 129                 };
 130                 src.with_value(name.syntax()).original_file_range_opt(sema.db)
 131             }
 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,
 138                     };
 139                     src.with_value(name.syntax()).original_file_range_opt(sema.db)
 140                 }
 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)
 145                 }
 146                 hir::GenericParam::ConstParam(it) => name_range(it, sema),
 147             },
 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)
 152             }
 153         };
 154         return res;
 155
 156         fn name_range<D>(def: D, sema: &Semantics<RootDatabase>) -> Option<FileRange>
 157         where
 158             D: HasSource,
 159             D::Ast: ast::HasName,
 160         {
 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)
 164         }
 165     }
 166 }
 167
 168 fn rename_mod(
 169     sema: &Semantics<RootDatabase>,
 170     module: hir::Module,
 171     new_name: &str,
 172 ) -> Result<SourceChange> {
 173     if IdentifierKind::classify(new_name)? != IdentifierKind::Ident {
 174         bail!("Invalid name `{0}`: cannot rename module to {0}", new_name);
 175     }
 176
 177     let mut source_change = SourceChange::default();
 178
 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)
 185         } else {
 186             format!("{}.rs", new_name)
 187         };
 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);
 191     }
 192
 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(
 197                 file_id,
 198                 TextEdit::replace(name.syntax().text_range(), new_name.to_string()),
 199             ),
 200             _ => never!("Module source node is missing a name"),
 201         }
 202     }
 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))
 207     });
 208     source_change.extend(ref_edits);
 209
 210     Ok(source_change)
 211 }
 212
 213 fn rename_reference(
 214     sema: &Semantics<RootDatabase>,
 215     mut def: Definition,
 216     new_name: &str,
 217 ) -> Result<SourceChange> {
 218     let ident_kind = IdentifierKind::classify(new_name)?;
 219
 220     if matches!(
 221         def,
 222         Definition::GenericParam(hir::GenericParam::LifetimeParam(_)) | Definition::Label(_)
 223     ) {
 224         match ident_kind {
 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);
 228             }
 229             IdentifierKind::Lifetime => cov_mark::hit!(rename_lifetime),
 230         }
 231     } else {
 232         match ident_kind {
 233             IdentifierKind::Lifetime => {
 234                 cov_mark::hit!(rename_not_an_ident_ref);
 235                 bail!("Invalid name `{}`: not an identifier", new_name);
 236             }
 237             IdentifierKind::Ident => cov_mark::hit!(rename_non_local),
 238             IdentifierKind::Underscore => (),
 239         }
 240     }
 241
 242     def = match def {
 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))
 248             .and_then(|it| {
 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) =>
 252                     {
 253                         Some(Definition::ModuleDef(hir::ModuleDef::Function(trait_func)))
 254                     }
 255                     (hir::AssocItem::Const(trait_konst), hir::ModuleDef::Const(konst))
 256                         if trait_konst.name(sema.db) == konst.name(sema.db) =>
 257                     {
 258                         Some(Definition::ModuleDef(hir::ModuleDef::Const(trait_konst)))
 259                     }
 260                     (
 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)))
 265                     }
 266                     _ => None,
 267                 })
 268             })
 269             .unwrap_or(def),
 270         _ => def,
 271     };
 272     let usages = def.usages(sema).all();
 273
 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");
 277     }
 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))
 281     }));
 282
 283     let (file_id, edit) = source_edit_from_def(sema, def, new_name)?;
 284     source_change.insert_source_edit(file_id, edit);
 285     Ok(source_change)
 286 }
 287
 288 pub fn source_edit_from_references(
 289     references: &[FileReference],
 290     def: Definition,
 291     new_name: &str,
 292 ) -> TextEdit {
 293     let mut edit = TextEdit::builder();
 294     // macros can cause multiple refs to occur for the same text range, so keep track of what we have edited so far
 295     let mut edited_ranges = Vec::new();
 296     for &FileReference { range, ref name, .. } in references {
 297         let has_emitted_edit = match name {
 298             // if the ranges differ then the node is inside a macro call, we can't really attempt
 299             // to make special rewrites like shorthand syntax and such, so just rename the node in
 300             // the macro input
 301             ast::NameLike::NameRef(name_ref) if name_ref.syntax().text_range() == range => {
 302                 source_edit_from_name_ref(&mut edit, name_ref, new_name, def)
 303             }
 304             ast::NameLike::Name(name) if name.syntax().text_range() == range => {
 305                 source_edit_from_name(&mut edit, name, new_name)
 306             }
 307             _ => false,
 308         };
 309         if !has_emitted_edit {
 310             if !edited_ranges.contains(&range.start()) {
 311                 edit.replace(range, new_name.to_string());
 312                 edited_ranges.push(range.start());
 313             }
 314         }
 315     }
 316
 317     edit.finish()
 318 }
 319
 320 fn source_edit_from_name(edit: &mut TextEditBuilder, name: &ast::Name, new_name: &str) -> bool {
 321     if let Some(_) = ast::RecordPatField::for_field_name(name) {
 322         if let Some(ident_pat) = name.syntax().parent().and_then(ast::IdentPat::cast) {
 323             cov_mark::hit!(rename_record_pat_field_name_split);
 324             // Foo { ref mut field } -> Foo { new_name: ref mut field }
 325             //      ^ insert `new_name: `
 326
 327             // FIXME: instead of splitting the shorthand, recursively trigger a rename of the
 328             // other name https://github.com/rust-analyzer/rust-analyzer/issues/6547
 329             edit.insert(ident_pat.syntax().text_range().start(), format!("{}: ", new_name));
 330             return true;
 331         }
 332     }
 333
 334     false
 335 }
 336
 337 fn source_edit_from_name_ref(
 338     edit: &mut TextEditBuilder,
 339     name_ref: &ast::NameRef,
 340     new_name: &str,
 341     def: Definition,
 342 ) -> bool {
 343     if let Some(record_field) = ast::RecordExprField::for_name_ref(name_ref) {
 344         let rcf_name_ref = record_field.name_ref();
 345         let rcf_expr = record_field.expr();
 346         match &(rcf_name_ref, rcf_expr.and_then(|it| expr_as_name_ref(&it))) {
 347             // field: init-expr, check if we can use a field init shorthand
 348             (Some(field_name), Some(init)) => {
 349                 if field_name == name_ref {
 350                     if init.text() == new_name {
 351                         cov_mark::hit!(test_rename_field_put_init_shorthand);
 352                         // Foo { field: local } -> Foo { local }
 353                         //       ^^^^^^^ delete this
 354
 355                         // same names, we can use a shorthand here instead.
 356                         // we do not want to erase attributes hence this range start
 357                         let s = field_name.syntax().text_range().start();
 358                         let e = init.syntax().text_range().start();
 359                         edit.delete(TextRange::new(s, e));
 360                         return true;
 361                     }
 362                 } else if init == name_ref {
 363                     if field_name.text() == new_name {
 364                         cov_mark::hit!(test_rename_local_put_init_shorthand);
 365                         // Foo { field: local } -> Foo { field }
 366                         //            ^^^^^^^ delete this
 367
 368                         // same names, we can use a shorthand here instead.
 369                         // we do not want to erase attributes hence this range start
 370                         let s = field_name.syntax().text_range().end();
 371                         let e = init.syntax().text_range().end();
 372                         edit.delete(TextRange::new(s, e));
 373                         return true;
 374                     }
 375                 }
 376             }
 377             // init shorthand
 378             (None, Some(_)) if matches!(def, Definition::Field(_)) => {
 379                 cov_mark::hit!(test_rename_field_in_field_shorthand);
 380                 // Foo { field } -> Foo { new_name: field }
 381                 //       ^ insert `new_name: `
 382                 let offset = name_ref.syntax().text_range().start();
 383                 edit.insert(offset, format!("{}: ", new_name));
 384                 return true;
 385             }
 386             (None, Some(_)) if matches!(def, Definition::Local(_)) => {
 387                 cov_mark::hit!(test_rename_local_in_field_shorthand);
 388                 // Foo { field } -> Foo { field: new_name }
 389                 //            ^ insert `: new_name`
 390                 let offset = name_ref.syntax().text_range().end();
 391                 edit.insert(offset, format!(": {}", new_name));
 392                 return true;
 393             }
 394             _ => (),
 395         }
 396     } else if let Some(record_field) = ast::RecordPatField::for_field_name_ref(name_ref) {
 397         let rcf_name_ref = record_field.name_ref();
 398         let rcf_pat = record_field.pat();
 399         match (rcf_name_ref, rcf_pat) {
 400             // field: rename
 401             (Some(field_name), Some(ast::Pat::IdentPat(pat)))
 402                 if field_name == *name_ref && pat.at_token().is_none() =>
 403             {
 404                 // field name is being renamed
 405                 if let Some(name) = pat.name() {
 406                     if name.text() == new_name {
 407                         cov_mark::hit!(test_rename_field_put_init_shorthand_pat);
 408                         // Foo { field: ref mut local } -> Foo { ref mut field }
 409                         //       ^^^^^^^ delete this
 410                         //                      ^^^^^ replace this with `field`
 411
 412                         // same names, we can use a shorthand here instead/
 413                         // we do not want to erase attributes hence this range start
 414                         let s = field_name.syntax().text_range().start();
 415                         let e = pat.syntax().text_range().start();
 416                         edit.delete(TextRange::new(s, e));
 417                         edit.replace(name.syntax().text_range(), new_name.to_string());
 418                         return true;
 419                     }
 420                 }
 421             }
 422             _ => (),
 423         }
 424     }
 425     false
 426 }
 427
 428 fn source_edit_from_def(
 429     sema: &Semantics<RootDatabase>,
 430     def: Definition,
 431     new_name: &str,
 432 ) -> Result<(FileId, TextEdit)> {
 433     let FileRange { file_id, range } = def
 434         .range_for_rename(sema)
 435         .ok_or_else(|| format_err!("No identifier available to rename"))?;
 436
 437     let mut edit = TextEdit::builder();
 438     if let Definition::Local(local) = def {
 439         if let Either::Left(pat) = local.source(sema.db).value {
 440             // special cases required for renaming fields/locals in Record patterns
 441             if let Some(pat_field) = pat.syntax().parent().and_then(ast::RecordPatField::cast) {
 442                 let name_range = pat.name().unwrap().syntax().text_range();
 443                 if let Some(name_ref) = pat_field.name_ref() {
 444                     if new_name == name_ref.text() && pat.at_token().is_none() {
 445                         // Foo { field: ref mut local } -> Foo { ref mut field }
 446                         //       ^^^^^^ delete this
 447                         //                      ^^^^^ replace this with `field`
 448                         cov_mark::hit!(test_rename_local_put_init_shorthand_pat);
 449                         edit.delete(
 450                             name_ref
 451                                 .syntax()
 452                                 .text_range()
 453                                 .cover_offset(pat.syntax().text_range().start()),
 454                         );
 455                         edit.replace(name_range, name_ref.text().to_string());
 456                     } else {
 457                         // Foo { field: ref mut local @ local 2} -> Foo { field: ref mut new_name @ local2 }
 458                         // Foo { field: ref mut local } -> Foo { field: ref mut new_name }
 459                         //                      ^^^^^ replace this with `new_name`
 460                         edit.replace(name_range, new_name.to_string());
 461                     }
 462                 } else {
 463                     // Foo { ref mut field } -> Foo { field: ref mut new_name }
 464                     //      ^ insert `field: `
 465                     //               ^^^^^ replace this with `new_name`
 466                     edit.insert(
 467                         pat.syntax().text_range().start(),
 468                         format!("{}: ", pat_field.field_name().unwrap()),
 469                     );
 470                     edit.replace(name_range, new_name.to_string());
 471                 }
 472             }
 473         }
 474     }
 475     if edit.is_empty() {
 476         edit.replace(range, new_name.to_string());
 477     }
 478     Ok((file_id, edit.finish()))
 479 }
 480
 481 #[derive(Copy, Clone, Debug, PartialEq)]
 482 pub enum IdentifierKind {
 483     Ident,
 484     Lifetime,
 485     Underscore,
 486 }
 487
 488 impl IdentifierKind {
 489     pub fn classify(new_name: &str) -> Result<IdentifierKind> {
 490         match lex_single_syntax_kind(new_name) {
 491             Some(res) => match res {
 492                 (SyntaxKind::IDENT, _) => Ok(IdentifierKind::Ident),
 493                 (T![_], _) => Ok(IdentifierKind::Underscore),
 494                 (SyntaxKind::LIFETIME_IDENT, _) if new_name != "'static" && new_name != "'_" => {
 495                     Ok(IdentifierKind::Lifetime)
 496                 }
 497                 (SyntaxKind::LIFETIME_IDENT, _) => {
 498                     bail!("Invalid name `{}`: not a lifetime identifier", new_name)
 499                 }
 500                 (_, Some(syntax_error)) => bail!("Invalid name `{}`: {}", new_name, syntax_error),
 501                 (_, None) => bail!("Invalid name `{}`: not an identifier", new_name),
 502             },
 503             None => bail!("Invalid name `{}`: not an identifier", new_name),
 504         }
 505     }
 506 }