1use crate::{
2 DIAGNOSTICS_UPDATE_DEBOUNCE, IncludeWarnings, ToggleWarnings, context_range_for_entry,
3 diagnostic_renderer::{DiagnosticBlock, DiagnosticRenderer},
4 toolbar_controls::DiagnosticsToolbarEditor,
5};
6use anyhow::Result;
7use collections::HashMap;
8use editor::{
9 Editor, EditorEvent, ExcerptRange, MultiBuffer, PathKey,
10 display_map::{BlockPlacement, BlockProperties, BlockStyle, CustomBlockId},
11 multibuffer_context_lines,
12};
13use gpui::{
14 AnyElement, App, AppContext, Context, Entity, EntityId, EventEmitter, FocusHandle, Focusable,
15 InteractiveElement, IntoElement, ParentElement, Render, SharedString, Styled, Subscription,
16 Task, WeakEntity, Window, actions, div,
17};
18use language::{Buffer, DiagnosticEntry, DiagnosticEntryRef, Point};
19use project::{
20 DiagnosticSummary, Event, Project, ProjectItem, ProjectPath,
21 project_settings::{DiagnosticSeverity, ProjectSettings},
22};
23use settings::Settings;
24use std::{
25 any::{Any, TypeId},
26 cmp::{self, Ordering},
27 sync::Arc,
28};
29use text::{Anchor, BufferSnapshot, OffsetRangeExt};
30use ui::{Button, ButtonStyle, Icon, IconName, Label, Tooltip, h_flex, prelude::*};
31use workspace::{
32 ItemHandle, ItemNavHistory, ToolbarItemLocation, Workspace,
33 item::{BreadcrumbText, Item, ItemEvent, TabContentParams},
34};
35
36actions!(
37 diagnostics,
38 [
39 /// Opens the project diagnostics view for the currently focused file.
40 DeployCurrentFile,
41 ]
42);
43
44/// The `BufferDiagnosticsEditor` is meant to be used when dealing specifically
45/// with diagnostics for a single buffer, as only the excerpts of the buffer
46/// where diagnostics are available are displayed.
47pub(crate) struct BufferDiagnosticsEditor {
48 pub project: Entity<Project>,
49 focus_handle: FocusHandle,
50 editor: Entity<Editor>,
51 /// The current diagnostic entries in the `BufferDiagnosticsEditor`. Used to
52 /// allow quick comparison of updated diagnostics, to confirm if anything
53 /// has changed.
54 pub(crate) diagnostics: Vec<DiagnosticEntry<Anchor>>,
55 /// The blocks used to display the diagnostics' content in the editor, next
56 /// to the excerpts where the diagnostic originated.
57 blocks: Vec<CustomBlockId>,
58 /// Multibuffer to contain all excerpts that contain diagnostics, which are
59 /// to be rendered in the editor.
60 multibuffer: Entity<MultiBuffer>,
61 /// The buffer for which the editor is displaying diagnostics and excerpts
62 /// for.
63 buffer: Option<Entity<Buffer>>,
64 /// The path for which the editor is displaying diagnostics for.
65 project_path: ProjectPath,
66 /// Summary of the number of warnings and errors for the path. Used to
67 /// display the number of warnings and errors in the tab's content.
68 summary: DiagnosticSummary,
69 /// Whether to include warnings in the list of diagnostics shown in the
70 /// editor.
71 pub(crate) include_warnings: bool,
72 /// Keeps track of whether there's a background task already running to
73 /// update the excerpts, in order to avoid firing multiple tasks for this purpose.
74 pub(crate) update_excerpts_task: Option<Task<Result<()>>>,
75 /// The project's subscription, responsible for processing events related to
76 /// diagnostics.
77 _subscription: Subscription,
78}
79
80impl BufferDiagnosticsEditor {
81 /// Creates new instance of the `BufferDiagnosticsEditor` which can then be
82 /// displayed by adding it to a pane.
83 pub fn new(
84 project_path: ProjectPath,
85 project_handle: Entity<Project>,
86 buffer: Option<Entity<Buffer>>,
87 include_warnings: bool,
88 window: &mut Window,
89 cx: &mut Context<Self>,
90 ) -> Self {
91 // Subscribe to project events related to diagnostics so the
92 // `BufferDiagnosticsEditor` can update its state accordingly.
93 let project_event_subscription = cx.subscribe_in(
94 &project_handle,
95 window,
96 |buffer_diagnostics_editor, _project, event, window, cx| match event {
97 Event::DiskBasedDiagnosticsStarted { .. } => {
98 cx.notify();
99 }
100 Event::DiskBasedDiagnosticsFinished { .. } => {
101 buffer_diagnostics_editor.update_all_excerpts(window, cx);
102 }
103 Event::DiagnosticsUpdated {
104 paths,
105 language_server_id,
106 } => {
107 // When diagnostics have been updated, the
108 // `BufferDiagnosticsEditor` should update its state only if
109 // one of the paths matches its `project_path`, otherwise
110 // the event should be ignored.
111 if paths.contains(&buffer_diagnostics_editor.project_path) {
112 buffer_diagnostics_editor.update_diagnostic_summary(cx);
113
114 if buffer_diagnostics_editor.editor.focus_handle(cx).contains_focused(window, cx) || buffer_diagnostics_editor.focus_handle.contains_focused(window, cx) {
115 log::debug!("diagnostics updated for server {language_server_id}. recording change");
116 } else {
117 log::debug!("diagnostics updated for server {language_server_id}. updating excerpts");
118 buffer_diagnostics_editor.update_all_excerpts(window, cx);
119 }
120 }
121 }
122 _ => {}
123 },
124 );
125
126 let focus_handle = cx.focus_handle();
127
128 cx.on_focus_in(
129 &focus_handle,
130 window,
131 |buffer_diagnostics_editor, window, cx| buffer_diagnostics_editor.focus_in(window, cx),
132 )
133 .detach();
134
135 cx.on_focus_out(
136 &focus_handle,
137 window,
138 |buffer_diagnostics_editor, _event, window, cx| {
139 buffer_diagnostics_editor.focus_out(window, cx)
140 },
141 )
142 .detach();
143
144 let summary = project_handle
145 .read(cx)
146 .diagnostic_summary_for_path(&project_path, cx);
147
148 let multibuffer = cx.new(|cx| MultiBuffer::new(project_handle.read(cx).capability()));
149 let max_severity = Self::max_diagnostics_severity(include_warnings);
150 let editor = cx.new(|cx| {
151 let mut editor = Editor::for_multibuffer(
152 multibuffer.clone(),
153 Some(project_handle.clone()),
154 window,
155 cx,
156 );
157 editor.set_vertical_scroll_margin(5, cx);
158 editor.disable_inline_diagnostics();
159 editor.set_max_diagnostics_severity(max_severity, cx);
160 editor.set_all_diagnostics_active(cx);
161 editor
162 });
163
164 // Subscribe to events triggered by the editor in order to correctly
165 // update the buffer's excerpts.
166 cx.subscribe_in(
167 &editor,
168 window,
169 |buffer_diagnostics_editor, _editor, event: &EditorEvent, window, cx| {
170 cx.emit(event.clone());
171
172 match event {
173 // If the user tries to focus on the editor but there's actually
174 // no excerpts for the buffer, focus back on the
175 // `BufferDiagnosticsEditor` instance.
176 EditorEvent::Focused => {
177 if buffer_diagnostics_editor.multibuffer.read(cx).is_empty() {
178 window.focus(&buffer_diagnostics_editor.focus_handle);
179 }
180 }
181 EditorEvent::Blurred => {
182 buffer_diagnostics_editor.update_all_excerpts(window, cx)
183 }
184 _ => {}
185 }
186 },
187 )
188 .detach();
189
190 let diagnostics = vec![];
191 let update_excerpts_task = None;
192 let mut buffer_diagnostics_editor = Self {
193 project: project_handle,
194 focus_handle,
195 editor,
196 diagnostics,
197 blocks: Default::default(),
198 multibuffer,
199 buffer,
200 project_path,
201 summary,
202 include_warnings,
203 update_excerpts_task,
204 _subscription: project_event_subscription,
205 };
206
207 buffer_diagnostics_editor.update_all_diagnostics(window, cx);
208 buffer_diagnostics_editor
209 }
210
211 fn deploy(
212 workspace: &mut Workspace,
213 _: &DeployCurrentFile,
214 window: &mut Window,
215 cx: &mut Context<Workspace>,
216 ) {
217 // Determine the currently opened path by finding the active editor and
218 // finding the project path for the buffer.
219 // If there's no active editor with a project path, avoiding deploying
220 // the buffer diagnostics view.
221 if let Some(editor) = workspace.active_item_as::<Editor>(cx)
222 && let Some(project_path) = editor.project_path(cx)
223 {
224 // Check if there's already a `BufferDiagnosticsEditor` tab for this
225 // same path, and if so, focus on that one instead of creating a new
226 // one.
227 let existing_editor = workspace
228 .items_of_type::<BufferDiagnosticsEditor>(cx)
229 .find(|editor| editor.read(cx).project_path == project_path);
230
231 if let Some(editor) = existing_editor {
232 workspace.activate_item(&editor, true, true, window, cx);
233 } else {
234 let include_warnings = match cx.try_global::<IncludeWarnings>() {
235 Some(include_warnings) => include_warnings.0,
236 None => ProjectSettings::get_global(cx).diagnostics.include_warnings,
237 };
238
239 let item = cx.new(|cx| {
240 Self::new(
241 project_path,
242 workspace.project().clone(),
243 editor.read(cx).buffer().read(cx).as_singleton(),
244 include_warnings,
245 window,
246 cx,
247 )
248 });
249
250 workspace.add_item_to_active_pane(Box::new(item), None, true, window, cx);
251 }
252 }
253 }
254
255 pub fn register(
256 workspace: &mut Workspace,
257 _window: Option<&mut Window>,
258 _: &mut Context<Workspace>,
259 ) {
260 workspace.register_action(Self::deploy);
261 }
262
263 fn update_all_diagnostics(&mut self, window: &mut Window, cx: &mut Context<Self>) {
264 self.update_all_excerpts(window, cx);
265 }
266
267 fn update_diagnostic_summary(&mut self, cx: &mut Context<Self>) {
268 let project = self.project.read(cx);
269
270 self.summary = project.diagnostic_summary_for_path(&self.project_path, cx);
271 }
272
273 /// Enqueue an update to the excerpts and diagnostic blocks being shown in
274 /// the editor.
275 pub(crate) fn update_all_excerpts(&mut self, window: &mut Window, cx: &mut Context<Self>) {
276 // If there's already a task updating the excerpts, early return and let
277 // the other task finish.
278 if self.update_excerpts_task.is_some() {
279 return;
280 }
281
282 let buffer = self.buffer.clone();
283
284 self.update_excerpts_task = Some(cx.spawn_in(window, async move |editor, cx| {
285 cx.background_executor()
286 .timer(DIAGNOSTICS_UPDATE_DEBOUNCE)
287 .await;
288
289 if let Some(buffer) = buffer {
290 editor
291 .update_in(cx, |editor, window, cx| {
292 editor.update_excerpts(buffer, window, cx)
293 })?
294 .await?;
295 };
296
297 let _ = editor.update(cx, |editor, cx| {
298 editor.update_excerpts_task = None;
299 cx.notify();
300 });
301
302 Ok(())
303 }));
304 }
305
306 /// Updates the excerpts in the `BufferDiagnosticsEditor` for a single
307 /// buffer.
308 fn update_excerpts(
309 &mut self,
310 buffer: Entity<Buffer>,
311 window: &mut Window,
312 cx: &mut Context<Self>,
313 ) -> Task<Result<()>> {
314 let was_empty = self.multibuffer.read(cx).is_empty();
315 let multibuffer_context = multibuffer_context_lines(cx);
316 let buffer_snapshot = buffer.read(cx).snapshot();
317 let buffer_snapshot_max = buffer_snapshot.max_point();
318 let max_severity = Self::max_diagnostics_severity(self.include_warnings)
319 .into_lsp()
320 .unwrap_or(lsp::DiagnosticSeverity::WARNING);
321
322 cx.spawn_in(window, async move |buffer_diagnostics_editor, mut cx| {
323 // Fetch the diagnostics for the whole of the buffer
324 // (`Point::zero()..buffer_snapshot.max_point()`) so we can confirm
325 // if the diagnostics changed, if it didn't, early return as there's
326 // nothing to update.
327 let diagnostics = buffer_snapshot
328 .diagnostics_in_range::<_, Anchor>(Point::zero()..buffer_snapshot_max, false)
329 .collect::<Vec<_>>();
330
331 let unchanged =
332 buffer_diagnostics_editor.update(cx, |buffer_diagnostics_editor, _cx| {
333 if buffer_diagnostics_editor
334 .diagnostics_are_unchanged(&diagnostics, &buffer_snapshot)
335 {
336 return true;
337 }
338
339 buffer_diagnostics_editor.set_diagnostics(&diagnostics);
340 return false;
341 })?;
342
343 if unchanged {
344 return Ok(());
345 }
346
347 // Mapping between the Group ID and a vector of DiagnosticEntry.
348 let mut grouped: HashMap<usize, Vec<_>> = HashMap::default();
349 for entry in diagnostics {
350 grouped
351 .entry(entry.diagnostic.group_id)
352 .or_default()
353 .push(DiagnosticEntryRef {
354 range: entry.range.to_point(&buffer_snapshot),
355 diagnostic: entry.diagnostic,
356 })
357 }
358
359 let mut blocks: Vec<DiagnosticBlock> = Vec::new();
360 for (_, group) in grouped {
361 // If the minimum severity of the group is higher than the
362 // maximum severity, or it doesn't even have severity, skip this
363 // group.
364 if group
365 .iter()
366 .map(|d| d.diagnostic.severity)
367 .min()
368 .is_none_or(|severity| severity > max_severity)
369 {
370 continue;
371 }
372
373 let diagnostic_blocks = cx.update(|_window, cx| {
374 DiagnosticRenderer::diagnostic_blocks_for_group(
375 group,
376 buffer_snapshot.remote_id(),
377 Some(Arc::new(buffer_diagnostics_editor.clone())),
378 cx,
379 )
380 })?;
381
382 // For each of the diagnostic blocks to be displayed in the
383 // editor, figure out its index in the list of blocks.
384 //
385 // The following rules are used to determine the order:
386 // 1. Blocks with a lower start position should come first.
387 // 2. If two blocks have the same start position, the one with
388 // the higher end position should come first.
389 for diagnostic_block in diagnostic_blocks {
390 let index = blocks.partition_point(|probe| {
391 match probe
392 .initial_range
393 .start
394 .cmp(&diagnostic_block.initial_range.start)
395 {
396 Ordering::Less => true,
397 Ordering::Greater => false,
398 Ordering::Equal => {
399 probe.initial_range.end > diagnostic_block.initial_range.end
400 }
401 }
402 });
403
404 blocks.insert(index, diagnostic_block);
405 }
406 }
407
408 // Build the excerpt ranges for this specific buffer's diagnostics,
409 // so those excerpts can later be used to update the excerpts shown
410 // in the editor.
411 // This is done by iterating over the list of diagnostic blocks and
412 // determine what range does the diagnostic block span.
413 let mut excerpt_ranges: Vec<ExcerptRange<_>> = Vec::new();
414
415 for diagnostic_block in blocks.iter() {
416 let excerpt_range = context_range_for_entry(
417 diagnostic_block.initial_range.clone(),
418 multibuffer_context,
419 buffer_snapshot.clone(),
420 &mut cx,
421 )
422 .await;
423 let initial_range = buffer_snapshot
424 .anchor_after(diagnostic_block.initial_range.start)
425 ..buffer_snapshot.anchor_before(diagnostic_block.initial_range.end);
426
427 let bin_search = |probe: &ExcerptRange<text::Anchor>| {
428 let context_start = || {
429 probe
430 .context
431 .start
432 .cmp(&excerpt_range.start, &buffer_snapshot)
433 };
434 let context_end =
435 || probe.context.end.cmp(&excerpt_range.end, &buffer_snapshot);
436 let primary_start = || {
437 probe
438 .primary
439 .start
440 .cmp(&initial_range.start, &buffer_snapshot)
441 };
442 let primary_end =
443 || probe.primary.end.cmp(&initial_range.end, &buffer_snapshot);
444 context_start()
445 .then_with(context_end)
446 .then_with(primary_start)
447 .then_with(primary_end)
448 .then(cmp::Ordering::Greater)
449 };
450
451 let index = excerpt_ranges
452 .binary_search_by(bin_search)
453 .unwrap_or_else(|i| i);
454
455 excerpt_ranges.insert(
456 index,
457 ExcerptRange {
458 context: excerpt_range,
459 primary: initial_range,
460 },
461 )
462 }
463
464 // Finally, update the editor's content with the new excerpt ranges
465 // for this editor, as well as the diagnostic blocks.
466 buffer_diagnostics_editor.update_in(cx, |buffer_diagnostics_editor, window, cx| {
467 // Remove the list of `CustomBlockId` from the editor's display
468 // map, ensuring that if any diagnostics have been solved, the
469 // associated block stops being shown.
470 let block_ids = buffer_diagnostics_editor.blocks.clone();
471
472 buffer_diagnostics_editor.editor.update(cx, |editor, cx| {
473 editor.display_map.update(cx, |display_map, cx| {
474 display_map.remove_blocks(block_ids.into_iter().collect(), cx);
475 })
476 });
477
478 let (anchor_ranges, _) =
479 buffer_diagnostics_editor
480 .multibuffer
481 .update(cx, |multibuffer, cx| {
482 let excerpt_ranges = excerpt_ranges
483 .into_iter()
484 .map(|range| ExcerptRange {
485 context: range.context.to_point(&buffer_snapshot),
486 primary: range.primary.to_point(&buffer_snapshot),
487 })
488 .collect();
489 multibuffer.set_excerpt_ranges_for_path(
490 PathKey::for_buffer(&buffer, cx),
491 buffer.clone(),
492 &buffer_snapshot,
493 excerpt_ranges,
494 cx,
495 )
496 });
497
498 if was_empty {
499 if let Some(anchor_range) = anchor_ranges.first() {
500 let range_to_select = anchor_range.start..anchor_range.start;
501
502 buffer_diagnostics_editor.editor.update(cx, |editor, cx| {
503 editor.change_selections(Default::default(), window, cx, |selection| {
504 selection.select_anchor_ranges([range_to_select])
505 })
506 });
507
508 // If the `BufferDiagnosticsEditor` is currently
509 // focused, move focus to its editor.
510 if buffer_diagnostics_editor.focus_handle.is_focused(window) {
511 buffer_diagnostics_editor
512 .editor
513 .read(cx)
514 .focus_handle(cx)
515 .focus(window);
516 }
517 }
518 }
519
520 // Cloning the blocks before moving ownership so these can later
521 // be used to set the block contents for testing purposes.
522 #[cfg(test)]
523 let cloned_blocks = blocks.clone();
524
525 // Build new diagnostic blocks to be added to the editor's
526 // display map for the new diagnostics. Update the `blocks`
527 // property before finishing, to ensure the blocks are removed
528 // on the next execution.
529 let editor_blocks =
530 anchor_ranges
531 .into_iter()
532 .zip(blocks.into_iter())
533 .map(|(anchor, block)| {
534 let editor = buffer_diagnostics_editor.editor.downgrade();
535
536 BlockProperties {
537 placement: BlockPlacement::Near(anchor.start),
538 height: Some(1),
539 style: BlockStyle::Flex,
540 render: Arc::new(move |block_context| {
541 block.render_block(editor.clone(), block_context)
542 }),
543 priority: 1,
544 }
545 });
546
547 let block_ids = buffer_diagnostics_editor.editor.update(cx, |editor, cx| {
548 editor.display_map.update(cx, |display_map, cx| {
549 display_map.insert_blocks(editor_blocks, cx)
550 })
551 });
552
553 // In order to be able to verify which diagnostic blocks are
554 // rendered in the editor, the `set_block_content_for_tests`
555 // function must be used, so that the
556 // `editor::test::editor_content_with_blocks` function can then
557 // be called to fetch these blocks.
558 #[cfg(test)]
559 {
560 for (block_id, block) in block_ids.iter().zip(cloned_blocks.iter()) {
561 let markdown = block.markdown.clone();
562 editor::test::set_block_content_for_tests(
563 &buffer_diagnostics_editor.editor,
564 *block_id,
565 cx,
566 move |cx| {
567 markdown::MarkdownElement::rendered_text(
568 markdown.clone(),
569 cx,
570 editor::hover_popover::diagnostics_markdown_style,
571 )
572 },
573 );
574 }
575 }
576
577 buffer_diagnostics_editor.blocks = block_ids;
578 cx.notify()
579 })
580 })
581 }
582
583 fn set_diagnostics(&mut self, diagnostics: &[DiagnosticEntryRef<'_, Anchor>]) {
584 self.diagnostics = diagnostics
585 .iter()
586 .map(DiagnosticEntryRef::to_owned)
587 .collect();
588 }
589
590 fn diagnostics_are_unchanged(
591 &self,
592 diagnostics: &Vec<DiagnosticEntryRef<'_, Anchor>>,
593 snapshot: &BufferSnapshot,
594 ) -> bool {
595 if self.diagnostics.len() != diagnostics.len() {
596 return false;
597 }
598
599 self.diagnostics
600 .iter()
601 .zip(diagnostics.iter())
602 .all(|(existing, new)| {
603 existing.diagnostic.message == new.diagnostic.message
604 && existing.diagnostic.severity == new.diagnostic.severity
605 && existing.diagnostic.is_primary == new.diagnostic.is_primary
606 && existing.range.to_offset(snapshot) == new.range.to_offset(snapshot)
607 })
608 }
609
610 fn focus_in(&mut self, window: &mut Window, cx: &mut Context<Self>) {
611 // If the `BufferDiagnosticsEditor` is focused and the multibuffer is
612 // not empty, focus on the editor instead, which will allow the user to
613 // start interacting and editing the buffer's contents.
614 if self.focus_handle.is_focused(window) && !self.multibuffer.read(cx).is_empty() {
615 self.editor.focus_handle(cx).focus(window)
616 }
617 }
618
619 fn focus_out(&mut self, window: &mut Window, cx: &mut Context<Self>) {
620 if !self.focus_handle.is_focused(window) && !self.editor.focus_handle(cx).is_focused(window)
621 {
622 self.update_all_excerpts(window, cx);
623 }
624 }
625
626 pub fn toggle_warnings(
627 &mut self,
628 _: &ToggleWarnings,
629 window: &mut Window,
630 cx: &mut Context<Self>,
631 ) {
632 let include_warnings = !self.include_warnings;
633 let max_severity = Self::max_diagnostics_severity(include_warnings);
634
635 self.editor.update(cx, |editor, cx| {
636 editor.set_max_diagnostics_severity(max_severity, cx);
637 });
638
639 self.include_warnings = include_warnings;
640 self.diagnostics.clear();
641 self.update_all_diagnostics(window, cx);
642 }
643
644 fn max_diagnostics_severity(include_warnings: bool) -> DiagnosticSeverity {
645 match include_warnings {
646 true => DiagnosticSeverity::Warning,
647 false => DiagnosticSeverity::Error,
648 }
649 }
650
651 #[cfg(test)]
652 pub fn editor(&self) -> &Entity<Editor> {
653 &self.editor
654 }
655
656 #[cfg(test)]
657 pub fn summary(&self) -> &DiagnosticSummary {
658 &self.summary
659 }
660}
661
662impl Focusable for BufferDiagnosticsEditor {
663 fn focus_handle(&self, _: &App) -> FocusHandle {
664 self.focus_handle.clone()
665 }
666}
667
668impl EventEmitter<EditorEvent> for BufferDiagnosticsEditor {}
669
670impl Item for BufferDiagnosticsEditor {
671 type Event = EditorEvent;
672
673 fn act_as_type<'a>(
674 &'a self,
675 type_id: std::any::TypeId,
676 self_handle: &'a Entity<Self>,
677 _: &'a App,
678 ) -> Option<gpui::AnyView> {
679 if type_id == TypeId::of::<Self>() {
680 Some(self_handle.to_any())
681 } else if type_id == TypeId::of::<Editor>() {
682 Some(self.editor.to_any())
683 } else {
684 None
685 }
686 }
687
688 fn added_to_workspace(
689 &mut self,
690 workspace: &mut Workspace,
691 window: &mut Window,
692 cx: &mut Context<Self>,
693 ) {
694 self.editor.update(cx, |editor, cx| {
695 editor.added_to_workspace(workspace, window, cx)
696 });
697 }
698
699 fn breadcrumb_location(&self, _: &App) -> ToolbarItemLocation {
700 ToolbarItemLocation::PrimaryLeft
701 }
702
703 fn breadcrumbs(&self, theme: &theme::Theme, cx: &App) -> Option<Vec<BreadcrumbText>> {
704 self.editor.breadcrumbs(theme, cx)
705 }
706
707 fn can_save(&self, _cx: &App) -> bool {
708 true
709 }
710
711 fn can_split(&self) -> bool {
712 true
713 }
714
715 fn clone_on_split(
716 &self,
717 _workspace_id: Option<workspace::WorkspaceId>,
718 window: &mut Window,
719 cx: &mut Context<Self>,
720 ) -> Task<Option<Entity<Self>>>
721 where
722 Self: Sized,
723 {
724 Task::ready(Some(cx.new(|cx| {
725 BufferDiagnosticsEditor::new(
726 self.project_path.clone(),
727 self.project.clone(),
728 self.buffer.clone(),
729 self.include_warnings,
730 window,
731 cx,
732 )
733 })))
734 }
735
736 fn deactivated(&mut self, window: &mut Window, cx: &mut Context<Self>) {
737 self.editor
738 .update(cx, |editor, cx| editor.deactivated(window, cx));
739 }
740
741 fn for_each_project_item(&self, cx: &App, f: &mut dyn FnMut(EntityId, &dyn ProjectItem)) {
742 self.editor.for_each_project_item(cx, f);
743 }
744
745 fn has_conflict(&self, cx: &App) -> bool {
746 self.multibuffer.read(cx).has_conflict(cx)
747 }
748
749 fn has_deleted_file(&self, cx: &App) -> bool {
750 self.multibuffer.read(cx).has_deleted_file(cx)
751 }
752
753 fn is_dirty(&self, cx: &App) -> bool {
754 self.multibuffer.read(cx).is_dirty(cx)
755 }
756
757 fn navigate(
758 &mut self,
759 data: Box<dyn Any>,
760 window: &mut Window,
761 cx: &mut Context<Self>,
762 ) -> bool {
763 self.editor
764 .update(cx, |editor, cx| editor.navigate(data, window, cx))
765 }
766
767 fn reload(
768 &mut self,
769 project: Entity<Project>,
770 window: &mut Window,
771 cx: &mut Context<Self>,
772 ) -> Task<Result<()>> {
773 self.editor.reload(project, window, cx)
774 }
775
776 fn save(
777 &mut self,
778 options: workspace::item::SaveOptions,
779 project: Entity<Project>,
780 window: &mut Window,
781 cx: &mut Context<Self>,
782 ) -> Task<Result<()>> {
783 self.editor.save(options, project, window, cx)
784 }
785
786 fn save_as(
787 &mut self,
788 _project: Entity<Project>,
789 _path: ProjectPath,
790 _window: &mut Window,
791 _cx: &mut Context<Self>,
792 ) -> Task<Result<()>> {
793 unreachable!()
794 }
795
796 fn set_nav_history(
797 &mut self,
798 nav_history: ItemNavHistory,
799 _window: &mut Window,
800 cx: &mut Context<Self>,
801 ) {
802 self.editor.update(cx, |editor, _| {
803 editor.set_nav_history(Some(nav_history));
804 })
805 }
806
807 // Builds the content to be displayed in the tab.
808 fn tab_content(&self, params: TabContentParams, _window: &Window, cx: &App) -> AnyElement {
809 let path_style = self.project.read(cx).path_style(cx);
810 let error_count = self.summary.error_count;
811 let warning_count = self.summary.warning_count;
812 let label = Label::new(
813 self.project_path
814 .path
815 .file_name()
816 .map(|s| s.to_string())
817 .unwrap_or_else(|| self.project_path.path.display(path_style).to_string()),
818 );
819
820 h_flex()
821 .gap_1()
822 .child(label)
823 .when(error_count == 0 && warning_count == 0, |parent| {
824 parent.child(
825 h_flex()
826 .gap_1()
827 .child(Icon::new(IconName::Check).color(Color::Success)),
828 )
829 })
830 .when(error_count > 0, |parent| {
831 parent.child(
832 h_flex()
833 .gap_1()
834 .child(Icon::new(IconName::XCircle).color(Color::Error))
835 .child(Label::new(error_count.to_string()).color(params.text_color())),
836 )
837 })
838 .when(warning_count > 0, |parent| {
839 parent.child(
840 h_flex()
841 .gap_1()
842 .child(Icon::new(IconName::Warning).color(Color::Warning))
843 .child(Label::new(warning_count.to_string()).color(params.text_color())),
844 )
845 })
846 .into_any_element()
847 }
848
849 fn tab_content_text(&self, _detail: usize, _app: &App) -> SharedString {
850 "Buffer Diagnostics".into()
851 }
852
853 fn tab_tooltip_text(&self, cx: &App) -> Option<SharedString> {
854 let path_style = self.project.read(cx).path_style(cx);
855 Some(
856 format!(
857 "Buffer Diagnostics - {}",
858 self.project_path.path.display(path_style)
859 )
860 .into(),
861 )
862 }
863
864 fn telemetry_event_text(&self) -> Option<&'static str> {
865 Some("Buffer Diagnostics Opened")
866 }
867
868 fn to_item_events(event: &EditorEvent, f: impl FnMut(ItemEvent)) {
869 Editor::to_item_events(event, f)
870 }
871}
872
873impl Render for BufferDiagnosticsEditor {
874 fn render(&mut self, _: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
875 let path_style = self.project.read(cx).path_style(cx);
876 let filename = self.project_path.path.display(path_style).to_string();
877 let error_count = self.summary.error_count;
878 let warning_count = match self.include_warnings {
879 true => self.summary.warning_count,
880 false => 0,
881 };
882
883 let child = if error_count + warning_count == 0 {
884 let label = match warning_count {
885 0 => "No problems in",
886 _ => "No errors in",
887 };
888
889 v_flex()
890 .key_context("EmptyPane")
891 .size_full()
892 .gap_1()
893 .justify_center()
894 .items_center()
895 .text_center()
896 .bg(cx.theme().colors().editor_background)
897 .child(
898 div()
899 .h_flex()
900 .child(Label::new(label).color(Color::Muted))
901 .child(
902 Button::new("open-file", filename)
903 .style(ButtonStyle::Transparent)
904 .tooltip(Tooltip::text("Open File"))
905 .on_click(cx.listener(|buffer_diagnostics, _, window, cx| {
906 if let Some(workspace) = window.root::<Workspace>().flatten() {
907 workspace.update(cx, |workspace, cx| {
908 workspace
909 .open_path(
910 buffer_diagnostics.project_path.clone(),
911 None,
912 true,
913 window,
914 cx,
915 )
916 .detach_and_log_err(cx);
917 })
918 }
919 })),
920 ),
921 )
922 .when(self.summary.warning_count > 0, |div| {
923 let label = match self.summary.warning_count {
924 1 => "Show 1 warning".into(),
925 warning_count => format!("Show {} warnings", warning_count),
926 };
927
928 div.child(
929 Button::new("diagnostics-show-warning-label", label).on_click(cx.listener(
930 |buffer_diagnostics_editor, _, window, cx| {
931 buffer_diagnostics_editor.toggle_warnings(
932 &Default::default(),
933 window,
934 cx,
935 );
936 cx.notify();
937 },
938 )),
939 )
940 })
941 } else {
942 div().size_full().child(self.editor.clone())
943 };
944
945 div()
946 .key_context("Diagnostics")
947 .track_focus(&self.focus_handle(cx))
948 .size_full()
949 .child(child)
950 }
951}
952
953impl DiagnosticsToolbarEditor for WeakEntity<BufferDiagnosticsEditor> {
954 fn include_warnings(&self, cx: &App) -> bool {
955 self.read_with(cx, |buffer_diagnostics_editor, _cx| {
956 buffer_diagnostics_editor.include_warnings
957 })
958 .unwrap_or(false)
959 }
960
961 fn is_updating(&self, cx: &App) -> bool {
962 self.read_with(cx, |buffer_diagnostics_editor, cx| {
963 buffer_diagnostics_editor.update_excerpts_task.is_some()
964 || buffer_diagnostics_editor
965 .project
966 .read(cx)
967 .language_servers_running_disk_based_diagnostics(cx)
968 .next()
969 .is_some()
970 })
971 .unwrap_or(false)
972 }
973
974 fn stop_updating(&self, cx: &mut App) {
975 let _ = self.update(cx, |buffer_diagnostics_editor, cx| {
976 buffer_diagnostics_editor.update_excerpts_task = None;
977 cx.notify();
978 });
979 }
980
981 fn refresh_diagnostics(&self, window: &mut Window, cx: &mut App) {
982 let _ = self.update(cx, |buffer_diagnostics_editor, cx| {
983 buffer_diagnostics_editor.update_all_excerpts(window, cx);
984 });
985 }
986
987 fn toggle_warnings(&self, window: &mut Window, cx: &mut App) {
988 let _ = self.update(cx, |buffer_diagnostics_editor, cx| {
989 buffer_diagnostics_editor.toggle_warnings(&Default::default(), window, cx);
990 });
991 }
992
993 fn get_diagnostics_for_buffer(
994 &self,
995 _buffer_id: text::BufferId,
996 cx: &App,
997 ) -> Vec<language::DiagnosticEntry<text::Anchor>> {
998 self.read_with(cx, |buffer_diagnostics_editor, _cx| {
999 buffer_diagnostics_editor.diagnostics.clone()
1000 })
1001 .unwrap_or_default()
1002 }
1003}