crates/ide/src/lib.rs

   1 //! ide crate provides "ide-centric" APIs for the rust-analyzer. That is,
   2 //! it generally operates with files and text ranges, and returns results as
   3 //! Strings, suitable for displaying to the human.
   4 //!
   5 //! What powers this API are the `RootDatabase` struct, which defines a `salsa`
   6 //! database, and the `hir` crate, where majority of the analysis happens.
   7 //! However, IDE specific bits of the analysis (most notably completion) happen
   8 //! in this crate.
   9
  10 // For proving that RootDatabase is RefUnwindSafe.
  11 #![recursion_limit = "128"]
  12
  13 #[allow(unused)]
  14 macro_rules! eprintln {
  15     ($($tt:tt)*) => { stdx::eprintln!($($tt)*) };
  16 }
  17
  18 #[cfg(test)]
  19 mod fixture;
  20
  21 mod markup;
  22 mod prime_caches;
  23 mod navigation_target;
  24
  25 mod annotations;
  26 mod call_hierarchy;
  27 mod signature_help;
  28 mod doc_links;
  29 mod highlight_related;
  30 mod expand_macro;
  31 mod extend_selection;
  32 mod file_structure;
  33 mod fn_references;
  34 mod folding_ranges;
  35 mod goto_declaration;
  36 mod goto_definition;
  37 mod goto_implementation;
  38 mod goto_type_definition;
  39 mod hover;
  40 mod inlay_hints;
  41 mod join_lines;
  42 mod markdown_remove;
  43 mod matching_brace;
  44 mod moniker;
  45 mod move_item;
  46 mod parent_module;
  47 mod references;
  48 mod rename;
  49 mod runnables;
  50 mod ssr;
  51 mod static_index;
  52 mod status;
  53 mod syntax_highlighting;
  54 mod syntax_tree;
  55 mod typing;
  56 mod view_crate_graph;
  57 mod view_hir;
  58 mod view_item_tree;
  59 mod shuffle_crate_graph;
  60
  61 use std::sync::Arc;
  62
  63 use cfg::CfgOptions;
  64 use ide_db::{
  65     base_db::{
  66         salsa::{self, ParallelDatabase},
  67         CrateOrigin, Env, FileLoader, FileSet, SourceDatabase, VfsPath,
  68     },
  69     symbol_index, LineIndexDatabase,
  70 };
  71 use syntax::SourceFile;
  72
  73 use crate::navigation_target::{ToNav, TryToNav};
  74
  75 pub use crate::{
  76     annotations::{Annotation, AnnotationConfig, AnnotationKind},
  77     call_hierarchy::CallItem,
  78     expand_macro::ExpandedMacro,
  79     file_structure::{StructureNode, StructureNodeKind},
  80     folding_ranges::{Fold, FoldKind},
  81     highlight_related::{HighlightRelatedConfig, HighlightedRange},
  82     hover::{HoverAction, HoverConfig, HoverDocFormat, HoverGotoTypeData, HoverResult},
  83     inlay_hints::{InlayHint, InlayHintsConfig, InlayKind, LifetimeElisionHints},
  84     join_lines::JoinLinesConfig,
  85     markup::Markup,
  86     moniker::{MonikerKind, MonikerResult, PackageInformation},
  87     move_item::Direction,
  88     navigation_target::NavigationTarget,
  89     prime_caches::ParallelPrimeCachesProgress,
  90     references::ReferenceSearchResult,
  91     rename::RenameError,
  92     runnables::{Runnable, RunnableKind, TestId},
  93     signature_help::SignatureHelp,
  94     static_index::{StaticIndex, StaticIndexedFile, TokenId, TokenStaticData},
  95     syntax_highlighting::{
  96         tags::{Highlight, HlMod, HlMods, HlOperator, HlPunct, HlTag},
  97         HlRange,
  98     },
  99 };
 100 pub use hir::{Documentation, Semantics};
 101 pub use ide_assists::{
 102     Assist, AssistConfig, AssistId, AssistKind, AssistResolveStrategy, SingleResolve,
 103 };
 104 pub use ide_completion::{
 105     CompletionConfig, CompletionItem, CompletionItemKind, CompletionRelevance, Snippet,
 106     SnippetScope,
 107 };
 108 pub use ide_db::{
 109     base_db::{
 110         Cancelled, Change, CrateGraph, CrateId, Edition, FileId, FilePosition, FileRange,
 111         SourceRoot, SourceRootId,
 112     },
 113     label::Label,
 114     line_index::{LineCol, LineColUtf16, LineIndex},
 115     search::{ReferenceCategory, SearchScope},
 116     source_change::{FileSystemEdit, SourceChange},
 117     symbol_index::Query,
 118     RootDatabase, SymbolKind,
 119 };
 120 pub use ide_diagnostics::{Diagnostic, DiagnosticsConfig, ExprFillDefaultMode, Severity};
 121 pub use ide_ssr::SsrError;
 122 pub use syntax::{TextRange, TextSize};
 123 pub use text_edit::{Indel, TextEdit};
 124
 125 pub type Cancellable<T> = Result<T, Cancelled>;
 126
 127 /// Info associated with a text range.
 128 #[derive(Debug)]
 129 pub struct RangeInfo<T> {
 130     pub range: TextRange,
 131     pub info: T,
 132 }
 133
 134 impl<T> RangeInfo<T> {
 135     pub fn new(range: TextRange, info: T) -> RangeInfo<T> {
 136         RangeInfo { range, info }
 137     }
 138 }
 139
 140 /// `AnalysisHost` stores the current state of the world.
 141 #[derive(Debug)]
 142 pub struct AnalysisHost {
 143     db: RootDatabase,
 144 }
 145
 146 impl AnalysisHost {
 147     pub fn new(lru_capacity: Option<usize>) -> AnalysisHost {
 148         AnalysisHost { db: RootDatabase::new(lru_capacity) }
 149     }
 150
 151     pub fn update_lru_capacity(&mut self, lru_capacity: Option<usize>) {
 152         self.db.update_lru_capacity(lru_capacity);
 153     }
 154
 155     /// Returns a snapshot of the current state, which you can query for
 156     /// semantic information.
 157     pub fn analysis(&self) -> Analysis {
 158         Analysis { db: self.db.snapshot() }
 159     }
 160
 161     /// Applies changes to the current state of the world. If there are
 162     /// outstanding snapshots, they will be canceled.
 163     pub fn apply_change(&mut self, change: Change) {
 164         self.db.apply_change(change)
 165     }
 166
 167     /// NB: this clears the database
 168     pub fn per_query_memory_usage(&mut self) -> Vec<(String, profile::Bytes)> {
 169         self.db.per_query_memory_usage()
 170     }
 171     pub fn request_cancellation(&mut self) {
 172         self.db.request_cancellation();
 173     }
 174     pub fn raw_database(&self) -> &RootDatabase {
 175         &self.db
 176     }
 177     pub fn raw_database_mut(&mut self) -> &mut RootDatabase {
 178         &mut self.db
 179     }
 180
 181     pub fn shuffle_crate_graph(&mut self) {
 182         shuffle_crate_graph::shuffle_crate_graph(&mut self.db);
 183     }
 184 }
 185
 186 impl Default for AnalysisHost {
 187     fn default() -> AnalysisHost {
 188         AnalysisHost::new(None)
 189     }
 190 }
 191
 192 /// Analysis is a snapshot of a world state at a moment in time. It is the main
 193 /// entry point for asking semantic information about the world. When the world
 194 /// state is advanced using `AnalysisHost::apply_change` method, all existing
 195 /// `Analysis` are canceled (most method return `Err(Canceled)`).
 196 #[derive(Debug)]
 197 pub struct Analysis {
 198     db: salsa::Snapshot<RootDatabase>,
 199 }
 200
 201 // As a general design guideline, `Analysis` API are intended to be independent
 202 // from the language server protocol. That is, when exposing some functionality
 203 // we should think in terms of "what API makes most sense" and not in terms of
 204 // "what types LSP uses". Although currently LSP is the only consumer of the
 205 // API, the API should in theory be usable as a library, or via a different
 206 // protocol.
 207 impl Analysis {
 208     // Creates an analysis instance for a single file, without any extenal
 209     // dependencies, stdlib support or ability to apply changes. See
 210     // `AnalysisHost` for creating a fully-featured analysis.
 211     pub fn from_single_file(text: String) -> (Analysis, FileId) {
 212         let mut host = AnalysisHost::default();
 213         let file_id = FileId(0);
 214         let mut file_set = FileSet::default();
 215         file_set.insert(file_id, VfsPath::new_virtual_path("/main.rs".to_string()));
 216         let source_root = SourceRoot::new_local(file_set);
 217
 218         let mut change = Change::new();
 219         change.set_roots(vec![source_root]);
 220         let mut crate_graph = CrateGraph::default();
 221         // FIXME: cfg options
 222         // Default to enable test for single file.
 223         let mut cfg_options = CfgOptions::default();
 224         cfg_options.insert_atom("test".into());
 225         crate_graph.add_crate_root(
 226             file_id,
 227             Edition::CURRENT,
 228             None,
 229             None,
 230             cfg_options.clone(),
 231             cfg_options,
 232             Env::default(),
 233             Default::default(),
 234             false,
 235             CrateOrigin::CratesIo { repo: None },
 236         );
 237         change.change_file(file_id, Some(Arc::new(text)));
 238         change.set_crate_graph(crate_graph);
 239         host.apply_change(change);
 240         (host.analysis(), file_id)
 241     }
 242
 243     /// Debug info about the current state of the analysis.
 244     pub fn status(&self, file_id: Option<FileId>) -> Cancellable<String> {
 245         self.with_db(|db| status::status(&*db, file_id))
 246     }
 247
 248     pub fn parallel_prime_caches<F>(&self, num_worker_threads: u8, cb: F) -> Cancellable<()>
 249     where
 250         F: Fn(ParallelPrimeCachesProgress) + Sync + std::panic::UnwindSafe,
 251     {
 252         self.with_db(move |db| prime_caches::parallel_prime_caches(db, num_worker_threads, &cb))
 253     }
 254
 255     /// Gets the text of the source file.
 256     pub fn file_text(&self, file_id: FileId) -> Cancellable<Arc<String>> {
 257         self.with_db(|db| db.file_text(file_id))
 258     }
 259
 260     /// Gets the syntax tree of the file.
 261     pub fn parse(&self, file_id: FileId) -> Cancellable<SourceFile> {
 262         self.with_db(|db| db.parse(file_id).tree())
 263     }
 264
 265     /// Returns true if this file belongs to an immutable library.
 266     pub fn is_library_file(&self, file_id: FileId) -> Cancellable<bool> {
 267         use ide_db::base_db::SourceDatabaseExt;
 268         self.with_db(|db| db.source_root(db.file_source_root(file_id)).is_library)
 269     }
 270
 271     /// Gets the file's `LineIndex`: data structure to convert between absolute
 272     /// offsets and line/column representation.
 273     pub fn file_line_index(&self, file_id: FileId) -> Cancellable<Arc<LineIndex>> {
 274         self.with_db(|db| db.line_index(file_id))
 275     }
 276
 277     /// Selects the next syntactic nodes encompassing the range.
 278     pub fn extend_selection(&self, frange: FileRange) -> Cancellable<TextRange> {
 279         self.with_db(|db| extend_selection::extend_selection(db, frange))
 280     }
 281
 282     /// Returns position of the matching brace (all types of braces are
 283     /// supported).
 284     pub fn matching_brace(&self, position: FilePosition) -> Cancellable<Option<TextSize>> {
 285         self.with_db(|db| {
 286             let parse = db.parse(position.file_id);
 287             let file = parse.tree();
 288             matching_brace::matching_brace(&file, position.offset)
 289         })
 290     }
 291
 292     /// Returns a syntax tree represented as `String`, for debug purposes.
 293     // FIXME: use a better name here.
 294     pub fn syntax_tree(
 295         &self,
 296         file_id: FileId,
 297         text_range: Option<TextRange>,
 298     ) -> Cancellable<String> {
 299         self.with_db(|db| syntax_tree::syntax_tree(db, file_id, text_range))
 300     }
 301
 302     pub fn view_hir(&self, position: FilePosition) -> Cancellable<String> {
 303         self.with_db(|db| view_hir::view_hir(db, position))
 304     }
 305
 306     pub fn view_item_tree(&self, file_id: FileId) -> Cancellable<String> {
 307         self.with_db(|db| view_item_tree::view_item_tree(db, file_id))
 308     }
 309
 310     /// Renders the crate graph to GraphViz "dot" syntax.
 311     pub fn view_crate_graph(&self, full: bool) -> Cancellable<Result<String, String>> {
 312         self.with_db(|db| view_crate_graph::view_crate_graph(db, full))
 313     }
 314
 315     pub fn expand_macro(&self, position: FilePosition) -> Cancellable<Option<ExpandedMacro>> {
 316         self.with_db(|db| expand_macro::expand_macro(db, position))
 317     }
 318
 319     /// Returns an edit to remove all newlines in the range, cleaning up minor
 320     /// stuff like trailing commas.
 321     pub fn join_lines(&self, config: &JoinLinesConfig, frange: FileRange) -> Cancellable<TextEdit> {
 322         self.with_db(|db| {
 323             let parse = db.parse(frange.file_id);
 324             join_lines::join_lines(config, &parse.tree(), frange.range)
 325         })
 326     }
 327
 328     /// Returns an edit which should be applied when opening a new line, fixing
 329     /// up minor stuff like continuing the comment.
 330     /// The edit will be a snippet (with `$0`).
 331     pub fn on_enter(&self, position: FilePosition) -> Cancellable<Option<TextEdit>> {
 332         self.with_db(|db| typing::on_enter(db, position))
 333     }
 334
 335     /// Returns an edit which should be applied after a character was typed.
 336     ///
 337     /// This is useful for some on-the-fly fixups, like adding `;` to `let =`
 338     /// automatically.
 339     pub fn on_char_typed(
 340         &self,
 341         position: FilePosition,
 342         char_typed: char,
 343     ) -> Cancellable<Option<SourceChange>> {
 344         // Fast path to not even parse the file.
 345         if !typing::TRIGGER_CHARS.contains(char_typed) {
 346             return Ok(None);
 347         }
 348         self.with_db(|db| typing::on_char_typed(db, position, char_typed))
 349     }
 350
 351     /// Returns a tree representation of symbols in the file. Useful to draw a
 352     /// file outline.
 353     pub fn file_structure(&self, file_id: FileId) -> Cancellable<Vec<StructureNode>> {
 354         self.with_db(|db| file_structure::file_structure(&db.parse(file_id).tree()))
 355     }
 356
 357     /// Returns a list of the places in the file where type hints can be displayed.
 358     pub fn inlay_hints(
 359         &self,
 360         config: &InlayHintsConfig,
 361         file_id: FileId,
 362         range: Option<FileRange>,
 363     ) -> Cancellable<Vec<InlayHint>> {
 364         self.with_db(|db| inlay_hints::inlay_hints(db, file_id, range, config))
 365     }
 366
 367     /// Returns the set of folding ranges.
 368     pub fn folding_ranges(&self, file_id: FileId) -> Cancellable<Vec<Fold>> {
 369         self.with_db(|db| folding_ranges::folding_ranges(&db.parse(file_id).tree()))
 370     }
 371
 372     /// Fuzzy searches for a symbol.
 373     pub fn symbol_search(&self, query: Query) -> Cancellable<Vec<NavigationTarget>> {
 374         self.with_db(|db| {
 375             symbol_index::world_symbols(db, query)
 376                 .into_iter() // xx: should we make this a par iter?
 377                 .filter_map(|s| s.try_to_nav(db))
 378                 .collect::<Vec<_>>()
 379         })
 380     }
 381
 382     /// Returns the definitions from the symbol at `position`.
 383     pub fn goto_definition(
 384         &self,
 385         position: FilePosition,
 386     ) -> Cancellable<Option<RangeInfo<Vec<NavigationTarget>>>> {
 387         self.with_db(|db| goto_definition::goto_definition(db, position))
 388     }
 389
 390     /// Returns the declaration from the symbol at `position`.
 391     pub fn goto_declaration(
 392         &self,
 393         position: FilePosition,
 394     ) -> Cancellable<Option<RangeInfo<Vec<NavigationTarget>>>> {
 395         self.with_db(|db| goto_declaration::goto_declaration(db, position))
 396     }
 397
 398     /// Returns the impls from the symbol at `position`.
 399     pub fn goto_implementation(
 400         &self,
 401         position: FilePosition,
 402     ) -> Cancellable<Option<RangeInfo<Vec<NavigationTarget>>>> {
 403         self.with_db(|db| goto_implementation::goto_implementation(db, position))
 404     }
 405
 406     /// Returns the type definitions for the symbol at `position`.
 407     pub fn goto_type_definition(
 408         &self,
 409         position: FilePosition,
 410     ) -> Cancellable<Option<RangeInfo<Vec<NavigationTarget>>>> {
 411         self.with_db(|db| goto_type_definition::goto_type_definition(db, position))
 412     }
 413
 414     /// Finds all usages of the reference at point.
 415     pub fn find_all_refs(
 416         &self,
 417         position: FilePosition,
 418         search_scope: Option<SearchScope>,
 419     ) -> Cancellable<Option<Vec<ReferenceSearchResult>>> {
 420         self.with_db(|db| references::find_all_refs(&Semantics::new(db), position, search_scope))
 421     }
 422
 423     /// Finds all methods and free functions for the file. Does not return tests!
 424     pub fn find_all_methods(&self, file_id: FileId) -> Cancellable<Vec<FileRange>> {
 425         self.with_db(|db| fn_references::find_all_methods(db, file_id))
 426     }
 427
 428     /// Returns a short text describing element at position.
 429     pub fn hover(
 430         &self,
 431         config: &HoverConfig,
 432         range: FileRange,
 433     ) -> Cancellable<Option<RangeInfo<HoverResult>>> {
 434         self.with_db(|db| hover::hover(db, range, config))
 435     }
 436
 437     /// Returns moniker of symbol at position.
 438     pub fn moniker(
 439         &self,
 440         position: FilePosition,
 441     ) -> Cancellable<Option<RangeInfo<Vec<moniker::MonikerResult>>>> {
 442         self.with_db(|db| moniker::moniker(db, position))
 443     }
 444
 445     /// Return URL(s) for the documentation of the symbol under the cursor.
 446     pub fn external_docs(
 447         &self,
 448         position: FilePosition,
 449     ) -> Cancellable<Option<doc_links::DocumentationLink>> {
 450         self.with_db(|db| doc_links::external_docs(db, &position))
 451     }
 452
 453     /// Computes parameter information at the given position.
 454     pub fn signature_help(&self, position: FilePosition) -> Cancellable<Option<SignatureHelp>> {
 455         self.with_db(|db| signature_help::signature_help(db, position))
 456     }
 457
 458     /// Computes call hierarchy candidates for the given file position.
 459     pub fn call_hierarchy(
 460         &self,
 461         position: FilePosition,
 462     ) -> Cancellable<Option<RangeInfo<Vec<NavigationTarget>>>> {
 463         self.with_db(|db| call_hierarchy::call_hierarchy(db, position))
 464     }
 465
 466     /// Computes incoming calls for the given file position.
 467     pub fn incoming_calls(&self, position: FilePosition) -> Cancellable<Option<Vec<CallItem>>> {
 468         self.with_db(|db| call_hierarchy::incoming_calls(db, position))
 469     }
 470
 471     /// Computes outgoing calls for the given file position.
 472     pub fn outgoing_calls(&self, position: FilePosition) -> Cancellable<Option<Vec<CallItem>>> {
 473         self.with_db(|db| call_hierarchy::outgoing_calls(db, position))
 474     }
 475
 476     /// Returns a `mod name;` declaration which created the current module.
 477     pub fn parent_module(&self, position: FilePosition) -> Cancellable<Vec<NavigationTarget>> {
 478         self.with_db(|db| parent_module::parent_module(db, position))
 479     }
 480
 481     /// Returns crates this file belongs too.
 482     pub fn crate_for(&self, file_id: FileId) -> Cancellable<Vec<CrateId>> {
 483         self.with_db(|db| parent_module::crate_for(db, file_id))
 484     }
 485
 486     /// Returns the edition of the given crate.
 487     pub fn crate_edition(&self, crate_id: CrateId) -> Cancellable<Edition> {
 488         self.with_db(|db| db.crate_graph()[crate_id].edition)
 489     }
 490
 491     /// Returns the root file of the given crate.
 492     pub fn crate_root(&self, crate_id: CrateId) -> Cancellable<FileId> {
 493         self.with_db(|db| db.crate_graph()[crate_id].root_file_id)
 494     }
 495
 496     /// Returns the set of possible targets to run for the current file.
 497     pub fn runnables(&self, file_id: FileId) -> Cancellable<Vec<Runnable>> {
 498         self.with_db(|db| runnables::runnables(db, file_id))
 499     }
 500
 501     /// Returns the set of tests for the given file position.
 502     pub fn related_tests(
 503         &self,
 504         position: FilePosition,
 505         search_scope: Option<SearchScope>,
 506     ) -> Cancellable<Vec<Runnable>> {
 507         self.with_db(|db| runnables::related_tests(db, position, search_scope))
 508     }
 509
 510     /// Computes syntax highlighting for the given file
 511     pub fn highlight(&self, file_id: FileId) -> Cancellable<Vec<HlRange>> {
 512         self.with_db(|db| syntax_highlighting::highlight(db, file_id, None, false))
 513     }
 514
 515     /// Computes all ranges to highlight for a given item in a file.
 516     pub fn highlight_related(
 517         &self,
 518         config: HighlightRelatedConfig,
 519         position: FilePosition,
 520     ) -> Cancellable<Option<Vec<HighlightedRange>>> {
 521         self.with_db(|db| {
 522             highlight_related::highlight_related(&Semantics::new(db), config, position)
 523         })
 524     }
 525
 526     /// Computes syntax highlighting for the given file range.
 527     pub fn highlight_range(&self, frange: FileRange) -> Cancellable<Vec<HlRange>> {
 528         self.with_db(|db| {
 529             syntax_highlighting::highlight(db, frange.file_id, Some(frange.range), false)
 530         })
 531     }
 532
 533     /// Computes syntax highlighting for the given file.
 534     pub fn highlight_as_html(&self, file_id: FileId, rainbow: bool) -> Cancellable<String> {
 535         self.with_db(|db| syntax_highlighting::highlight_as_html(db, file_id, rainbow))
 536     }
 537
 538     /// Computes completions at the given position.
 539     pub fn completions(
 540         &self,
 541         config: &CompletionConfig,
 542         position: FilePosition,
 543     ) -> Cancellable<Option<Vec<CompletionItem>>> {
 544         self.with_db(|db| ide_completion::completions(db, config, position).map(Into::into))
 545     }
 546
 547     /// Resolves additional completion data at the position given.
 548     pub fn resolve_completion_edits(
 549         &self,
 550         config: &CompletionConfig,
 551         position: FilePosition,
 552         imports: impl IntoIterator<Item = (String, String)> + std::panic::UnwindSafe,
 553     ) -> Cancellable<Vec<TextEdit>> {
 554         Ok(self
 555             .with_db(|db| ide_completion::resolve_completion_edits(db, config, position, imports))?
 556             .unwrap_or_default())
 557     }
 558
 559     /// Computes the set of diagnostics for the given file.
 560     pub fn diagnostics(
 561         &self,
 562         config: &DiagnosticsConfig,
 563         resolve: AssistResolveStrategy,
 564         file_id: FileId,
 565     ) -> Cancellable<Vec<Diagnostic>> {
 566         self.with_db(|db| ide_diagnostics::diagnostics(db, config, &resolve, file_id))
 567     }
 568
 569     /// Convenience function to return assists + quick fixes for diagnostics
 570     pub fn assists_with_fixes(
 571         &self,
 572         assist_config: &AssistConfig,
 573         diagnostics_config: &DiagnosticsConfig,
 574         resolve: AssistResolveStrategy,
 575         frange: FileRange,
 576     ) -> Cancellable<Vec<Assist>> {
 577         let include_fixes = match &assist_config.allowed {
 578             Some(it) => it.iter().any(|&it| it == AssistKind::None || it == AssistKind::QuickFix),
 579             None => true,
 580         };
 581
 582         self.with_db(|db| {
 583             let diagnostic_assists = if include_fixes {
 584                 ide_diagnostics::diagnostics(db, diagnostics_config, &resolve, frange.file_id)
 585                     .into_iter()
 586                     .flat_map(|it| it.fixes.unwrap_or_default())
 587                     .filter(|it| it.target.intersect(frange.range).is_some())
 588                     .collect()
 589             } else {
 590                 Vec::new()
 591             };
 592             let ssr_assists = ssr::ssr_assists(db, &resolve, frange);
 593             let assists = ide_assists::assists(db, assist_config, resolve, frange);
 594
 595             let mut res = diagnostic_assists;
 596             res.extend(ssr_assists.into_iter());
 597             res.extend(assists.into_iter());
 598
 599             res
 600         })
 601     }
 602
 603     /// Returns the edit required to rename reference at the position to the new
 604     /// name.
 605     pub fn rename(
 606         &self,
 607         position: FilePosition,
 608         new_name: &str,
 609     ) -> Cancellable<Result<SourceChange, RenameError>> {
 610         self.with_db(|db| rename::rename(db, position, new_name))
 611     }
 612
 613     pub fn prepare_rename(
 614         &self,
 615         position: FilePosition,
 616     ) -> Cancellable<Result<RangeInfo<()>, RenameError>> {
 617         self.with_db(|db| rename::prepare_rename(db, position))
 618     }
 619
 620     pub fn will_rename_file(
 621         &self,
 622         file_id: FileId,
 623         new_name_stem: &str,
 624     ) -> Cancellable<Option<SourceChange>> {
 625         self.with_db(|db| rename::will_rename_file(db, file_id, new_name_stem))
 626     }
 627
 628     pub fn structural_search_replace(
 629         &self,
 630         query: &str,
 631         parse_only: bool,
 632         resolve_context: FilePosition,
 633         selections: Vec<FileRange>,
 634     ) -> Cancellable<Result<SourceChange, SsrError>> {
 635         self.with_db(|db| {
 636             let rule: ide_ssr::SsrRule = query.parse()?;
 637             let mut match_finder =
 638                 ide_ssr::MatchFinder::in_context(db, resolve_context, selections)?;
 639             match_finder.add_rule(rule)?;
 640             let edits = if parse_only { Default::default() } else { match_finder.edits() };
 641             Ok(SourceChange::from(edits))
 642         })
 643     }
 644
 645     pub fn annotations(
 646         &self,
 647         config: &AnnotationConfig,
 648         file_id: FileId,
 649     ) -> Cancellable<Vec<Annotation>> {
 650         self.with_db(|db| annotations::annotations(db, config, file_id))
 651     }
 652
 653     pub fn resolve_annotation(&self, annotation: Annotation) -> Cancellable<Annotation> {
 654         self.with_db(|db| annotations::resolve_annotation(db, annotation))
 655     }
 656
 657     pub fn move_item(
 658         &self,
 659         range: FileRange,
 660         direction: Direction,
 661     ) -> Cancellable<Option<TextEdit>> {
 662         self.with_db(|db| move_item::move_item(db, range, direction))
 663     }
 664
 665     /// Performs an operation on the database that may be canceled.
 666     ///
 667     /// rust-analyzer needs to be able to answer semantic questions about the
 668     /// code while the code is being modified. A common problem is that a
 669     /// long-running query is being calculated when a new change arrives.
 670     ///
 671     /// We can't just apply the change immediately: this will cause the pending
 672     /// query to see inconsistent state (it will observe an absence of
 673     /// repeatable read). So what we do is we **cancel** all pending queries
 674     /// before applying the change.
 675     ///
 676     /// Salsa implements cancelation by unwinding with a special value and
 677     /// catching it on the API boundary.
 678     fn with_db<F, T>(&self, f: F) -> Cancellable<T>
 679     where
 680         F: FnOnce(&RootDatabase) -> T + std::panic::UnwindSafe,
 681     {
 682         Cancelled::catch(|| f(&self.db))
 683     }
 684 }
 685
 686 #[test]
 687 fn analysis_is_send() {
 688     fn is_send<T: Send>() {}
 689     is_send::<Analysis>();
 690 }