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.
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
10 // For proving that RootDatabase is RefUnwindSafe.
11 #![recursion_limit = "128"]
14 macro_rules! eprintln {
15 ($($tt:tt)*) => { stdx::eprintln!($($tt)*) };
33 mod goto_implementation;
34 mod goto_type_definition;
46 mod syntax_highlighting;
56 use ide_db::base_db::{
57 salsa::{self, ParallelDatabase},
58 CheckCanceled, Env, FileLoader, FileSet, SourceDatabase, VfsPath,
61 symbol_index::{self, FileSymbol},
64 use syntax::SourceFile;
66 use crate::display::ToNav;
69 annotations::{Annotation, AnnotationConfig, AnnotationKind},
70 call_hierarchy::CallItem,
71 diagnostics::{Diagnostic, DiagnosticsConfig, Fix, Severity},
72 display::navigation_target::NavigationTarget,
73 expand_macro::ExpandedMacro,
74 file_structure::StructureNode,
75 folding_ranges::{Fold, FoldKind},
76 hover::{HoverAction, HoverConfig, HoverGotoTypeData, HoverResult},
77 inlay_hints::{InlayHint, InlayHintsConfig, InlayKind},
79 prime_caches::PrimeCachesProgress,
80 references::{rename::RenameError, ReferenceSearchResult},
81 runnables::{Runnable, RunnableKind, TestId},
82 syntax_highlighting::{
83 tags::{Highlight, HlMod, HlMods, HlPunct, HlTag},
87 pub use hir::{Documentation, Semantics};
88 pub use ide_assists::{Assist, AssistConfig, AssistId, AssistKind};
89 pub use ide_completion::{
90 CompletionConfig, CompletionItem, CompletionItemKind, CompletionScore, ImportEdit,
95 Canceled, Change, CrateGraph, CrateId, Edition, FileId, FilePosition, FileRange,
96 SourceRoot, SourceRootId,
100 line_index::{LineCol, LineColUtf16, LineIndex},
101 search::{ReferenceAccess, SearchScope},
102 source_change::{FileSystemEdit, SourceChange},
106 pub use ide_ssr::SsrError;
107 pub use syntax::{TextRange, TextSize};
108 pub use text_edit::{Indel, TextEdit};
110 pub type Cancelable<T> = Result<T, Canceled>;
112 /// Info associated with a text range.
114 pub struct RangeInfo<T> {
115 pub range: TextRange,
119 impl<T> RangeInfo<T> {
120 pub fn new(range: TextRange, info: T) -> RangeInfo<T> {
121 RangeInfo { range, info }
125 /// `AnalysisHost` stores the current state of the world.
127 pub struct AnalysisHost {
132 pub fn new(lru_capacity: Option<usize>) -> AnalysisHost {
133 AnalysisHost { db: RootDatabase::new(lru_capacity) }
136 pub fn update_lru_capacity(&mut self, lru_capacity: Option<usize>) {
137 self.db.update_lru_capacity(lru_capacity);
140 /// Returns a snapshot of the current state, which you can query for
141 /// semantic information.
142 pub fn analysis(&self) -> Analysis {
143 Analysis { db: self.db.snapshot() }
146 /// Applies changes to the current state of the world. If there are
147 /// outstanding snapshots, they will be canceled.
148 pub fn apply_change(&mut self, change: Change) {
149 self.db.apply_change(change)
152 pub fn collect_garbage(&mut self) {
153 self.db.collect_garbage();
155 /// NB: this clears the database
156 pub fn per_query_memory_usage(&mut self) -> Vec<(String, profile::Bytes)> {
157 self.db.per_query_memory_usage()
159 pub fn request_cancellation(&mut self) {
160 self.db.request_cancellation();
162 pub fn raw_database(&self) -> &RootDatabase {
165 pub fn raw_database_mut(&mut self) -> &mut RootDatabase {
170 impl Default for AnalysisHost {
171 fn default() -> AnalysisHost {
172 AnalysisHost::new(None)
176 /// Analysis is a snapshot of a world state at a moment in time. It is the main
177 /// entry point for asking semantic information about the world. When the world
178 /// state is advanced using `AnalysisHost::apply_change` method, all existing
179 /// `Analysis` are canceled (most method return `Err(Canceled)`).
181 pub struct Analysis {
182 db: salsa::Snapshot<RootDatabase>,
185 // As a general design guideline, `Analysis` API are intended to be independent
186 // from the language server protocol. That is, when exposing some functionality
187 // we should think in terms of "what API makes most sense" and not in terms of
188 // "what types LSP uses". Although currently LSP is the only consumer of the
189 // API, the API should in theory be usable as a library, or via a different
192 // Creates an analysis instance for a single file, without any extenal
193 // dependencies, stdlib support or ability to apply changes. See
194 // `AnalysisHost` for creating a fully-featured analysis.
195 pub fn from_single_file(text: String) -> (Analysis, FileId) {
196 let mut host = AnalysisHost::default();
197 let file_id = FileId(0);
198 let mut file_set = FileSet::default();
199 file_set.insert(file_id, VfsPath::new_virtual_path("/main.rs".to_string()));
200 let source_root = SourceRoot::new_local(file_set);
202 let mut change = Change::new();
203 change.set_roots(vec![source_root]);
204 let mut crate_graph = CrateGraph::default();
205 // FIXME: cfg options
206 // Default to enable test for single file.
207 let mut cfg_options = CfgOptions::default();
208 cfg_options.insert_atom("test".into());
209 crate_graph.add_crate_root(
211 Edition::Edition2018,
217 change.change_file(file_id, Some(Arc::new(text)));
218 change.set_crate_graph(crate_graph);
219 host.apply_change(change);
220 (host.analysis(), file_id)
223 /// Debug info about the current state of the analysis.
224 pub fn status(&self, file_id: Option<FileId>) -> Cancelable<String> {
225 self.with_db(|db| status::status(&*db, file_id))
228 pub fn prime_caches<F>(&self, cb: F) -> Cancelable<()>
230 F: Fn(PrimeCachesProgress) + Sync + std::panic::UnwindSafe,
232 self.with_db(move |db| prime_caches::prime_caches(db, &cb))
235 /// Gets the text of the source file.
236 pub fn file_text(&self, file_id: FileId) -> Cancelable<Arc<String>> {
237 self.with_db(|db| db.file_text(file_id))
240 /// Gets the syntax tree of the file.
241 pub fn parse(&self, file_id: FileId) -> Cancelable<SourceFile> {
242 self.with_db(|db| db.parse(file_id).tree())
245 /// Gets the file's `LineIndex`: data structure to convert between absolute
246 /// offsets and line/column representation.
247 pub fn file_line_index(&self, file_id: FileId) -> Cancelable<Arc<LineIndex>> {
248 self.with_db(|db| db.line_index(file_id))
251 /// Selects the next syntactic nodes encompassing the range.
252 pub fn extend_selection(&self, frange: FileRange) -> Cancelable<TextRange> {
253 self.with_db(|db| extend_selection::extend_selection(db, frange))
256 /// Returns position of the matching brace (all types of braces are
258 pub fn matching_brace(&self, position: FilePosition) -> Cancelable<Option<TextSize>> {
260 let parse = db.parse(position.file_id);
261 let file = parse.tree();
262 matching_brace::matching_brace(&file, position.offset)
266 /// Returns a syntax tree represented as `String`, for debug purposes.
267 // FIXME: use a better name here.
271 text_range: Option<TextRange>,
272 ) -> Cancelable<String> {
273 self.with_db(|db| syntax_tree::syntax_tree(&db, file_id, text_range))
276 pub fn view_hir(&self, position: FilePosition) -> Cancelable<String> {
277 self.with_db(|db| view_hir::view_hir(&db, position))
280 pub fn expand_macro(&self, position: FilePosition) -> Cancelable<Option<ExpandedMacro>> {
281 self.with_db(|db| expand_macro::expand_macro(db, position))
284 /// Returns an edit to remove all newlines in the range, cleaning up minor
285 /// stuff like trailing commas.
286 pub fn join_lines(&self, frange: FileRange) -> Cancelable<TextEdit> {
288 let parse = db.parse(frange.file_id);
289 join_lines::join_lines(&parse.tree(), frange.range)
293 /// Returns an edit which should be applied when opening a new line, fixing
294 /// up minor stuff like continuing the comment.
295 /// The edit will be a snippet (with `$0`).
296 pub fn on_enter(&self, position: FilePosition) -> Cancelable<Option<TextEdit>> {
297 self.with_db(|db| typing::on_enter(&db, position))
300 /// Returns an edit which should be applied after a character was typed.
302 /// This is useful for some on-the-fly fixups, like adding `;` to `let =`
304 pub fn on_char_typed(
306 position: FilePosition,
308 ) -> Cancelable<Option<SourceChange>> {
309 // Fast path to not even parse the file.
310 if !typing::TRIGGER_CHARS.contains(char_typed) {
313 self.with_db(|db| typing::on_char_typed(&db, position, char_typed))
316 /// Returns a tree representation of symbols in the file. Useful to draw a
318 pub fn file_structure(&self, file_id: FileId) -> Cancelable<Vec<StructureNode>> {
319 self.with_db(|db| file_structure::file_structure(&db.parse(file_id).tree()))
322 /// Returns a list of the places in the file where type hints can be displayed.
326 config: &InlayHintsConfig,
327 ) -> Cancelable<Vec<InlayHint>> {
328 self.with_db(|db| inlay_hints::inlay_hints(db, file_id, config))
331 /// Returns the set of folding ranges.
332 pub fn folding_ranges(&self, file_id: FileId) -> Cancelable<Vec<Fold>> {
333 self.with_db(|db| folding_ranges::folding_ranges(&db.parse(file_id).tree()))
336 /// Fuzzy searches for a symbol.
337 pub fn symbol_search(&self, query: Query) -> Cancelable<Vec<NavigationTarget>> {
339 symbol_index::world_symbols(db, query)
341 .map(|s| s.to_nav(db))
346 /// Returns the definitions from the symbol at `position`.
347 pub fn goto_definition(
349 position: FilePosition,
350 ) -> Cancelable<Option<RangeInfo<Vec<NavigationTarget>>>> {
351 self.with_db(|db| goto_definition::goto_definition(db, position))
354 /// Returns the impls from the symbol at `position`.
355 pub fn goto_implementation(
357 position: FilePosition,
358 ) -> Cancelable<Option<RangeInfo<Vec<NavigationTarget>>>> {
359 self.with_db(|db| goto_implementation::goto_implementation(db, position))
362 /// Returns the type definitions for the symbol at `position`.
363 pub fn goto_type_definition(
365 position: FilePosition,
366 ) -> Cancelable<Option<RangeInfo<Vec<NavigationTarget>>>> {
367 self.with_db(|db| goto_type_definition::goto_type_definition(db, position))
370 /// Finds all usages of the reference at point.
371 pub fn find_all_refs(
373 position: FilePosition,
374 search_scope: Option<SearchScope>,
375 ) -> Cancelable<Option<ReferenceSearchResult>> {
376 self.with_db(|db| references::find_all_refs(&Semantics::new(db), position, search_scope))
379 /// Finds all methods and free functions for the file. Does not return tests!
380 pub fn find_all_methods(&self, file_id: FileId) -> Cancelable<Vec<FileRange>> {
381 self.with_db(|db| fn_references::find_all_methods(db, file_id))
384 /// Returns a short text describing element at position.
387 position: FilePosition,
388 links_in_hover: bool,
390 ) -> Cancelable<Option<RangeInfo<HoverResult>>> {
391 self.with_db(|db| hover::hover(db, position, links_in_hover, markdown))
394 /// Return URL(s) for the documentation of the symbol under the cursor.
395 pub fn external_docs(
397 position: FilePosition,
398 ) -> Cancelable<Option<doc_links::DocumentationLink>> {
399 self.with_db(|db| doc_links::external_docs(db, &position))
402 /// Computes parameter information for the given call expression.
403 pub fn call_info(&self, position: FilePosition) -> Cancelable<Option<CallInfo>> {
404 self.with_db(|db| ide_db::call_info::call_info(db, position))
407 /// Computes call hierarchy candidates for the given file position.
408 pub fn call_hierarchy(
410 position: FilePosition,
411 ) -> Cancelable<Option<RangeInfo<Vec<NavigationTarget>>>> {
412 self.with_db(|db| call_hierarchy::call_hierarchy(db, position))
415 /// Computes incoming calls for the given file position.
416 pub fn incoming_calls(&self, position: FilePosition) -> Cancelable<Option<Vec<CallItem>>> {
417 self.with_db(|db| call_hierarchy::incoming_calls(db, position))
420 /// Computes incoming calls for the given file position.
421 pub fn outgoing_calls(&self, position: FilePosition) -> Cancelable<Option<Vec<CallItem>>> {
422 self.with_db(|db| call_hierarchy::outgoing_calls(db, position))
425 /// Returns a `mod name;` declaration which created the current module.
426 pub fn parent_module(&self, position: FilePosition) -> Cancelable<Vec<NavigationTarget>> {
427 self.with_db(|db| parent_module::parent_module(db, position))
430 /// Returns crates this file belongs too.
431 pub fn crate_for(&self, file_id: FileId) -> Cancelable<Vec<CrateId>> {
432 self.with_db(|db| parent_module::crate_for(db, file_id))
435 /// Returns the edition of the given crate.
436 pub fn crate_edition(&self, crate_id: CrateId) -> Cancelable<Edition> {
437 self.with_db(|db| db.crate_graph()[crate_id].edition)
440 /// Returns the root file of the given crate.
441 pub fn crate_root(&self, crate_id: CrateId) -> Cancelable<FileId> {
442 self.with_db(|db| db.crate_graph()[crate_id].root_file_id)
445 /// Returns the set of possible targets to run for the current file.
446 pub fn runnables(&self, file_id: FileId) -> Cancelable<Vec<Runnable>> {
447 self.with_db(|db| runnables::runnables(db, file_id))
450 /// Computes syntax highlighting for the given file
451 pub fn highlight(&self, file_id: FileId) -> Cancelable<Vec<HlRange>> {
452 self.with_db(|db| syntax_highlighting::highlight(db, file_id, None, false))
455 /// Computes syntax highlighting for the given file range.
456 pub fn highlight_range(&self, frange: FileRange) -> Cancelable<Vec<HlRange>> {
458 syntax_highlighting::highlight(db, frange.file_id, Some(frange.range), false)
462 /// Computes syntax highlighting for the given file.
463 pub fn highlight_as_html(&self, file_id: FileId, rainbow: bool) -> Cancelable<String> {
464 self.with_db(|db| syntax_highlighting::highlight_as_html(db, file_id, rainbow))
467 /// Computes completions at the given position.
470 config: &CompletionConfig,
471 position: FilePosition,
472 ) -> Cancelable<Option<Vec<CompletionItem>>> {
473 self.with_db(|db| ide_completion::completions(db, config, position).map(Into::into))
476 /// Resolves additional completion data at the position given.
477 pub fn resolve_completion_edits(
479 config: &CompletionConfig,
480 position: FilePosition,
481 full_import_path: &str,
482 imported_name: String,
483 ) -> Cancelable<Vec<TextEdit>> {
486 ide_completion::resolve_completion_edits(
494 .unwrap_or_default())
497 /// Computes assists (aka code actions aka intentions) for the given
498 /// position. If `resolve == false`, computes enough info to show the
499 /// lightbulb list in the editor, but doesn't compute actual edits, to
500 /// improve performance.
503 config: &AssistConfig,
506 ) -> Cancelable<Vec<Assist>> {
508 let mut acc = Assist::get(db, config, resolve, frange);
509 ssr::add_ssr_assist(db, &mut acc, resolve, frange);
514 /// Computes the set of diagnostics for the given file.
517 config: &DiagnosticsConfig,
519 ) -> Cancelable<Vec<Diagnostic>> {
520 self.with_db(|db| diagnostics::diagnostics(db, config, file_id))
523 /// Returns the edit required to rename reference at the position to the new
527 position: FilePosition,
529 ) -> Cancelable<Result<SourceChange, RenameError>> {
530 self.with_db(|db| references::rename::rename(db, position, new_name))
533 pub fn prepare_rename(
535 position: FilePosition,
536 ) -> Cancelable<Result<RangeInfo<()>, RenameError>> {
537 self.with_db(|db| references::rename::prepare_rename(db, position))
540 pub fn will_rename_file(
544 ) -> Cancelable<Option<SourceChange>> {
545 self.with_db(|db| references::rename::will_rename_file(db, file_id, new_name_stem))
548 pub fn structural_search_replace(
552 resolve_context: FilePosition,
553 selections: Vec<FileRange>,
554 ) -> Cancelable<Result<SourceChange, SsrError>> {
556 let rule: ide_ssr::SsrRule = query.parse()?;
557 let mut match_finder =
558 ide_ssr::MatchFinder::in_context(db, resolve_context, selections);
559 match_finder.add_rule(rule)?;
560 let edits = if parse_only { Default::default() } else { match_finder.edits() };
561 Ok(SourceChange::from(edits))
568 config: AnnotationConfig,
569 ) -> Cancelable<Vec<Annotation>> {
570 self.with_db(|db| annotations::annotations(db, file_id, config))
573 pub fn resolve_annotation(&self, annotation: Annotation) -> Cancelable<Annotation> {
574 self.with_db(|db| annotations::resolve_annotation(db, annotation))
577 /// Performs an operation on that may be Canceled.
578 fn with_db<F, T>(&self, f: F) -> Cancelable<T>
580 F: FnOnce(&RootDatabase) -> T + std::panic::UnwindSafe,
582 self.db.catch_canceled(f)
587 fn analysis_is_send() {
588 fn is_send<T: Send>() {}
589 is_send::<Analysis>();