use std::{ hash::{Hash, Hasher}, sync::Arc, }; use ra_editor::{self, find_node_at_offset, resolve_local_name, FileSymbol, LineIndex, LocalEdit, CompletionItem}; use ra_syntax::{ ast::{self, ArgListOwner, Expr, NameOwner}, AstNode, File, SmolStr, SyntaxKind::*, SyntaxNodeRef, TextRange, TextUnit, }; use rayon::prelude::*; use relative_path::RelativePath; use rustc_hash::FxHashSet; use salsa::{ParallelDatabase, Database}; use crate::{ AnalysisChange, db::{ self, SyntaxDatabase, FileSyntaxQuery, }, input::{SourceRootId, FilesDatabase, SourceRoot, WORKSPACE}, descriptors::module::{ModulesDatabase, ModuleTree, Problem}, descriptors::{FnDescriptor}, symbol_index::SymbolIndex, CrateGraph, CrateId, Diagnostic, FileId, FileResolver, FileSystemEdit, Position, Query, SourceChange, SourceFileEdit, Cancelable, }; #[derive(Clone, Debug)] pub(crate) struct FileResolverImp { inner: Arc, } impl PartialEq for FileResolverImp { fn eq(&self, other: &FileResolverImp) -> bool { self.inner() == other.inner() } } impl Eq for FileResolverImp {} impl Hash for FileResolverImp { fn hash(&self, hasher: &mut H) { self.inner().hash(hasher); } } impl FileResolverImp { pub(crate) fn new(inner: Arc) -> FileResolverImp { FileResolverImp { inner } } pub(crate) fn file_stem(&self, file_id: FileId) -> String { self.inner.file_stem(file_id) } pub(crate) fn resolve(&self, file_id: FileId, path: &RelativePath) -> Option { self.inner.resolve(file_id, path) } fn inner(&self) -> *const FileResolver { &*self.inner } } impl Default for FileResolverImp { fn default() -> FileResolverImp { #[derive(Debug)] struct DummyResolver; impl FileResolver for DummyResolver { fn file_stem(&self, _file_: FileId) -> String { panic!("file resolver not set") } fn resolve( &self, _file_id: FileId, _path: &::relative_path::RelativePath, ) -> Option { panic!("file resolver not set") } } FileResolverImp { inner: Arc::new(DummyResolver), } } } #[derive(Debug, Default)] pub(crate) struct AnalysisHostImpl { db: db::RootDatabase, } impl AnalysisHostImpl { pub fn new() -> AnalysisHostImpl { AnalysisHostImpl::default() } pub fn analysis(&self) -> AnalysisImpl { AnalysisImpl { db: self.db.fork() // freeze revision here } } pub fn apply_change(&mut self, change: AnalysisChange) { log::info!("apply_change {:?}", change); for (file_id, text) in change.files_changed { self.db .query(crate::input::FileTextQuery) .set(file_id, Arc::new(text)) } if !(change.files_added.is_empty() && change.files_removed.is_empty()) { let file_resolver = change.file_resolver .expect("change resolver when changing set of files"); let mut source_root = SourceRoot::clone(&self.db.source_root(WORKSPACE)); for (file_id, text) in change.files_added { self.db .query(crate::input::FileTextQuery) .set(file_id, Arc::new(text)); self.db .query(crate::input::FileSourceRootQuery) .set(file_id, crate::input::WORKSPACE); source_root.files.insert(file_id); } for file_id in change.files_removed { self.db .query(crate::input::FileTextQuery) .set(file_id, Arc::new(String::new())); source_root.files.remove(&file_id); } source_root.file_resolver = file_resolver; self.db .query(crate::input::SourceRootQuery) .set(WORKSPACE, Arc::new(source_root)) } if !change.libraries_added.is_empty() { let mut libraries = Vec::clone(&self.db.libraries()); for library in change.libraries_added { let source_root_id = SourceRootId(1 + libraries.len() as u32); libraries.push(source_root_id); let mut files = FxHashSet::default(); for (file_id, text) in library.files { files.insert(file_id); self.db .query(crate::input::FileSourceRootQuery) .set_constant(file_id, source_root_id); self.db .query(crate::input::FileTextQuery) .set_constant(file_id, Arc::new(text)); } let source_root = SourceRoot { files, file_resolver: library.file_resolver, }; self.db .query(crate::input::SourceRootQuery) .set(source_root_id, Arc::new(source_root)); self.db .query(crate::input::LibrarySymbolsQuery) .set(source_root_id, Arc::new(library.symbol_index)); } self.db .query(crate::input::LibrarieseQuery) .set((), Arc::new(libraries)); } if let Some(crate_graph) = change.crate_graph { self.db.query(crate::input::CrateGraphQuery) .set((), Arc::new(crate_graph)) } } } #[derive(Debug)] pub(crate) struct AnalysisImpl { db: db::RootDatabase, } impl AnalysisImpl { pub fn file_syntax(&self, file_id: FileId) -> File { self.db.file_syntax(file_id) } pub fn file_line_index(&self, file_id: FileId) -> Arc { self.db.file_lines(file_id) } pub fn world_symbols(&self, query: Query) -> Cancelable> { let buf: Vec> = if query.libs { self.db.libraries().iter() .map(|&lib_id| self.db.library_symbols(lib_id)) .collect() } else { let files = &self.db.source_root(WORKSPACE).files; let db = self.db.clone(); files.par_iter() .map_with(db, |db, &file_id| db.file_symbols(file_id)) .filter_map(|it| it.ok()) .collect() }; self.db.query(FileSyntaxQuery) .sweep(salsa::SweepStrategy::default().discard_values()); Ok(query.search(&buf)) } fn module_tree(&self, file_id: FileId) -> Cancelable> { let source_root = self.db.file_source_root(file_id); self.db.module_tree(source_root) } pub fn parent_module(&self, file_id: FileId) -> Cancelable> { let module_tree = self.module_tree(file_id)?; let res = module_tree.modules_for_file(file_id) .into_iter() .filter_map(|module_id| { let link = module_id.parent_link(&module_tree)?; let file_id = link.owner(&module_tree).file_id(&module_tree); let syntax = self.db.file_syntax(file_id); let decl = link.bind_source(&module_tree, syntax.ast()); let sym = FileSymbol { name: decl.name().unwrap().text(), node_range: decl.syntax().range(), kind: MODULE, }; Some((file_id, sym)) }) .collect(); Ok(res) } pub fn crate_for(&self, file_id: FileId) -> Cancelable> { let module_tree = self.module_tree(file_id)?; let crate_graph = self.db.crate_graph(); let res = module_tree.modules_for_file(file_id) .into_iter() .map(|it| it.root(&module_tree)) .map(|it| it.file_id(&module_tree)) .filter_map(|it| crate_graph.crate_id_for_crate_root(it)) .collect(); Ok(res) } pub fn crate_root(&self, crate_id: CrateId) -> FileId { self.db.crate_graph().crate_roots[&crate_id] } pub fn completions(&self, file_id: FileId, offset: TextUnit) -> Cancelable>> { let mut res = Vec::new(); let mut has_completions = false; let file = self.file_syntax(file_id); if let Some(scope_based) = ra_editor::scope_completion(&file, offset) { res.extend(scope_based); has_completions = true; } if let Some(scope_based) = crate::completion::resolve_based_completion(&self.db, file_id, offset)? { res.extend(scope_based); has_completions = true; } let res = if has_completions { Some(res) } else { None }; Ok(res) } pub fn approximately_resolve_symbol( &self, file_id: FileId, offset: TextUnit, ) -> Cancelable> { let module_tree = self.module_tree(file_id)?; let file = self.db.file_syntax(file_id); let syntax = file.syntax(); if let Some(name_ref) = find_node_at_offset::(syntax, offset) { // First try to resolve the symbol locally return if let Some((name, range)) = resolve_local_name(name_ref) { let mut vec = vec![]; vec.push(( file_id, FileSymbol { name, node_range: range, kind: NAME, }, )); Ok(vec) } else { // If that fails try the index based approach. self.index_resolve(name_ref) }; } if let Some(name) = find_node_at_offset::(syntax, offset) { if let Some(module) = name.syntax().parent().and_then(ast::Module::cast) { if module.has_semi() { let file_ids = self.resolve_module(&*module_tree, file_id, module); let res = file_ids .into_iter() .map(|id| { let name = module .name() .map(|n| n.text()) .unwrap_or_else(|| SmolStr::new("")); let symbol = FileSymbol { name, node_range: TextRange::offset_len(0.into(), 0.into()), kind: MODULE, }; (id, symbol) }) .collect(); return Ok(res); } } } Ok(vec![]) } pub fn find_all_refs(&self, file_id: FileId, offset: TextUnit) -> Vec<(FileId, TextRange)> { let file = self.db.file_syntax(file_id); let syntax = file.syntax(); let mut ret = vec![]; // Find the symbol we are looking for if let Some(name_ref) = find_node_at_offset::(syntax, offset) { // We are only handing local references for now if let Some(resolved) = resolve_local_name(name_ref) { ret.push((file_id, resolved.1)); if let Some(fn_def) = find_node_at_offset::(syntax, offset) { let refs : Vec<_> = fn_def.syntax().descendants() .filter_map(ast::NameRef::cast) .filter(|&n: &ast::NameRef| resolve_local_name(n) == Some(resolved.clone())) .collect(); for r in refs { ret.push((file_id, r.syntax().range())); } } } } ret } pub fn diagnostics(&self, file_id: FileId) -> Cancelable> { let module_tree = self.module_tree(file_id)?; let syntax = self.db.file_syntax(file_id); let mut res = ra_editor::diagnostics(&syntax) .into_iter() .map(|d| Diagnostic { range: d.range, message: d.msg, fix: None, }) .collect::>(); if let Some(m) = module_tree.any_module_for_file(file_id) { for (name_node, problem) in m.problems(&module_tree, syntax.ast()) { let diag = match problem { Problem::UnresolvedModule { candidate } => { let create_file = FileSystemEdit::CreateFile { anchor: file_id, path: candidate.clone(), }; let fix = SourceChange { label: "create module".to_string(), source_file_edits: Vec::new(), file_system_edits: vec![create_file], cursor_position: None, }; Diagnostic { range: name_node.range(), message: "unresolved module".to_string(), fix: Some(fix), } } Problem::NotDirOwner { move_to, candidate } => { let move_file = FileSystemEdit::MoveFile { file: file_id, path: move_to.clone(), }; let create_file = FileSystemEdit::CreateFile { anchor: file_id, path: move_to.join(candidate), }; let fix = SourceChange { label: "move file and create module".to_string(), source_file_edits: Vec::new(), file_system_edits: vec![move_file, create_file], cursor_position: None, }; Diagnostic { range: name_node.range(), message: "can't declare module at this location".to_string(), fix: Some(fix), } } }; res.push(diag) } }; Ok(res) } pub fn assists(&self, file_id: FileId, range: TextRange) -> Vec { let file = self.file_syntax(file_id); let offset = range.start(); let actions = vec![ ( "flip comma", ra_editor::flip_comma(&file, offset).map(|f| f()), ), ( "add `#[derive]`", ra_editor::add_derive(&file, offset).map(|f| f()), ), ("add impl", ra_editor::add_impl(&file, offset).map(|f| f())), ( "introduce variable", ra_editor::introduce_variable(&file, range).map(|f| f()), ), ]; actions .into_iter() .filter_map(|(name, local_edit)| { Some(SourceChange::from_local_edit(file_id, name, local_edit?)) }) .collect() } pub fn resolve_callable( &self, file_id: FileId, offset: TextUnit, ) -> Cancelable)>> { let file = self.db.file_syntax(file_id); let syntax = file.syntax(); // Find the calling expression and it's NameRef let calling_node = match FnCallNode::with_node(syntax, offset) { Some(node) => node, None => return Ok(None), }; let name_ref = match calling_node.name_ref() { Some(name) => name, None => return Ok(None), }; // Resolve the function's NameRef (NOTE: this isn't entirely accurate). let file_symbols = self.index_resolve(name_ref)?; for (fn_fiel_id, fs) in file_symbols { if fs.kind == FN_DEF { let fn_file = self.db.file_syntax(fn_fiel_id); if let Some(fn_def) = find_node_at_offset(fn_file.syntax(), fs.node_range.start()) { if let Some(descriptor) = FnDescriptor::new(fn_def) { // If we have a calling expression let's find which argument we are on let mut current_parameter = None; let num_params = descriptor.params.len(); let has_self = fn_def.param_list().and_then(|l| l.self_param()).is_some(); if num_params == 1 { if !has_self { current_parameter = Some(0); } } else if num_params > 1 { // Count how many parameters into the call we are. // TODO: This is best effort for now and should be fixed at some point. // It may be better to see where we are in the arg_list and then check // where offset is in that list (or beyond). // Revisit this after we get documentation comments in. if let Some(ref arg_list) = calling_node.arg_list() { let start = arg_list.syntax().range().start(); let range_search = TextRange::from_to(start, offset); let mut commas: usize = arg_list .syntax() .text() .slice(range_search) .to_string() .matches(',') .count(); // If we have a method call eat the first param since it's just self. if has_self { commas += 1; } current_parameter = Some(commas); } } return Ok(Some((descriptor, current_parameter))); } } } } Ok(None) } fn index_resolve(&self, name_ref: ast::NameRef) -> Cancelable> { let name = name_ref.text(); let mut query = Query::new(name.to_string()); query.exact(); query.limit(4); self.world_symbols(query) } fn resolve_module( &self, module_tree: &ModuleTree, file_id: FileId, module: ast::Module, ) -> Vec { let name = match module.name() { Some(name) => name.text(), None => return Vec::new(), }; let module_id = match module_tree.any_module_for_file(file_id) { Some(id) => id, None => return Vec::new(), }; module_id.child(module_tree, name.as_str()) .map(|it| it.file_id(module_tree)) .into_iter() .collect() } } impl SourceChange { pub(crate) fn from_local_edit(file_id: FileId, label: &str, edit: LocalEdit) -> SourceChange { let file_edit = SourceFileEdit { file_id, edits: edit.edit.into_atoms(), }; SourceChange { label: label.to_string(), source_file_edits: vec![file_edit], file_system_edits: vec![], cursor_position: edit .cursor_position .map(|offset| Position { offset, file_id }), } } } impl CrateGraph { fn crate_id_for_crate_root(&self, file_id: FileId) -> Option { let (&crate_id, _) = self .crate_roots .iter() .find(|(_crate_id, &root_id)| root_id == file_id)?; Some(crate_id) } } enum FnCallNode<'a> { CallExpr(ast::CallExpr<'a>), MethodCallExpr(ast::MethodCallExpr<'a>), } impl<'a> FnCallNode<'a> { pub fn with_node(syntax: SyntaxNodeRef, offset: TextUnit) -> Option { if let Some(expr) = find_node_at_offset::(syntax, offset) { return Some(FnCallNode::CallExpr(expr)); } if let Some(expr) = find_node_at_offset::(syntax, offset) { return Some(FnCallNode::MethodCallExpr(expr)); } None } pub fn name_ref(&self) -> Option { match *self { FnCallNode::CallExpr(call_expr) => Some(match call_expr.expr()? { Expr::PathExpr(path_expr) => path_expr.path()?.segment()?.name_ref()?, _ => return None, }), FnCallNode::MethodCallExpr(call_expr) => call_expr .syntax() .children() .filter_map(ast::NameRef::cast) .nth(0), } } pub fn arg_list(&self) -> Option { match *self { FnCallNode::CallExpr(expr) => expr.arg_list(), FnCallNode::MethodCallExpr(expr) => expr.arg_list(), } } }