//! ra_analyzer crate provides "ide-centric" APIs for the rust-analyzer. What //! powers this API are the `RootDatabase` struct, which defines a `salsa` //! database, and the `ra_hir` crate, where majority of the analysis happens. //! However, IDE specific bits of the analysis (most notably completion) happen //! in this crate. macro_rules! ctry { ($expr:expr) => { match $expr { None => return Ok(None), Some(it) => it, } }; } mod completion; mod db; mod goto_defenition; mod imp; pub mod mock_analysis; mod runnables; mod symbol_index; mod extend_selection; mod hover; mod call_info; mod syntax_highlighting; use std::{fmt, sync::Arc}; use ra_syntax::{SmolStr, SourceFile, TreePtr, SyntaxKind, TextRange, TextUnit}; use ra_text_edit::TextEdit; use ra_db::{SyntaxDatabase, FilesDatabase, LocalSyntaxPtr}; use rayon::prelude::*; use relative_path::RelativePathBuf; use rustc_hash::FxHashMap; use salsa::ParallelDatabase; use crate::{ symbol_index::{FileSymbol, SymbolIndex}, db::LineIndexDatabase, }; pub use crate::{ completion::{CompletionItem, CompletionItemKind, InsertText}, runnables::{Runnable, RunnableKind}, }; pub use ra_editor::{ Fold, FoldKind, HighlightedRange, Severity, StructureNode, LineIndex, LineCol, translate_offset_with_edit, }; pub use ra_db::{ Cancelable, Canceled, CrateGraph, CrateId, FileId, FilePosition, FileRange, SourceRootId }; #[derive(Default)] pub struct AnalysisChange { new_roots: Vec<(SourceRootId, bool)>, roots_changed: FxHashMap, files_changed: Vec<(FileId, Arc)>, libraries_added: Vec, crate_graph: Option, } #[derive(Default)] struct RootChange { added: Vec, removed: Vec, } #[derive(Debug)] struct AddFile { file_id: FileId, path: RelativePathBuf, text: Arc, } #[derive(Debug)] struct RemoveFile { file_id: FileId, path: RelativePathBuf, } impl fmt::Debug for AnalysisChange { fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result { let mut d = fmt.debug_struct("AnalysisChange"); if !self.new_roots.is_empty() { d.field("new_roots", &self.new_roots); } if !self.roots_changed.is_empty() { d.field("roots_changed", &self.roots_changed); } if !self.files_changed.is_empty() { d.field("files_changed", &self.files_changed.len()); } if !self.libraries_added.is_empty() { d.field("libraries_added", &self.libraries_added.len()); } if !self.crate_graph.is_some() { d.field("crate_graph", &self.crate_graph); } d.finish() } } impl fmt::Debug for RootChange { fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result { fmt.debug_struct("AnalysisChange") .field("added", &self.added.len()) .field("removed", &self.removed.len()) .finish() } } impl AnalysisChange { pub fn new() -> AnalysisChange { AnalysisChange::default() } pub fn add_root(&mut self, root_id: SourceRootId, is_local: bool) { self.new_roots.push((root_id, is_local)); } pub fn add_file( &mut self, root_id: SourceRootId, file_id: FileId, path: RelativePathBuf, text: Arc, ) { let file = AddFile { file_id, path, text, }; self.roots_changed .entry(root_id) .or_default() .added .push(file); } pub fn change_file(&mut self, file_id: FileId, new_text: Arc) { self.files_changed.push((file_id, new_text)) } pub fn remove_file(&mut self, root_id: SourceRootId, file_id: FileId, path: RelativePathBuf) { let file = RemoveFile { file_id, path }; self.roots_changed .entry(root_id) .or_default() .removed .push(file); } pub fn add_library(&mut self, data: LibraryData) { self.libraries_added.push(data) } pub fn set_crate_graph(&mut self, graph: CrateGraph) { self.crate_graph = Some(graph); } } #[derive(Debug)] pub struct SourceChange { pub label: String, pub source_file_edits: Vec, pub file_system_edits: Vec, pub cursor_position: Option, } #[derive(Debug)] pub struct SourceFileEdit { pub file_id: FileId, pub edit: TextEdit, } #[derive(Debug)] pub enum FileSystemEdit { CreateFile { source_root: SourceRootId, path: RelativePathBuf, }, MoveFile { src: FileId, dst_source_root: SourceRootId, dst_path: RelativePathBuf, }, } #[derive(Debug)] pub struct Diagnostic { pub message: String, pub range: TextRange, pub fix: Option, pub severity: Severity, } #[derive(Debug)] pub struct Query { query: String, lowercased: String, only_types: bool, libs: bool, exact: bool, limit: usize, } impl Query { pub fn new(query: String) -> Query { let lowercased = query.to_lowercase(); Query { query, lowercased, only_types: false, libs: false, exact: false, limit: usize::max_value(), } } pub fn only_types(&mut self) { self.only_types = true; } pub fn libs(&mut self) { self.libs = true; } pub fn exact(&mut self) { self.exact = true; } pub fn limit(&mut self, limit: usize) { self.limit = limit } } /// `NavigationTarget` represents and element in the editor's UI whihc you can /// click on to navigate to a particular piece of code. /// /// Typically, a `NavigationTarget` corresponds to some element in the source /// code, like a function or a struct, but this is not strictly required. #[derive(Debug, Clone)] pub struct NavigationTarget { file_id: FileId, name: SmolStr, kind: SyntaxKind, range: TextRange, // Should be DefId ideally ptr: Option, } impl NavigationTarget { fn from_symbol(symbol: FileSymbol) -> NavigationTarget { NavigationTarget { file_id: symbol.file_id, name: symbol.name.clone(), kind: symbol.ptr.kind(), range: symbol.ptr.range(), ptr: Some(symbol.ptr.clone()), } } pub fn name(&self) -> &SmolStr { &self.name } pub fn kind(&self) -> SyntaxKind { self.kind } pub fn file_id(&self) -> FileId { self.file_id } pub fn range(&self) -> TextRange { self.range } } #[derive(Debug)] pub struct RangeInfo { pub range: TextRange, pub info: T, } impl RangeInfo { fn new(range: TextRange, info: T) -> RangeInfo { RangeInfo { range, info } } } #[derive(Debug)] pub struct CallInfo { pub label: String, pub doc: Option, pub parameters: Vec, pub active_parameter: Option, } /// `AnalysisHost` stores the current state of the world. #[derive(Debug, Default)] pub struct AnalysisHost { db: db::RootDatabase, } impl AnalysisHost { /// Returns a snapshot of the current state, which you can query for /// semantic information. pub fn analysis(&self) -> Analysis { Analysis { db: self.db.snapshot(), } } /// Applies changes to the current state of the world. If there are /// outstanding snapshots, they will be canceled. pub fn apply_change(&mut self, change: AnalysisChange) { self.db.apply_change(change) } } /// Analysis is a snapshot of a world state at a moment in time. It is the main /// entry point for asking semantic information about the world. When the world /// state is advanced using `AnalysisHost::apply_change` method, all existing /// `Analysis` are canceled (most method return `Err(Canceled)`). #[derive(Debug)] pub struct Analysis { db: salsa::Snapshot, } impl Analysis { /// Gets the text of the source file. pub fn file_text(&self, file_id: FileId) -> Arc { self.db.file_text(file_id) } /// Gets the syntax tree of the file. pub fn file_syntax(&self, file_id: FileId) -> TreePtr { self.db.source_file(file_id).clone() } /// Gets the file's `LineIndex`: data structure to convert between absolute /// offsets and line/column representation. pub fn file_line_index(&self, file_id: FileId) -> Arc { self.db.line_index(file_id) } /// Selects the next syntactic nodes encopasing the range. pub fn extend_selection(&self, frange: FileRange) -> TextRange { extend_selection::extend_selection(&self.db, frange) } /// Returns position of the mathcing brace (all types of braces are /// supported). pub fn matching_brace(&self, file: &SourceFile, offset: TextUnit) -> Option { ra_editor::matching_brace(file, offset) } /// Returns a syntax tree represented as `String`, for debug purposes. // FIXME: use a better name here. pub fn syntax_tree(&self, file_id: FileId) -> String { let file = self.db.source_file(file_id); ra_editor::syntax_tree(&file) } /// Returns an edit to remove all newlines in the range, cleaning up minor /// stuff like trailing commas. pub fn join_lines(&self, frange: FileRange) -> SourceChange { let file = self.db.source_file(frange.file_id); SourceChange::from_local_edit(frange.file_id, ra_editor::join_lines(&file, frange.range)) } /// Returns an edit which should be applied when opening a new line, fixing /// up minor stuff like continuing the comment. pub fn on_enter(&self, position: FilePosition) -> Option { let file = self.db.source_file(position.file_id); let edit = ra_editor::on_enter(&file, position.offset)?; Some(SourceChange::from_local_edit(position.file_id, edit)) } /// Returns an edit which should be applied after `=` was typed. Primarily, /// this works when adding `let =`. // FIXME: use a snippet completion instead of this hack here. pub fn on_eq_typed(&self, position: FilePosition) -> Option { let file = self.db.source_file(position.file_id); let edit = ra_editor::on_eq_typed(&file, position.offset)?; Some(SourceChange::from_local_edit(position.file_id, edit)) } /// Returns an edit which should be applied when a dot ('.') is typed on a blank line, indenting the line appropriately. pub fn on_dot_typed(&self, position: FilePosition) -> Option { let file = self.db.source_file(position.file_id); let edit = ra_editor::on_dot_typed(&file, position.offset)?; Some(SourceChange::from_local_edit(position.file_id, edit)) } /// Returns a tree representation of symbols in the file. Useful to draw a /// file outline. pub fn file_structure(&self, file_id: FileId) -> Vec { let file = self.db.source_file(file_id); ra_editor::file_structure(&file) } /// Returns the set of folding ranges. pub fn folding_ranges(&self, file_id: FileId) -> Vec { let file = self.db.source_file(file_id); ra_editor::folding_ranges(&file) } /// Fuzzy searches for a symbol. pub fn symbol_search(&self, query: Query) -> Cancelable> { let res = symbol_index::world_symbols(&*self.db, query)? .into_iter() .map(NavigationTarget::from_symbol) .collect(); Ok(res) } pub fn goto_defenition( &self, position: FilePosition, ) -> Cancelable>> { goto_defenition::goto_defenition(&*self.db, position) } /// Finds all usages of the reference at point. pub fn find_all_refs(&self, position: FilePosition) -> Cancelable> { self.db.find_all_refs(position) } /// Returns a short text descrbing element at position. pub fn hover(&self, position: FilePosition) -> Cancelable>> { hover::hover(&*self.db, position) } /// Computes parameter information for the given call expression. pub fn call_info(&self, position: FilePosition) -> Cancelable> { call_info::call_info(&*self.db, position) } /// Returns a `mod name;` declaration which created the current module. pub fn parent_module(&self, position: FilePosition) -> Cancelable> { self.db.parent_module(position) } /// Returns crates this file belongs too. pub fn crate_for(&self, file_id: FileId) -> Cancelable> { self.db.crate_for(file_id) } /// Returns the root file of the given crate. pub fn crate_root(&self, crate_id: CrateId) -> Cancelable { Ok(self.db.crate_graph().crate_root(crate_id)) } /// Returns the set of possible targets to run for the current file. pub fn runnables(&self, file_id: FileId) -> Cancelable> { runnables::runnables(&*self.db, file_id) } /// Computes syntax highlighting for the given file. pub fn highlight(&self, file_id: FileId) -> Cancelable> { syntax_highlighting::highlight(&*self.db, file_id) } /// Computes completions at the given position. pub fn completions(&self, position: FilePosition) -> Cancelable>> { let completions = completion::completions(&self.db, position)?; Ok(completions.map(|it| it.into())) } /// Computes assists (aks code actons aka intentions) for the given /// position. pub fn assists(&self, frange: FileRange) -> Cancelable> { Ok(self.db.assists(frange)) } /// Computes the set of diagnostics for the given file. pub fn diagnostics(&self, file_id: FileId) -> Cancelable> { self.db.diagnostics(file_id) } /// Computes the type of the expression at the given position. pub fn type_of(&self, frange: FileRange) -> Cancelable> { hover::type_of(&*self.db, frange) } /// Returns the edit required to rename reference at the position to the new /// name. pub fn rename( &self, position: FilePosition, new_name: &str, ) -> Cancelable> { self.db.rename(position, new_name) } } pub struct LibraryData { root_id: SourceRootId, root_change: RootChange, symbol_index: SymbolIndex, } impl fmt::Debug for LibraryData { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { f.debug_struct("LibraryData") .field("root_id", &self.root_id) .field("root_change", &self.root_change) .field("n_symbols", &self.symbol_index.len()) .finish() } } impl LibraryData { pub fn prepare( root_id: SourceRootId, files: Vec<(FileId, RelativePathBuf, Arc)>, ) -> LibraryData { let symbol_index = SymbolIndex::for_files(files.par_iter().map(|(file_id, _, text)| { let file = SourceFile::parse(text); (*file_id, file) })); let mut root_change = RootChange::default(); root_change.added = files .into_iter() .map(|(file_id, path, text)| AddFile { file_id, path, text, }) .collect(); LibraryData { root_id, root_change, symbol_index, } } } #[test] fn analysis_is_send() { fn is_send() {} is_send::(); }