//! The context or environment in which the language server functions. In our //! server implementation this is know as the `WorldState`. //! //! Each tick provides an immutable snapshot of the state as `WorldSnapshot`. use std::{ path::{Path, PathBuf}, sync::Arc, }; use crossbeam_channel::{unbounded, Receiver}; use lsp_types::Url; use parking_lot::RwLock; use ra_flycheck::{Flycheck, FlycheckConfig}; use ra_ide::{ Analysis, AnalysisChange, AnalysisHost, CrateGraph, FileId, LibraryData, SourceRootId, }; use ra_project_model::{get_rustc_cfg_options, ProcMacroClient, ProjectWorkspace}; use ra_vfs::{LineEndings, RootEntry, Vfs, VfsChange, VfsFile, VfsRoot, VfsTask, Watch}; use relative_path::RelativePathBuf; use stdx::format_to; use crate::{ config::Config, diagnostics::{ to_proto::url_from_path_with_drive_lowercasing, CheckFixes, DiagnosticCollection, }, main_loop::pending_requests::{CompletedRequest, LatestRequests}, vfs_glob::{Glob, RustPackageFilterBuilder}, LspError, Result, }; use ra_db::ExternSourceId; use rustc_hash::{FxHashMap, FxHashSet}; fn create_flycheck(workspaces: &[ProjectWorkspace], config: &FlycheckConfig) -> Option { // FIXME: Figure out the multi-workspace situation workspaces .iter() .find_map(|w| match w { ProjectWorkspace::Cargo { cargo, .. } => Some(cargo), ProjectWorkspace::Json { .. } => None, }) .map(|cargo| { let cargo_project_root = cargo.workspace_root().to_path_buf(); Some(Flycheck::new(config.clone(), cargo_project_root)) }) .unwrap_or_else(|| { log::warn!("Cargo check watching only supported for cargo workspaces, disabling"); None }) } /// `WorldState` is the primary mutable state of the language server /// /// The most interesting components are `vfs`, which stores a consistent /// snapshot of the file systems, and `analysis_host`, which stores our /// incremental salsa database. #[derive(Debug)] pub struct WorldState { pub config: Config, pub roots: Vec, pub workspaces: Arc>, pub analysis_host: AnalysisHost, pub vfs: Arc>, pub task_receiver: Receiver, pub latest_requests: Arc>, pub flycheck: Option, pub diagnostics: DiagnosticCollection, pub proc_macro_client: ProcMacroClient, } /// An immutable snapshot of the world's state at a point in time. pub struct WorldSnapshot { pub config: Config, pub workspaces: Arc>, pub analysis: Analysis, pub latest_requests: Arc>, pub check_fixes: CheckFixes, vfs: Arc>, } impl WorldState { pub fn new( folder_roots: Vec, workspaces: Vec, lru_capacity: Option, exclude_globs: &[Glob], watch: Watch, config: Config, ) -> WorldState { let mut change = AnalysisChange::new(); let extern_dirs: FxHashSet<_> = workspaces.iter().flat_map(ProjectWorkspace::out_dirs).collect(); let roots: Vec<_> = { let create_filter = |is_member| { RustPackageFilterBuilder::default() .set_member(is_member) .exclude(exclude_globs.iter().cloned()) .into_vfs_filter() }; folder_roots .iter() .map(|path| RootEntry::new(path.clone(), create_filter(true))) .chain(workspaces.iter().flat_map(ProjectWorkspace::to_roots).map(|pkg_root| { RootEntry::new(pkg_root.path().to_owned(), create_filter(pkg_root.is_member())) })) .chain( extern_dirs .iter() .map(|path| RootEntry::new(path.to_owned(), create_filter(false))), ) .collect() }; let (task_sender, task_receiver) = unbounded(); let task_sender = Box::new(move |t| task_sender.send(t).unwrap()); let (mut vfs, vfs_roots) = Vfs::new(roots, task_sender, watch); let mut extern_source_roots = FxHashMap::default(); for r in vfs_roots { let vfs_root_path = vfs.root2path(r); let is_local = folder_roots.iter().any(|it| vfs_root_path.starts_with(it)); change.add_root(SourceRootId(r.0), is_local); change.set_debug_root_path(SourceRootId(r.0), vfs_root_path.display().to_string()); // FIXME: add path2root in vfs to simpily this logic if extern_dirs.contains(&vfs_root_path) { extern_source_roots.insert(vfs_root_path, ExternSourceId(r.0)); } } // FIXME: Read default cfgs from config let default_cfg_options = { let mut opts = get_rustc_cfg_options(config.cargo.target.as_ref()); opts.insert_atom("test".into()); opts.insert_atom("debug_assertion".into()); opts }; let proc_macro_client = match &config.proc_macro_srv { None => ProcMacroClient::dummy(), Some((path, args)) => match ProcMacroClient::extern_process(path.into(), args) { Ok(it) => it, Err(err) => { log::error!( "Failed to run ra_proc_macro_srv from path {}, error: {:?}", path.display(), err ); ProcMacroClient::dummy() } }, }; // Create crate graph from all the workspaces let mut crate_graph = CrateGraph::default(); let mut load = |path: &Path| { // Some path from metadata will be non canonicalized, e.g. /foo/../bar/lib.rs let path = path.canonicalize().ok()?; let vfs_file = vfs.load(&path); vfs_file.map(|f| FileId(f.0)) }; for ws in workspaces.iter() { crate_graph.extend(ws.to_crate_graph( &default_cfg_options, &extern_source_roots, &proc_macro_client, &mut load, )); } change.set_crate_graph(crate_graph); let flycheck = config.check.as_ref().and_then(|c| create_flycheck(&workspaces, c)); let mut analysis_host = AnalysisHost::new(lru_capacity); analysis_host.apply_change(change); WorldState { config, roots: folder_roots, workspaces: Arc::new(workspaces), analysis_host, vfs: Arc::new(RwLock::new(vfs)), task_receiver, latest_requests: Default::default(), flycheck, diagnostics: Default::default(), proc_macro_client, } } pub fn update_configuration(&mut self, config: Config) { self.analysis_host.update_lru_capacity(config.lru_capacity); if config.check != self.config.check { self.flycheck = config.check.as_ref().and_then(|it| create_flycheck(&self.workspaces, it)); } self.config = config; } /// Returns a vec of libraries /// FIXME: better API here pub fn process_changes( &mut self, roots_scanned: &mut usize, ) -> Option)>)>> { let changes = self.vfs.write().commit_changes(); if changes.is_empty() { return None; } let mut libs = Vec::new(); let mut change = AnalysisChange::new(); for c in changes { match c { VfsChange::AddRoot { root, files } => { let root_path = self.vfs.read().root2path(root); let is_local = self.roots.iter().any(|r| root_path.starts_with(r)); if is_local { *roots_scanned += 1; for (file, path, text) in files { change.add_file(SourceRootId(root.0), FileId(file.0), path, text); } } else { let files = files .into_iter() .map(|(vfsfile, path, text)| (FileId(vfsfile.0), path, text)) .collect(); libs.push((SourceRootId(root.0), files)); } } VfsChange::AddFile { root, file, path, text } => { change.add_file(SourceRootId(root.0), FileId(file.0), path, text); } VfsChange::RemoveFile { root, file, path } => { change.remove_file(SourceRootId(root.0), FileId(file.0), path) } VfsChange::ChangeFile { file, text } => { change.change_file(FileId(file.0), text); } } } self.analysis_host.apply_change(change); Some(libs) } pub fn add_lib(&mut self, data: LibraryData) { let mut change = AnalysisChange::new(); change.add_library(data); self.analysis_host.apply_change(change); } pub fn snapshot(&self) -> WorldSnapshot { WorldSnapshot { config: self.config.clone(), workspaces: Arc::clone(&self.workspaces), analysis: self.analysis_host.analysis(), vfs: Arc::clone(&self.vfs), latest_requests: Arc::clone(&self.latest_requests), check_fixes: Arc::clone(&self.diagnostics.check_fixes), } } pub fn maybe_collect_garbage(&mut self) { self.analysis_host.maybe_collect_garbage() } pub fn collect_garbage(&mut self) { self.analysis_host.collect_garbage() } pub fn complete_request(&mut self, request: CompletedRequest) { self.latest_requests.write().record(request) } } impl WorldSnapshot { pub fn analysis(&self) -> &Analysis { &self.analysis } pub fn uri_to_file_id(&self, uri: &Url) -> Result { let path = uri.to_file_path().map_err(|()| format!("invalid uri: {}", uri))?; let file = self.vfs.read().path2file(&path).ok_or_else(|| { // Show warning as this file is outside current workspace // FIXME: just handle such files, and remove `LspError::UNKNOWN_FILE`. LspError { code: LspError::UNKNOWN_FILE, message: "Rust file outside current workspace is not supported yet.".to_string(), } })?; Ok(FileId(file.0)) } pub fn file_id_to_uri(&self, id: FileId) -> Result { let path = self.vfs.read().file2path(VfsFile(id.0)); let url = url_from_path_with_drive_lowercasing(path)?; Ok(url) } pub fn file_id_to_path(&self, id: FileId) -> PathBuf { self.vfs.read().file2path(VfsFile(id.0)) } pub fn file_line_endings(&self, id: FileId) -> LineEndings { self.vfs.read().file_line_endings(VfsFile(id.0)) } pub fn path_to_uri(&self, root: SourceRootId, path: &RelativePathBuf) -> Result { let base = self.vfs.read().root2path(VfsRoot(root.0)); let path = path.to_path(base); let url = Url::from_file_path(&path) .map_err(|_| format!("can't convert path to url: {}", path.display()))?; Ok(url) } pub fn status(&self) -> String { let mut buf = String::new(); if self.workspaces.is_empty() { buf.push_str("no workspaces\n") } else { buf.push_str("workspaces:\n"); for w in self.workspaces.iter() { format_to!(buf, "{} packages loaded\n", w.n_packages()); } } buf.push_str("\nanalysis:\n"); buf.push_str( &self .analysis .status() .unwrap_or_else(|_| "Analysis retrieval was cancelled".to_owned()), ); buf } pub fn workspace_root_for(&self, file_id: FileId) -> Option<&Path> { let path = self.vfs.read().file2path(VfsFile(file_id.0)); self.workspaces.iter().find_map(|ws| ws.workspace_root_for(&path)) } }