1 //! Project loading & configuration updates
2 use std::{mem, sync::Arc};
4 use flycheck::{FlycheckConfig, FlycheckHandle};
5 use hir::db::DefDatabase;
7 use ide_db::base_db::{CrateGraph, SourceRoot, VfsPath};
8 use project_model::{BuildDataCollector, BuildDataResult, ProcMacroClient, ProjectWorkspace};
9 use vfs::{file_set::FileSetConfig, AbsPath, AbsPathBuf, ChangeKind};
12 config::{Config, FilesWatcher, LinkedProject},
13 global_state::GlobalState,
19 pub(crate) enum ProjectWorkspaceProgress {
22 End(Vec<anyhow::Result<ProjectWorkspace>>),
26 pub(crate) enum BuildDataProgress {
29 End(anyhow::Result<BuildDataResult>),
33 pub(crate) fn is_quiescent(&self) -> bool {
34 !(self.fetch_workspaces_queue.op_in_progress()
35 || self.fetch_build_data_queue.op_in_progress()
36 || self.vfs_progress_config_version < self.vfs_config_version
37 || self.vfs_progress_n_done < self.vfs_progress_n_total)
40 pub(crate) fn update_configuration(&mut self, config: Config) {
41 let _p = profile::span("GlobalState::update_configuration");
42 let old_config = mem::replace(&mut self.config, Arc::new(config));
43 if self.config.lru_capacity() != old_config.lru_capacity() {
44 self.analysis_host.update_lru_capacity(self.config.lru_capacity());
46 if self.config.linked_projects() != old_config.linked_projects() {
47 self.fetch_workspaces_request()
48 } else if self.config.flycheck() != old_config.flycheck() {
49 self.reload_flycheck();
52 // Apply experimental feature flags.
55 .set_enable_proc_attr_macros(self.config.expand_proc_attr_macros());
57 pub(crate) fn maybe_refresh(&mut self, changes: &[(AbsPathBuf, ChangeKind)]) {
58 if !changes.iter().any(|(path, kind)| is_interesting(path, *kind)) {
62 "Requesting workspace reload because of the following changes: {}",
66 .filter(|(path, kind)| is_interesting(path, *kind))
67 .map(|(path, kind)| format!("{}: {:?}", path.display(), kind)),
71 self.fetch_workspaces_request();
73 fn is_interesting(path: &AbsPath, change_kind: ChangeKind) -> bool {
74 const IMPLICIT_TARGET_FILES: &[&str] = &["build.rs", "src/main.rs", "src/lib.rs"];
75 const IMPLICIT_TARGET_DIRS: &[&str] = &["src/bin", "examples", "tests", "benches"];
77 if path.ends_with("Cargo.toml") || path.ends_with("Cargo.lock") {
80 if change_kind == ChangeKind::Modify {
83 if path.extension().unwrap_or_default() != "rs" {
86 if IMPLICIT_TARGET_FILES.iter().any(|it| path.ends_with(it)) {
89 let parent = match path.parent() {
93 if IMPLICIT_TARGET_DIRS.iter().any(|it| parent.ends_with(it)) {
96 if path.ends_with("main.rs") {
97 let grand_parent = match parent.parent() {
101 if IMPLICIT_TARGET_DIRS.iter().any(|it| grand_parent.ends_with(it)) {
108 pub(crate) fn report_new_status_if_needed(&mut self) {
109 let mut status = lsp_ext::ServerStatusParams {
110 health: lsp_ext::Health::Ok,
111 quiescent: self.is_quiescent(),
115 if let Some(error) = self.build_data_error() {
116 status.health = lsp_ext::Health::Warning;
117 status.message = Some(error)
119 if !self.config.cargo_autoreload()
120 && self.is_quiescent()
121 && self.fetch_workspaces_queue.op_requested()
123 status.health = lsp_ext::Health::Warning;
124 status.message = Some("Workspace reload required".to_string())
127 if let Some(error) = self.fetch_workspace_error() {
128 status.health = lsp_ext::Health::Error;
129 status.message = Some(error)
132 if self.last_reported_status.as_ref() != Some(&status) {
133 self.last_reported_status = Some(status.clone());
135 if let (lsp_ext::Health::Error, Some(message)) = (status.health, &status.message) {
136 self.show_message(lsp_types::MessageType::Error, message.clone());
139 if self.config.server_status_notification() {
140 self.send_notification::<lsp_ext::ServerStatusNotification>(status);
145 pub(crate) fn fetch_workspaces_request(&mut self) {
146 self.fetch_workspaces_queue.request_op(())
148 pub(crate) fn fetch_workspaces_if_needed(&mut self) {
149 if self.fetch_workspaces_queue.should_start_op().is_none() {
152 log::info!("will fetch workspaces");
154 self.task_pool.handle.spawn_with_sender({
155 let linked_projects = self.config.linked_projects();
156 let detached_files = self.config.detached_files().to_vec();
157 let cargo_config = self.config.cargo();
161 let sender = sender.clone();
164 .send(Task::FetchWorkspace(ProjectWorkspaceProgress::Report(msg)))
169 sender.send(Task::FetchWorkspace(ProjectWorkspaceProgress::Begin)).unwrap();
171 let mut workspaces = linked_projects
173 .map(|project| match project {
174 LinkedProject::ProjectManifest(manifest) => {
175 project_model::ProjectWorkspace::load(
181 LinkedProject::InlineJsonProject(it) => {
182 project_model::ProjectWorkspace::load_inline(
184 cargo_config.target.as_deref(),
188 .collect::<Vec<_>>();
190 if !detached_files.is_empty() {
192 .push(project_model::ProjectWorkspace::load_detached_files(detached_files));
195 log::info!("did fetch workspaces {:?}", workspaces);
197 .send(Task::FetchWorkspace(ProjectWorkspaceProgress::End(workspaces)))
202 pub(crate) fn fetch_workspaces_completed(
204 workspaces: Vec<anyhow::Result<ProjectWorkspace>>,
206 self.fetch_workspaces_queue.op_completed(workspaces)
209 pub(crate) fn fetch_build_data_request(&mut self, build_data_collector: BuildDataCollector) {
210 self.fetch_build_data_queue.request_op(build_data_collector);
212 pub(crate) fn fetch_build_data_if_needed(&mut self) {
213 let mut build_data_collector = match self.fetch_build_data_queue.should_start_op() {
217 self.task_pool.handle.spawn_with_sender(move |sender| {
218 sender.send(Task::FetchBuildData(BuildDataProgress::Begin)).unwrap();
221 let sender = sender.clone();
223 sender.send(Task::FetchBuildData(BuildDataProgress::Report(msg))).unwrap()
226 let res = build_data_collector.collect(&progress);
227 sender.send(Task::FetchBuildData(BuildDataProgress::End(res))).unwrap();
230 pub(crate) fn fetch_build_data_completed(
232 build_data: anyhow::Result<BuildDataResult>,
234 self.fetch_build_data_queue.op_completed(Some(build_data))
237 pub(crate) fn switch_workspaces(&mut self) {
238 let _p = profile::span("GlobalState::switch_workspaces");
239 log::info!("will switch workspaces");
241 if let Some(error_message) = self.fetch_workspace_error() {
242 log::error!("failed to switch workspaces: {}", error_message);
243 if !self.workspaces.is_empty() {
248 if let Some(error_message) = self.build_data_error() {
249 log::error!("failed to switch build data: {}", error_message);
252 let workspaces = self
253 .fetch_workspaces_queue
256 .filter_map(|res| res.as_ref().ok().cloned())
257 .collect::<Vec<_>>();
259 let workspace_build_data = match self.fetch_build_data_queue.last_op_result() {
260 Some(Ok(it)) => Some(it.clone()),
261 None | Some(Err(_)) => None,
264 if *self.workspaces == workspaces && self.workspace_build_data == workspace_build_data {
268 if let FilesWatcher::Client = self.config.files().watcher {
269 if self.config.did_change_watched_files_dynamic_registration() {
270 let registration_options = lsp_types::DidChangeWatchedFilesRegistrationOptions {
273 .flat_map(|it| it.to_roots(workspace_build_data.as_ref()))
274 .filter(|it| it.is_member)
276 root.include.into_iter().map(|it| format!("{}/**/*.rs", it.display()))
278 .map(|glob_pattern| lsp_types::FileSystemWatcher {
284 let registration = lsp_types::Registration {
285 id: "workspace/didChangeWatchedFiles".to_string(),
286 method: "workspace/didChangeWatchedFiles".to_string(),
287 register_options: Some(serde_json::to_value(registration_options).unwrap()),
289 self.send_request::<lsp_types::request::RegisterCapability>(
290 lsp_types::RegistrationParams { registrations: vec![registration] },
296 let mut change = Change::new();
298 let files_config = self.config.files();
299 let project_folders =
300 ProjectFolders::new(&workspaces, &files_config.exclude, workspace_build_data.as_ref());
302 if self.proc_macro_client.is_none() {
303 self.proc_macro_client = match self.config.proc_macro_srv() {
305 Some((path, args)) => match ProcMacroClient::extern_process(path.clone(), args) {
309 "Failed to run proc_macro_srv from path {}, error: {:?}",
319 let watch = match files_config.watcher {
320 FilesWatcher::Client => vec![],
321 FilesWatcher::Notify => project_folders.watch,
323 self.vfs_config_version += 1;
324 self.loader.handle.set_config(vfs::loader::Config {
325 load: project_folders.load,
327 version: self.vfs_config_version,
330 // Create crate graph from all the workspaces
332 let mut crate_graph = CrateGraph::default();
333 let vfs = &mut self.vfs.write().0;
334 let loader = &mut self.loader;
335 let mem_docs = &self.mem_docs;
336 let mut load = |path: &AbsPath| {
337 let _p = profile::span("GlobalState::load");
338 let vfs_path = vfs::VfsPath::from(path.to_path_buf());
339 if !mem_docs.contains_key(&vfs_path) {
340 let contents = loader.handle.load_sync(path);
341 vfs.set_file_contents(vfs_path.clone(), contents);
343 let res = vfs.file_id(&vfs_path);
345 log::warn!("failed to load {}", path.display())
349 for ws in workspaces.iter() {
350 crate_graph.extend(ws.to_crate_graph(
351 workspace_build_data.as_ref(),
352 self.proc_macro_client.as_ref(),
359 change.set_crate_graph(crate_graph);
361 self.source_root_config = project_folders.source_root_config;
362 self.workspaces = Arc::new(workspaces);
363 self.workspace_build_data = workspace_build_data;
365 self.analysis_host.apply_change(change);
366 self.process_changes();
367 self.reload_flycheck();
368 log::info!("did switch workspaces");
371 fn fetch_workspace_error(&self) -> Option<String> {
372 let mut buf = String::new();
374 for ws in self.fetch_workspaces_queue.last_op_result() {
375 if let Err(err) = ws {
376 stdx::format_to!(buf, "rust-analyzer failed to load workspace: {:#}\n", err);
387 fn build_data_error(&self) -> Option<String> {
388 match self.fetch_build_data_queue.last_op_result() {
390 Some(format!("rust-analyzer failed to fetch build data: {:#}\n", err))
392 Some(Ok(data)) => data.error(),
397 fn reload_flycheck(&mut self) {
398 let _p = profile::span("GlobalState::reload_flycheck");
399 let config = match self.config.flycheck() {
402 self.flycheck = Vec::new();
407 let sender = self.flycheck_sender.clone();
412 .filter_map(|(id, w)| match w {
413 ProjectWorkspace::Cargo { cargo, .. } => Some((id, cargo.workspace_root())),
414 ProjectWorkspace::Json { project, .. } => {
415 // Enable flychecks for json projects if a custom flycheck command was supplied
416 // in the workspace configuration.
418 FlycheckConfig::CustomCommand { .. } => Some((id, project.path())),
422 ProjectWorkspace::DetachedFiles { .. } => None,
425 let sender = sender.clone();
426 FlycheckHandle::spawn(
428 Box::new(move |msg| sender.send(msg).unwrap()),
430 root.to_path_buf().into(),
438 pub(crate) struct ProjectFolders {
439 pub(crate) load: Vec<vfs::loader::Entry>,
440 pub(crate) watch: Vec<usize>,
441 pub(crate) source_root_config: SourceRootConfig,
444 impl ProjectFolders {
446 workspaces: &[ProjectWorkspace],
447 global_excludes: &[AbsPathBuf],
448 build_data: Option<&BuildDataResult>,
449 ) -> ProjectFolders {
450 let mut res = ProjectFolders::default();
451 let mut fsc = FileSetConfig::builder();
452 let mut local_filesets = vec![];
454 for root in workspaces.iter().flat_map(|it| it.to_roots(build_data)) {
455 let file_set_roots: Vec<VfsPath> =
456 root.include.iter().cloned().map(VfsPath::from).collect();
459 let mut dirs = vfs::loader::Directories::default();
460 dirs.extensions.push("rs".into());
461 dirs.include.extend(root.include);
462 dirs.exclude.extend(root.exclude);
463 for excl in global_excludes {
467 .any(|incl| incl.starts_with(excl) || excl.starts_with(incl))
469 dirs.exclude.push(excl.clone());
473 vfs::loader::Entry::Directories(dirs)
477 res.watch.push(res.load.len());
479 res.load.push(entry);
482 local_filesets.push(fsc.len());
484 fsc.add_file_set(file_set_roots)
487 let fsc = fsc.build();
488 res.source_root_config = SourceRootConfig { fsc, local_filesets };
494 #[derive(Default, Debug)]
495 pub(crate) struct SourceRootConfig {
496 pub(crate) fsc: FileSetConfig,
497 pub(crate) local_filesets: Vec<usize>,
500 impl SourceRootConfig {
501 pub(crate) fn partition(&self, vfs: &vfs::Vfs) -> Vec<SourceRoot> {
502 let _p = profile::span("SourceRootConfig::partition");
507 .map(|(idx, file_set)| {
508 let is_local = self.local_filesets.contains(&idx);
510 SourceRoot::new_local(file_set)
512 SourceRoot::new_library(file_set)