1pub mod items;
2mod toolbar_controls;
3
4mod buffer_diagnostics;
5mod diagnostic_renderer;
6
7#[cfg(test)]
8mod diagnostics_tests;
9
10use anyhow::Result;
11use buffer_diagnostics::BufferDiagnosticsEditor;
12use collections::{BTreeSet, HashMap, HashSet};
13use diagnostic_renderer::DiagnosticBlock;
14use editor::{
15 Editor, EditorEvent, ExcerptRange, MultiBuffer, PathKey,
16 display_map::{BlockPlacement, BlockProperties, BlockStyle, CustomBlockId},
17 multibuffer_context_lines,
18};
19use gpui::{
20 AnyElement, App, AsyncApp, Context, Entity, EventEmitter, FocusHandle, FocusOutEvent,
21 Focusable, Global, InteractiveElement, IntoElement, ParentElement, Render, SharedString,
22 Styled, Subscription, Task, WeakEntity, Window, actions, div,
23};
24use itertools::Itertools as _;
25use language::{
26 Bias, Buffer, BufferRow, BufferSnapshot, DiagnosticEntry, DiagnosticEntryRef, Point,
27 ToTreeSitterPoint,
28};
29use project::{
30 DiagnosticSummary, Project, ProjectPath,
31 project_settings::{DiagnosticSeverity, ProjectSettings},
32};
33use settings::Settings;
34use std::{
35 any::{Any, TypeId},
36 cmp,
37 ops::{Range, RangeInclusive},
38 sync::Arc,
39 time::Duration,
40};
41use text::{BufferId, OffsetRangeExt};
42use theme::ActiveTheme;
43use toolbar_controls::DiagnosticsToolbarEditor;
44pub use toolbar_controls::ToolbarControls;
45use ui::{Icon, IconName, Label, h_flex, prelude::*};
46use util::ResultExt;
47use workspace::{
48 ItemNavHistory, ToolbarItemLocation, Workspace,
49 item::{BreadcrumbText, Item, ItemEvent, ItemHandle, SaveOptions, TabContentParams},
50 searchable::SearchableItemHandle,
51};
52
53actions!(
54 diagnostics,
55 [
56 /// Opens the project diagnostics view.
57 Deploy,
58 /// Toggles the display of warning-level diagnostics.
59 ToggleWarnings,
60 /// Toggles automatic refresh of diagnostics.
61 ToggleDiagnosticsRefresh
62 ]
63);
64
65#[derive(Default)]
66pub(crate) struct IncludeWarnings(bool);
67impl Global for IncludeWarnings {}
68
69pub fn init(cx: &mut App) {
70 editor::set_diagnostic_renderer(diagnostic_renderer::DiagnosticRenderer {}, cx);
71 cx.observe_new(ProjectDiagnosticsEditor::register).detach();
72 cx.observe_new(BufferDiagnosticsEditor::register).detach();
73}
74
75pub(crate) struct ProjectDiagnosticsEditor {
76 pub project: Entity<Project>,
77 workspace: WeakEntity<Workspace>,
78 focus_handle: FocusHandle,
79 editor: Entity<Editor>,
80 diagnostics: HashMap<BufferId, Vec<DiagnosticEntry<text::Anchor>>>,
81 blocks: HashMap<BufferId, Vec<CustomBlockId>>,
82 summary: DiagnosticSummary,
83 multibuffer: Entity<MultiBuffer>,
84 paths_to_update: BTreeSet<ProjectPath>,
85 include_warnings: bool,
86 update_excerpts_task: Option<Task<Result<()>>>,
87 diagnostic_summary_update: Task<()>,
88 _subscription: Subscription,
89}
90
91impl EventEmitter<EditorEvent> for ProjectDiagnosticsEditor {}
92
93const DIAGNOSTICS_UPDATE_DEBOUNCE: Duration = Duration::from_millis(50);
94const DIAGNOSTICS_SUMMARY_UPDATE_DEBOUNCE: Duration = Duration::from_millis(30);
95
96impl Render for ProjectDiagnosticsEditor {
97 fn render(&mut self, _: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
98 let warning_count = if self.include_warnings {
99 self.summary.warning_count
100 } else {
101 0
102 };
103
104 let child =
105 if warning_count + self.summary.error_count == 0 && self.editor.read(cx).is_empty(cx) {
106 let label = if self.summary.warning_count == 0 {
107 SharedString::new_static("No problems in workspace")
108 } else {
109 SharedString::new_static("No errors in workspace")
110 };
111 v_flex()
112 .key_context("EmptyPane")
113 .size_full()
114 .gap_1()
115 .justify_center()
116 .items_center()
117 .text_center()
118 .bg(cx.theme().colors().editor_background)
119 .child(Label::new(label).color(Color::Muted))
120 .when(self.summary.warning_count > 0, |this| {
121 let plural_suffix = if self.summary.warning_count > 1 {
122 "s"
123 } else {
124 ""
125 };
126 let label = format!(
127 "Show {} warning{}",
128 self.summary.warning_count, plural_suffix
129 );
130 this.child(
131 Button::new("diagnostics-show-warning-label", label).on_click(
132 cx.listener(|this, _, window, cx| {
133 this.toggle_warnings(&Default::default(), window, cx);
134 cx.notify();
135 }),
136 ),
137 )
138 })
139 } else {
140 div().size_full().child(self.editor.clone())
141 };
142
143 div()
144 .key_context("Diagnostics")
145 .track_focus(&self.focus_handle(cx))
146 .size_full()
147 .on_action(cx.listener(Self::toggle_warnings))
148 .on_action(cx.listener(Self::toggle_diagnostics_refresh))
149 .child(child)
150 }
151}
152
153#[derive(PartialEq, Eq, Copy, Clone, Debug)]
154enum RetainExcerpts {
155 All,
156 Dirty,
157}
158
159impl ProjectDiagnosticsEditor {
160 pub fn register(
161 workspace: &mut Workspace,
162 _window: Option<&mut Window>,
163 _: &mut Context<Workspace>,
164 ) {
165 workspace.register_action(Self::deploy);
166 }
167
168 fn new(
169 include_warnings: bool,
170 project_handle: Entity<Project>,
171 workspace: WeakEntity<Workspace>,
172 window: &mut Window,
173 cx: &mut Context<Self>,
174 ) -> Self {
175 let project_event_subscription = cx.subscribe_in(
176 &project_handle,
177 window,
178 |this, _project, event, window, cx| match event {
179 project::Event::DiskBasedDiagnosticsStarted { .. } => {
180 cx.notify();
181 }
182 project::Event::DiskBasedDiagnosticsFinished { language_server_id } => {
183 log::debug!("disk based diagnostics finished for server {language_server_id}");
184 this.close_diagnosticless_buffers(
185 cx,
186 this.editor.focus_handle(cx).contains_focused(window, cx)
187 || this.focus_handle.contains_focused(window, cx),
188 );
189 }
190 project::Event::DiagnosticsUpdated {
191 language_server_id,
192 paths,
193 } => {
194 this.paths_to_update.extend(paths.clone());
195 this.diagnostic_summary_update = cx.spawn(async move |this, cx| {
196 cx.background_executor()
197 .timer(DIAGNOSTICS_SUMMARY_UPDATE_DEBOUNCE)
198 .await;
199 this.update(cx, |this, cx| {
200 this.update_diagnostic_summary(cx);
201 })
202 .log_err();
203 });
204
205 log::debug!(
206 "diagnostics updated for server {language_server_id}, \
207 paths {paths:?}. updating excerpts"
208 );
209 this.update_stale_excerpts(window, cx);
210 }
211 _ => {}
212 },
213 );
214
215 let focus_handle = cx.focus_handle();
216 cx.on_focus_in(&focus_handle, window, Self::focus_in)
217 .detach();
218 cx.on_focus_out(&focus_handle, window, Self::focus_out)
219 .detach();
220
221 let excerpts = cx.new(|cx| MultiBuffer::new(project_handle.read(cx).capability()));
222 let editor = cx.new(|cx| {
223 let mut editor =
224 Editor::for_multibuffer(excerpts.clone(), Some(project_handle.clone()), window, cx);
225 editor.set_vertical_scroll_margin(5, cx);
226 editor.disable_inline_diagnostics();
227 editor.set_max_diagnostics_severity(
228 if include_warnings {
229 DiagnosticSeverity::Warning
230 } else {
231 DiagnosticSeverity::Error
232 },
233 cx,
234 );
235 editor.set_all_diagnostics_active(cx);
236 editor
237 });
238 cx.subscribe_in(
239 &editor,
240 window,
241 |this, _editor, event: &EditorEvent, window, cx| {
242 cx.emit(event.clone());
243 match event {
244 EditorEvent::Focused => {
245 if this.multibuffer.read(cx).is_empty() {
246 window.focus(&this.focus_handle);
247 }
248 }
249 EditorEvent::Blurred => this.close_diagnosticless_buffers(cx, false),
250 EditorEvent::Saved => this.close_diagnosticless_buffers(cx, true),
251 EditorEvent::SelectionsChanged { .. } => {
252 this.close_diagnosticless_buffers(cx, true)
253 }
254 _ => {}
255 }
256 },
257 )
258 .detach();
259 cx.observe_global_in::<IncludeWarnings>(window, |this, window, cx| {
260 let include_warnings = cx.global::<IncludeWarnings>().0;
261 this.include_warnings = include_warnings;
262 this.editor.update(cx, |editor, cx| {
263 editor.set_max_diagnostics_severity(
264 if include_warnings {
265 DiagnosticSeverity::Warning
266 } else {
267 DiagnosticSeverity::Error
268 },
269 cx,
270 )
271 });
272 this.refresh(window, cx);
273 })
274 .detach();
275
276 let project = project_handle.read(cx);
277 let mut this = Self {
278 project: project_handle.clone(),
279 summary: project.diagnostic_summary(false, cx),
280 diagnostics: Default::default(),
281 blocks: Default::default(),
282 include_warnings,
283 workspace,
284 multibuffer: excerpts,
285 focus_handle,
286 editor,
287 paths_to_update: Default::default(),
288 update_excerpts_task: None,
289 diagnostic_summary_update: Task::ready(()),
290 _subscription: project_event_subscription,
291 };
292 this.refresh(window, cx);
293 this
294 }
295
296 /// Closes all excerpts of buffers that:
297 /// - have no diagnostics anymore
298 /// - are saved (not dirty)
299 /// - and, if `retain_selections` is true, do not have selections within them
300 fn close_diagnosticless_buffers(&mut self, cx: &mut Context<Self>, retain_selections: bool) {
301 let snapshot = self
302 .editor
303 .update(cx, |editor, cx| editor.display_snapshot(cx));
304 let buffer = self.multibuffer.read(cx);
305 let buffer_ids = buffer.all_buffer_ids();
306 let selected_buffers = self.editor.update(cx, |editor, _| {
307 editor
308 .selections
309 .all_anchors(&snapshot)
310 .iter()
311 .filter_map(|anchor| anchor.start.text_anchor.buffer_id)
312 .collect::<HashSet<_>>()
313 });
314 for buffer_id in buffer_ids {
315 if retain_selections && selected_buffers.contains(&buffer_id) {
316 continue;
317 }
318 let has_no_blocks = self
319 .blocks
320 .get(&buffer_id)
321 .is_none_or(|blocks| blocks.is_empty());
322 if !has_no_blocks {
323 continue;
324 }
325 let is_dirty = self
326 .multibuffer
327 .read(cx)
328 .buffer(buffer_id)
329 .is_none_or(|buffer| buffer.read(cx).is_dirty());
330 if is_dirty {
331 continue;
332 }
333 self.multibuffer.update(cx, |b, cx| {
334 b.remove_excerpts_for_buffer(buffer_id, cx);
335 });
336 }
337 }
338
339 fn update_stale_excerpts(&mut self, window: &mut Window, cx: &mut Context<Self>) {
340 if self.update_excerpts_task.is_some() {
341 return;
342 }
343
344 let project_handle = self.project.clone();
345 self.update_excerpts_task = Some(cx.spawn_in(window, async move |this, cx| {
346 cx.background_executor()
347 .timer(DIAGNOSTICS_UPDATE_DEBOUNCE)
348 .await;
349 loop {
350 let Some(path) = this.update(cx, |this, cx| {
351 let Some(path) = this.paths_to_update.pop_first() else {
352 this.update_excerpts_task = None;
353 cx.notify();
354 return None;
355 };
356 Some(path)
357 })?
358 else {
359 break;
360 };
361
362 if let Some(buffer) = project_handle
363 .update(cx, |project, cx| project.open_buffer(path.clone(), cx))?
364 .await
365 .log_err()
366 {
367 this.update_in(cx, |this, window, cx| {
368 let focused = this.editor.focus_handle(cx).contains_focused(window, cx)
369 || this.focus_handle.contains_focused(window, cx);
370 let retain_excerpts = if focused {
371 RetainExcerpts::All
372 } else {
373 RetainExcerpts::Dirty
374 };
375 this.update_excerpts(buffer, retain_excerpts, window, cx)
376 })?
377 .await?;
378 }
379 }
380 Ok(())
381 }));
382 }
383
384 fn deploy(
385 workspace: &mut Workspace,
386 _: &Deploy,
387 window: &mut Window,
388 cx: &mut Context<Workspace>,
389 ) {
390 if let Some(existing) = workspace.item_of_type::<ProjectDiagnosticsEditor>(cx) {
391 let is_active = workspace
392 .active_item(cx)
393 .is_some_and(|item| item.item_id() == existing.item_id());
394
395 workspace.activate_item(&existing, true, !is_active, window, cx);
396 } else {
397 let workspace_handle = cx.entity().downgrade();
398
399 let include_warnings = match cx.try_global::<IncludeWarnings>() {
400 Some(include_warnings) => include_warnings.0,
401 None => ProjectSettings::get_global(cx).diagnostics.include_warnings,
402 };
403
404 let diagnostics = cx.new(|cx| {
405 ProjectDiagnosticsEditor::new(
406 include_warnings,
407 workspace.project().clone(),
408 workspace_handle,
409 window,
410 cx,
411 )
412 });
413 workspace.add_item_to_active_pane(Box::new(diagnostics), None, true, window, cx);
414 }
415 }
416
417 fn toggle_warnings(&mut self, _: &ToggleWarnings, _: &mut Window, cx: &mut Context<Self>) {
418 cx.set_global(IncludeWarnings(!self.include_warnings));
419 }
420
421 fn toggle_diagnostics_refresh(
422 &mut self,
423 _: &ToggleDiagnosticsRefresh,
424 window: &mut Window,
425 cx: &mut Context<Self>,
426 ) {
427 if self.update_excerpts_task.is_some() {
428 self.update_excerpts_task = None;
429 } else {
430 self.refresh(window, cx);
431 }
432 cx.notify();
433 }
434
435 fn focus_in(&mut self, window: &mut Window, cx: &mut Context<Self>) {
436 if self.focus_handle.is_focused(window) && !self.multibuffer.read(cx).is_empty() {
437 self.editor.focus_handle(cx).focus(window)
438 }
439 }
440
441 fn focus_out(&mut self, _: FocusOutEvent, window: &mut Window, cx: &mut Context<Self>) {
442 if !self.focus_handle.is_focused(window) && !self.editor.focus_handle(cx).is_focused(window)
443 {
444 self.close_diagnosticless_buffers(cx, false);
445 }
446 }
447
448 /// Clears all diagnostics in this view, and refetches them from the project.
449 fn refresh(&mut self, window: &mut Window, cx: &mut Context<Self>) {
450 self.diagnostics.clear();
451 self.editor.update(cx, |editor, cx| {
452 for (_, block_ids) in self.blocks.drain() {
453 editor.display_map.update(cx, |display_map, cx| {
454 display_map.remove_blocks(block_ids.into_iter().collect(), cx)
455 });
456 }
457 });
458 self.close_diagnosticless_buffers(cx, false);
459 self.project.update(cx, |project, cx| {
460 self.paths_to_update = project
461 .diagnostic_summaries(false, cx)
462 .map(|(project_path, _, _)| project_path)
463 .collect::<BTreeSet<_>>();
464 });
465
466 self.update_stale_excerpts(window, cx);
467 }
468
469 fn diagnostics_are_unchanged(
470 &self,
471 existing: &[DiagnosticEntry<text::Anchor>],
472 new: &[DiagnosticEntryRef<'_, text::Anchor>],
473 snapshot: &BufferSnapshot,
474 ) -> bool {
475 if existing.len() != new.len() {
476 return false;
477 }
478 existing.iter().zip(new.iter()).all(|(existing, new)| {
479 existing.diagnostic.message == new.diagnostic.message
480 && existing.diagnostic.severity == new.diagnostic.severity
481 && existing.diagnostic.is_primary == new.diagnostic.is_primary
482 && existing.range.to_offset(snapshot) == new.range.to_offset(snapshot)
483 })
484 }
485
486 fn update_excerpts(
487 &mut self,
488 buffer: Entity<Buffer>,
489 retain_excerpts: RetainExcerpts,
490 window: &mut Window,
491 cx: &mut Context<Self>,
492 ) -> Task<Result<()>> {
493 let was_empty = self.multibuffer.read(cx).is_empty();
494 let buffer_snapshot = buffer.read(cx).snapshot();
495 let buffer_id = buffer_snapshot.remote_id();
496
497 let max_severity = if self.include_warnings {
498 lsp::DiagnosticSeverity::WARNING
499 } else {
500 lsp::DiagnosticSeverity::ERROR
501 };
502
503 cx.spawn_in(window, async move |this, cx| {
504 let diagnostics = buffer_snapshot
505 .diagnostics_in_range::<_, text::Anchor>(
506 Point::zero()..buffer_snapshot.max_point(),
507 false,
508 )
509 .collect::<Vec<_>>();
510
511 let unchanged = this.update(cx, |this, _| {
512 if this.diagnostics.get(&buffer_id).is_some_and(|existing| {
513 this.diagnostics_are_unchanged(existing, &diagnostics, &buffer_snapshot)
514 }) {
515 return true;
516 }
517 this.diagnostics.insert(
518 buffer_id,
519 diagnostics
520 .iter()
521 .map(DiagnosticEntryRef::to_owned)
522 .collect(),
523 );
524 false
525 })?;
526 if unchanged {
527 return Ok(());
528 }
529
530 let mut grouped: HashMap<usize, Vec<_>> = HashMap::default();
531 for entry in diagnostics {
532 grouped
533 .entry(entry.diagnostic.group_id)
534 .or_default()
535 .push(DiagnosticEntryRef {
536 range: entry.range.to_point(&buffer_snapshot),
537 diagnostic: entry.diagnostic,
538 })
539 }
540 let mut blocks: Vec<DiagnosticBlock> = Vec::new();
541
542 let diagnostics_toolbar_editor = Arc::new(this.clone());
543 for (_, group) in grouped {
544 let group_severity = group.iter().map(|d| d.diagnostic.severity).min();
545 if group_severity.is_none_or(|s| s > max_severity) {
546 continue;
547 }
548 let languages = this
549 .read_with(cx, |t, cx| t.project.read(cx).languages().clone())
550 .ok();
551 let more = cx.update(|_, cx| {
552 crate::diagnostic_renderer::DiagnosticRenderer::diagnostic_blocks_for_group(
553 group,
554 buffer_snapshot.remote_id(),
555 Some(diagnostics_toolbar_editor.clone()),
556 languages,
557 cx,
558 )
559 })?;
560
561 blocks.extend(more);
562 }
563
564 let cmp_excerpts = |buffer_snapshot: &BufferSnapshot,
565 a: &ExcerptRange<text::Anchor>,
566 b: &ExcerptRange<text::Anchor>| {
567 let context_start = || a.context.start.cmp(&b.context.start, buffer_snapshot);
568 let context_end = || a.context.end.cmp(&b.context.end, buffer_snapshot);
569 let primary_start = || a.primary.start.cmp(&b.primary.start, buffer_snapshot);
570 let primary_end = || a.primary.end.cmp(&b.primary.end, buffer_snapshot);
571 context_start()
572 .then_with(context_end)
573 .then_with(primary_start)
574 .then_with(primary_end)
575 .then(cmp::Ordering::Greater)
576 };
577
578 let mut excerpt_ranges: Vec<ExcerptRange<_>> = this.update(cx, |this, cx| {
579 this.multibuffer.update(cx, |multi_buffer, cx| {
580 let is_dirty = multi_buffer
581 .buffer(buffer_id)
582 .is_none_or(|buffer| buffer.read(cx).is_dirty());
583 match retain_excerpts {
584 RetainExcerpts::Dirty if !is_dirty => Vec::new(),
585 RetainExcerpts::All | RetainExcerpts::Dirty => multi_buffer
586 .excerpts_for_buffer(buffer_id, cx)
587 .into_iter()
588 .map(|(_, range)| range)
589 .sorted_by(|a, b| cmp_excerpts(&buffer_snapshot, a, b))
590 .collect(),
591 }
592 })
593 })?;
594
595 let mut result_blocks = vec![None; excerpt_ranges.len()];
596 let context_lines = cx.update(|_, cx| multibuffer_context_lines(cx))?;
597 for b in blocks {
598 let excerpt_range = context_range_for_entry(
599 b.initial_range.clone(),
600 context_lines,
601 buffer_snapshot.clone(),
602 cx,
603 )
604 .await;
605 let initial_range = buffer_snapshot.anchor_after(b.initial_range.start)
606 ..buffer_snapshot.anchor_before(b.initial_range.end);
607 let excerpt_range = ExcerptRange {
608 context: excerpt_range,
609 primary: initial_range,
610 };
611 let i = excerpt_ranges
612 .binary_search_by(|probe| cmp_excerpts(&buffer_snapshot, probe, &excerpt_range))
613 .unwrap_or_else(|i| i);
614 excerpt_ranges.insert(i, excerpt_range);
615 result_blocks.insert(i, Some(b));
616 }
617
618 this.update_in(cx, |this, window, cx| {
619 if let Some(block_ids) = this.blocks.remove(&buffer_id) {
620 this.editor.update(cx, |editor, cx| {
621 editor.display_map.update(cx, |display_map, cx| {
622 display_map.remove_blocks(block_ids.into_iter().collect(), cx)
623 });
624 })
625 }
626 let (anchor_ranges, _) = this.multibuffer.update(cx, |multi_buffer, cx| {
627 let excerpt_ranges = excerpt_ranges
628 .into_iter()
629 .map(|range| ExcerptRange {
630 context: range.context.to_point(&buffer_snapshot),
631 primary: range.primary.to_point(&buffer_snapshot),
632 })
633 .collect();
634 multi_buffer.set_excerpt_ranges_for_path(
635 PathKey::for_buffer(&buffer, cx),
636 buffer.clone(),
637 &buffer_snapshot,
638 excerpt_ranges,
639 cx,
640 )
641 });
642 #[cfg(test)]
643 let cloned_blocks = result_blocks.clone();
644
645 if was_empty && let Some(anchor_range) = anchor_ranges.first() {
646 let range_to_select = anchor_range.start..anchor_range.start;
647 this.editor.update(cx, |editor, cx| {
648 editor.change_selections(Default::default(), window, cx, |s| {
649 s.select_anchor_ranges([range_to_select]);
650 })
651 });
652 if this.focus_handle.is_focused(window) {
653 this.editor.read(cx).focus_handle(cx).focus(window);
654 }
655 }
656
657 let editor_blocks = anchor_ranges
658 .into_iter()
659 .zip_eq(result_blocks.into_iter())
660 .filter_map(|(anchor, block)| {
661 let block = block?;
662 let editor = this.editor.downgrade();
663 Some(BlockProperties {
664 placement: BlockPlacement::Near(anchor.start),
665 height: Some(1),
666 style: BlockStyle::Flex,
667 render: Arc::new(move |bcx| block.render_block(editor.clone(), bcx)),
668 priority: 1,
669 })
670 });
671
672 let block_ids = this.editor.update(cx, |editor, cx| {
673 editor.display_map.update(cx, |display_map, cx| {
674 display_map.insert_blocks(editor_blocks, cx)
675 })
676 });
677
678 #[cfg(test)]
679 {
680 for (block_id, block) in
681 block_ids.iter().zip(cloned_blocks.into_iter().flatten())
682 {
683 let markdown = block.markdown.clone();
684 editor::test::set_block_content_for_tests(
685 &this.editor,
686 *block_id,
687 cx,
688 move |cx| {
689 markdown::MarkdownElement::rendered_text(
690 markdown.clone(),
691 cx,
692 editor::hover_popover::diagnostics_markdown_style,
693 )
694 },
695 );
696 }
697 }
698
699 this.blocks.insert(buffer_id, block_ids);
700 cx.notify()
701 })
702 })
703 }
704
705 fn update_diagnostic_summary(&mut self, cx: &mut Context<Self>) {
706 self.summary = self.project.read(cx).diagnostic_summary(false, cx);
707 cx.emit(EditorEvent::TitleChanged);
708 }
709}
710
711impl Focusable for ProjectDiagnosticsEditor {
712 fn focus_handle(&self, _: &App) -> FocusHandle {
713 self.focus_handle.clone()
714 }
715}
716
717impl Item for ProjectDiagnosticsEditor {
718 type Event = EditorEvent;
719
720 fn to_item_events(event: &EditorEvent, f: impl FnMut(ItemEvent)) {
721 Editor::to_item_events(event, f)
722 }
723
724 fn deactivated(&mut self, window: &mut Window, cx: &mut Context<Self>) {
725 self.editor
726 .update(cx, |editor, cx| editor.deactivated(window, cx));
727 }
728
729 fn navigate(
730 &mut self,
731 data: Box<dyn Any>,
732 window: &mut Window,
733 cx: &mut Context<Self>,
734 ) -> bool {
735 self.editor
736 .update(cx, |editor, cx| editor.navigate(data, window, cx))
737 }
738
739 fn tab_tooltip_text(&self, _: &App) -> Option<SharedString> {
740 Some("Project Diagnostics".into())
741 }
742
743 fn tab_content_text(&self, _detail: usize, _: &App) -> SharedString {
744 "Diagnostics".into()
745 }
746
747 fn tab_content(&self, params: TabContentParams, _window: &Window, _: &App) -> AnyElement {
748 h_flex()
749 .gap_1()
750 .when(
751 self.summary.error_count == 0 && self.summary.warning_count == 0,
752 |then| {
753 then.child(
754 h_flex()
755 .gap_1()
756 .child(Icon::new(IconName::Check).color(Color::Success))
757 .child(Label::new("No problems").color(params.text_color())),
758 )
759 },
760 )
761 .when(self.summary.error_count > 0, |then| {
762 then.child(
763 h_flex()
764 .gap_1()
765 .child(Icon::new(IconName::XCircle).color(Color::Error))
766 .child(
767 Label::new(self.summary.error_count.to_string())
768 .color(params.text_color()),
769 ),
770 )
771 })
772 .when(self.summary.warning_count > 0, |then| {
773 then.child(
774 h_flex()
775 .gap_1()
776 .child(Icon::new(IconName::Warning).color(Color::Warning))
777 .child(
778 Label::new(self.summary.warning_count.to_string())
779 .color(params.text_color()),
780 ),
781 )
782 })
783 .into_any_element()
784 }
785
786 fn telemetry_event_text(&self) -> Option<&'static str> {
787 Some("Project Diagnostics Opened")
788 }
789
790 fn for_each_project_item(
791 &self,
792 cx: &App,
793 f: &mut dyn FnMut(gpui::EntityId, &dyn project::ProjectItem),
794 ) {
795 self.editor.for_each_project_item(cx, f)
796 }
797
798 fn set_nav_history(
799 &mut self,
800 nav_history: ItemNavHistory,
801 _: &mut Window,
802 cx: &mut Context<Self>,
803 ) {
804 self.editor.update(cx, |editor, _| {
805 editor.set_nav_history(Some(nav_history));
806 });
807 }
808
809 fn can_split(&self) -> bool {
810 true
811 }
812
813 fn clone_on_split(
814 &self,
815 _workspace_id: Option<workspace::WorkspaceId>,
816 window: &mut Window,
817 cx: &mut Context<Self>,
818 ) -> Task<Option<Entity<Self>>>
819 where
820 Self: Sized,
821 {
822 Task::ready(Some(cx.new(|cx| {
823 ProjectDiagnosticsEditor::new(
824 self.include_warnings,
825 self.project.clone(),
826 self.workspace.clone(),
827 window,
828 cx,
829 )
830 })))
831 }
832
833 fn is_dirty(&self, cx: &App) -> bool {
834 self.multibuffer.read(cx).is_dirty(cx)
835 }
836
837 fn has_deleted_file(&self, cx: &App) -> bool {
838 self.multibuffer.read(cx).has_deleted_file(cx)
839 }
840
841 fn has_conflict(&self, cx: &App) -> bool {
842 self.multibuffer.read(cx).has_conflict(cx)
843 }
844
845 fn can_save(&self, _: &App) -> bool {
846 true
847 }
848
849 fn save(
850 &mut self,
851 options: SaveOptions,
852 project: Entity<Project>,
853 window: &mut Window,
854 cx: &mut Context<Self>,
855 ) -> Task<Result<()>> {
856 self.editor.save(options, project, window, cx)
857 }
858
859 fn save_as(
860 &mut self,
861 _: Entity<Project>,
862 _: ProjectPath,
863 _window: &mut Window,
864 _: &mut Context<Self>,
865 ) -> Task<Result<()>> {
866 unreachable!()
867 }
868
869 fn reload(
870 &mut self,
871 project: Entity<Project>,
872 window: &mut Window,
873 cx: &mut Context<Self>,
874 ) -> Task<Result<()>> {
875 self.editor.reload(project, window, cx)
876 }
877
878 fn act_as_type<'a>(
879 &'a self,
880 type_id: TypeId,
881 self_handle: &'a Entity<Self>,
882 _: &'a App,
883 ) -> Option<gpui::AnyEntity> {
884 if type_id == TypeId::of::<Self>() {
885 Some(self_handle.clone().into())
886 } else if type_id == TypeId::of::<Editor>() {
887 Some(self.editor.clone().into())
888 } else {
889 None
890 }
891 }
892
893 fn as_searchable(&self, _: &Entity<Self>, _: &App) -> Option<Box<dyn SearchableItemHandle>> {
894 Some(Box::new(self.editor.clone()))
895 }
896
897 fn breadcrumb_location(&self, _: &App) -> ToolbarItemLocation {
898 ToolbarItemLocation::PrimaryLeft
899 }
900
901 fn breadcrumbs(&self, theme: &theme::Theme, cx: &App) -> Option<Vec<BreadcrumbText>> {
902 self.editor.breadcrumbs(theme, cx)
903 }
904
905 fn added_to_workspace(
906 &mut self,
907 workspace: &mut Workspace,
908 window: &mut Window,
909 cx: &mut Context<Self>,
910 ) {
911 self.editor.update(cx, |editor, cx| {
912 editor.added_to_workspace(workspace, window, cx)
913 });
914 }
915}
916
917impl DiagnosticsToolbarEditor for WeakEntity<ProjectDiagnosticsEditor> {
918 fn include_warnings(&self, cx: &App) -> bool {
919 self.read_with(cx, |project_diagnostics_editor, _cx| {
920 project_diagnostics_editor.include_warnings
921 })
922 .unwrap_or(false)
923 }
924
925 fn is_updating(&self, cx: &App) -> bool {
926 self.read_with(cx, |project_diagnostics_editor, cx| {
927 project_diagnostics_editor.update_excerpts_task.is_some()
928 || project_diagnostics_editor
929 .project
930 .read(cx)
931 .language_servers_running_disk_based_diagnostics(cx)
932 .next()
933 .is_some()
934 })
935 .unwrap_or(false)
936 }
937
938 fn stop_updating(&self, cx: &mut App) {
939 let _ = self.update(cx, |project_diagnostics_editor, cx| {
940 project_diagnostics_editor.update_excerpts_task = None;
941 cx.notify();
942 });
943 }
944
945 fn refresh_diagnostics(&self, window: &mut Window, cx: &mut App) {
946 let _ = self.update(cx, |project_diagnostics_editor, cx| {
947 project_diagnostics_editor.refresh(window, cx);
948 });
949 }
950
951 fn toggle_warnings(&self, window: &mut Window, cx: &mut App) {
952 let _ = self.update(cx, |project_diagnostics_editor, cx| {
953 project_diagnostics_editor.toggle_warnings(&Default::default(), window, cx);
954 });
955 }
956
957 fn get_diagnostics_for_buffer(
958 &self,
959 buffer_id: text::BufferId,
960 cx: &App,
961 ) -> Vec<language::DiagnosticEntry<text::Anchor>> {
962 self.read_with(cx, |project_diagnostics_editor, _cx| {
963 project_diagnostics_editor
964 .diagnostics
965 .get(&buffer_id)
966 .cloned()
967 .unwrap_or_default()
968 })
969 .unwrap_or_default()
970 }
971}
972const DIAGNOSTIC_EXPANSION_ROW_LIMIT: u32 = 32;
973
974async fn context_range_for_entry(
975 range: Range<Point>,
976 context: u32,
977 snapshot: BufferSnapshot,
978 cx: &mut AsyncApp,
979) -> Range<text::Anchor> {
980 let range = if let Some(rows) = heuristic_syntactic_expand(
981 range.clone(),
982 DIAGNOSTIC_EXPANSION_ROW_LIMIT,
983 snapshot.clone(),
984 cx,
985 )
986 .await
987 {
988 Range {
989 start: Point::new(*rows.start(), 0),
990 end: snapshot.clip_point(Point::new(*rows.end(), u32::MAX), Bias::Left),
991 }
992 } else {
993 Range {
994 start: Point::new(range.start.row.saturating_sub(context), 0),
995 end: snapshot.clip_point(Point::new(range.end.row + context, u32::MAX), Bias::Left),
996 }
997 };
998 snapshot.anchor_after(range.start)..snapshot.anchor_before(range.end)
999}
1000
1001/// Expands the input range using syntax information from TreeSitter. This expansion will be limited
1002/// to the specified `max_row_count`.
1003///
1004/// If there is a containing outline item that is less than `max_row_count`, it will be returned.
1005/// Otherwise fairly arbitrary heuristics are applied to attempt to return a logical block of code.
1006async fn heuristic_syntactic_expand(
1007 input_range: Range<Point>,
1008 max_row_count: u32,
1009 snapshot: BufferSnapshot,
1010 cx: &mut AsyncApp,
1011) -> Option<RangeInclusive<BufferRow>> {
1012 let start = snapshot.clip_point(input_range.start, Bias::Right);
1013 let end = snapshot.clip_point(input_range.end, Bias::Left);
1014 let input_row_count = input_range.end.row - input_range.start.row;
1015 if input_row_count > max_row_count {
1016 return None;
1017 }
1018
1019 let input_range = start..end;
1020 // If the outline node contains the diagnostic and is small enough, just use that.
1021 let outline_range = snapshot.outline_range_containing(input_range.clone());
1022 if let Some(outline_range) = outline_range.clone() {
1023 // Remove blank lines from start and end
1024 if let Some(start_row) = (outline_range.start.row..outline_range.end.row)
1025 .find(|row| !snapshot.line_indent_for_row(*row).is_line_blank())
1026 && let Some(end_row) = (outline_range.start.row..outline_range.end.row + 1)
1027 .rev()
1028 .find(|row| !snapshot.line_indent_for_row(*row).is_line_blank())
1029 {
1030 let row_count = end_row.saturating_sub(start_row);
1031 if row_count <= max_row_count {
1032 return Some(RangeInclusive::new(
1033 outline_range.start.row,
1034 outline_range.end.row,
1035 ));
1036 }
1037 }
1038 }
1039
1040 let mut node = snapshot.syntax_ancestor(input_range.clone())?;
1041
1042 loop {
1043 let node_start = Point::from_ts_point(node.start_position());
1044 let node_end = Point::from_ts_point(node.end_position());
1045 let node_range = node_start..node_end;
1046 let row_count = node_end.row - node_start.row + 1;
1047 let mut ancestor_range = None;
1048 let reached_outline_node = cx.background_executor().scoped({
1049 let node_range = node_range.clone();
1050 let outline_range = outline_range.clone();
1051 let ancestor_range = &mut ancestor_range;
1052 |scope| {
1053 scope.spawn(async move {
1054 // Stop if we've exceeded the row count or reached an outline node. Then, find the interval
1055 // of node children which contains the query range. For example, this allows just returning
1056 // the header of a declaration rather than the entire declaration.
1057 if row_count > max_row_count || outline_range == Some(node_range.clone()) {
1058 let mut cursor = node.walk();
1059 let mut included_child_start = None;
1060 let mut included_child_end = None;
1061 let mut previous_end = node_start;
1062 if cursor.goto_first_child() {
1063 loop {
1064 let child_node = cursor.node();
1065 let child_range =
1066 previous_end..Point::from_ts_point(child_node.end_position());
1067 if included_child_start.is_none()
1068 && child_range.contains(&input_range.start)
1069 {
1070 included_child_start = Some(child_range.start);
1071 }
1072 if child_range.contains(&input_range.end) {
1073 included_child_end = Some(child_range.end);
1074 }
1075 previous_end = child_range.end;
1076 if !cursor.goto_next_sibling() {
1077 break;
1078 }
1079 }
1080 }
1081 let end = included_child_end.unwrap_or(node_range.end);
1082 if let Some(start) = included_child_start {
1083 let row_count = end.row - start.row;
1084 if row_count < max_row_count {
1085 *ancestor_range =
1086 Some(Some(RangeInclusive::new(start.row, end.row)));
1087 return;
1088 }
1089 }
1090 *ancestor_range = Some(None);
1091 }
1092 })
1093 }
1094 });
1095 reached_outline_node.await;
1096 if let Some(node) = ancestor_range {
1097 return node;
1098 }
1099
1100 let node_name = node.grammar_name();
1101 let node_row_range = RangeInclusive::new(node_range.start.row, node_range.end.row);
1102 if node_name.ends_with("block") {
1103 return Some(node_row_range);
1104 } else if node_name.ends_with("statement") || node_name.ends_with("declaration") {
1105 // Expand to the nearest dedent or blank line for statements and declarations.
1106 let tab_size = cx
1107 .update(|cx| snapshot.settings_at(node_range.start, cx).tab_size.get())
1108 .ok()?;
1109 let indent_level = snapshot
1110 .line_indent_for_row(node_range.start.row)
1111 .len(tab_size);
1112 let rows_remaining = max_row_count.saturating_sub(row_count);
1113 let Some(start_row) = (node_range.start.row.saturating_sub(rows_remaining)
1114 ..node_range.start.row)
1115 .rev()
1116 .find(|row| {
1117 is_line_blank_or_indented_less(indent_level, *row, tab_size, &snapshot.clone())
1118 })
1119 else {
1120 return Some(node_row_range);
1121 };
1122 let rows_remaining = max_row_count.saturating_sub(node_range.end.row - start_row);
1123 let Some(end_row) = (node_range.end.row + 1
1124 ..cmp::min(
1125 node_range.end.row + rows_remaining + 1,
1126 snapshot.row_count(),
1127 ))
1128 .find(|row| {
1129 is_line_blank_or_indented_less(indent_level, *row, tab_size, &snapshot.clone())
1130 })
1131 else {
1132 return Some(node_row_range);
1133 };
1134 return Some(RangeInclusive::new(start_row, end_row));
1135 }
1136
1137 // TODO: doing this instead of walking a cursor as that doesn't work - why?
1138 let Some(parent) = node.parent() else {
1139 log::info!(
1140 "Expanding to ancestor reached the top node, so using default context line count.",
1141 );
1142 return None;
1143 };
1144 node = parent;
1145 }
1146}
1147
1148fn is_line_blank_or_indented_less(
1149 indent_level: u32,
1150 row: u32,
1151 tab_size: u32,
1152 snapshot: &BufferSnapshot,
1153) -> bool {
1154 let line_indent = snapshot.line_indent_for_row(row);
1155 line_indent.is_line_blank() || line_indent.len(tab_size) < indent_level
1156}