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