//! 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_cargo_watch::{url_from_path_with_drive_lowercasing, CheckOptions, CheckWatcher}; use ra_ide::{ Analysis, AnalysisChange, AnalysisHost, CrateGraph, FileId, InlayHintsOptions, 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::{ diagnostics::{CheckFixes, DiagnosticCollection}, feature_flags::FeatureFlags, main_loop::pending_requests::{CompletedRequest, LatestRequests}, vfs_glob::{Glob, RustPackageFilterBuilder}, LspError, Result, }; use ra_db::ExternSourceId; use rustc_hash::{FxHashMap, FxHashSet}; #[derive(Debug, Clone)] pub struct Options { pub publish_decorations: bool, pub supports_location_link: bool, pub line_folding_only: bool, pub inlay_hints: InlayHintsOptions, pub rustfmt_args: Vec, pub cargo_watch: CheckOptions, pub vscode_lldb: bool, } /// `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 options: Options, pub feature_flags: Arc, //FIXME: this belongs to `LoopState` rather than to `WorldState` pub roots_to_scan: usize, pub roots: Vec, pub workspaces: Arc>, pub analysis_host: AnalysisHost, pub vfs: Arc>, pub task_receiver: Receiver, pub latest_requests: Arc>, pub check_watcher: CheckWatcher, pub diagnostics: DiagnosticCollection, } /// An immutable snapshot of the world's state at a point in time. pub struct WorldSnapshot { pub options: Options, pub feature_flags: Arc, 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, options: Options, feature_flags: FeatureFlags, ) -> WorldState { let mut change = AnalysisChange::new(); let mut roots = Vec::new(); roots.extend(folder_roots.iter().map(|path| { let mut filter = RustPackageFilterBuilder::default().set_member(true); for glob in exclude_globs.iter() { filter = filter.exclude(glob.clone()); } RootEntry::new(path.clone(), filter.into_vfs_filter()) })); for ws in workspaces.iter() { roots.extend(ws.to_roots().into_iter().map(|pkg_root| { let mut filter = RustPackageFilterBuilder::default().set_member(pkg_root.is_member()); for glob in exclude_globs.iter() { filter = filter.exclude(glob.clone()); } RootEntry::new(pkg_root.path().clone(), filter.into_vfs_filter()) })); } let mut extern_dirs = FxHashSet::default(); for ws in workspaces.iter() { extern_dirs.extend(ws.out_dirs()); } let mut extern_source_roots = FxHashMap::default(); roots.extend(extern_dirs.iter().map(|path| { let mut filter = RustPackageFilterBuilder::default().set_member(false); for glob in exclude_globs.iter() { filter = filter.exclude(glob.clone()); } RootEntry::new(PathBuf::from(&path), filter.into_vfs_filter()) })); 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 roots_to_scan = vfs_roots.len(); 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(); opts.insert_atom("test".into()); opts.insert_atom("debug_assertion".into()); opts }; // Create crate graph from all the workspaces let mut crate_graph = CrateGraph::default(); let mut load = |path: &std::path::Path| { let vfs_file = vfs.load(path); vfs_file.map(|f| FileId(f.0)) }; let proc_macro_client = ProcMacroClient::extern_process(std::path::Path::new("ra_proc_macro_srv")); workspaces .iter() .map(|ws| { ws.to_crate_graph( &default_cfg_options, &extern_source_roots, &proc_macro_client, &mut load, ) }) .for_each(|graph| { crate_graph.extend(graph); }); change.set_crate_graph(crate_graph); // FIXME: Figure out the multi-workspace situation let check_watcher = 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(); CheckWatcher::new(&options.cargo_watch, cargo_project_root) }) .unwrap_or_else(|| { log::warn!("Cargo check watching only supported for cargo workspaces, disabling"); CheckWatcher::dummy() }); let mut analysis_host = AnalysisHost::new(lru_capacity); analysis_host.apply_change(change); WorldState { options, feature_flags: Arc::new(feature_flags), roots_to_scan, roots: folder_roots, workspaces: Arc::new(workspaces), analysis_host, vfs: Arc::new(RwLock::new(vfs)), task_receiver, latest_requests: Default::default(), check_watcher, diagnostics: Default::default(), } } /// Returns a vec of libraries /// FIXME: better API here pub fn process_changes( &mut self, ) -> 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 { self.roots_to_scan -= 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) { self.roots_to_scan -= 1; let mut change = AnalysisChange::new(); change.add_library(data); self.analysis_host.apply_change(change); } pub fn snapshot(&self) -> WorldSnapshot { WorldSnapshot { options: self.options.clone(), feature_flags: Arc::clone(&self.feature_flags), 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)) } }