1use std::{ops::Range, sync::Arc};
2
3use editor::{
4 Anchor, Editor, EditorSnapshot, ToOffset,
5 display_map::{BlockContext, BlockPlacement, BlockProperties, BlockStyle},
6 hover_markdown_style,
7 scroll::Autoscroll,
8};
9use gpui::{AppContext, Entity, Focusable, WeakEntity};
10use language::{BufferId, Diagnostic, DiagnosticEntry};
11use lsp::DiagnosticSeverity;
12use markdown::{Markdown, MarkdownElement};
13use settings::Settings;
14use text::{AnchorRangeExt, Point};
15use theme::ThemeSettings;
16use ui::{
17 ActiveTheme, AnyElement, App, Context, IntoElement, ParentElement, SharedString, Styled,
18 Window, div,
19};
20use util::maybe;
21
22use crate::ProjectDiagnosticsEditor;
23
24pub struct DiagnosticRenderer;
25
26impl DiagnosticRenderer {
27 pub fn diagnostic_blocks_for_group(
28 diagnostic_group: Vec<DiagnosticEntry<Point>>,
29 buffer_id: BufferId,
30 diagnostics_editor: Option<WeakEntity<ProjectDiagnosticsEditor>>,
31 cx: &mut App,
32 ) -> Vec<DiagnosticBlock> {
33 let Some(primary_ix) = diagnostic_group
34 .iter()
35 .position(|d| d.diagnostic.is_primary)
36 else {
37 return Vec::new();
38 };
39 let primary = diagnostic_group[primary_ix].clone();
40 let group_id = primary.diagnostic.group_id;
41 let mut results = vec![];
42 for entry in diagnostic_group.iter() {
43 if entry.diagnostic.is_primary {
44 let mut markdown = Self::markdown(&entry.diagnostic);
45 let diagnostic = &primary.diagnostic;
46 if diagnostic.source.is_some() || diagnostic.code.is_some() {
47 markdown.push_str(" (");
48 }
49 if let Some(source) = diagnostic.source.as_ref() {
50 markdown.push_str(&Markdown::escape(&source));
51 }
52 if diagnostic.source.is_some() && diagnostic.code.is_some() {
53 markdown.push(' ');
54 }
55 if let Some(code) = diagnostic.code.as_ref() {
56 if let Some(description) = diagnostic.code_description.as_ref() {
57 markdown.push('[');
58 markdown.push_str(&Markdown::escape(&code.to_string()));
59 markdown.push_str("](");
60 markdown.push_str(&Markdown::escape(description.as_ref()));
61 markdown.push(')');
62 } else {
63 markdown.push_str(&Markdown::escape(&code.to_string()));
64 }
65 }
66 if diagnostic.source.is_some() || diagnostic.code.is_some() {
67 markdown.push(')');
68 }
69
70 for (ix, entry) in diagnostic_group.iter().enumerate() {
71 if entry.range.start.row.abs_diff(primary.range.start.row) >= 5 {
72 markdown.push_str("\n- hint: [");
73 markdown.push_str(&Markdown::escape(&entry.diagnostic.message));
74 markdown.push_str(&format!(
75 "](file://#diagnostic-{buffer_id}-{group_id}-{ix})\n",
76 ))
77 }
78 }
79 results.push(DiagnosticBlock {
80 initial_range: primary.range.clone(),
81 severity: primary.diagnostic.severity,
82 diagnostics_editor: diagnostics_editor.clone(),
83 markdown: cx.new(|cx| Markdown::new(markdown.into(), None, None, cx)),
84 });
85 } else if entry.range.start.row.abs_diff(primary.range.start.row) < 5 {
86 let markdown = Self::markdown(&entry.diagnostic);
87
88 results.push(DiagnosticBlock {
89 initial_range: entry.range.clone(),
90 severity: entry.diagnostic.severity,
91 diagnostics_editor: diagnostics_editor.clone(),
92 markdown: cx.new(|cx| Markdown::new(markdown.into(), None, None, cx)),
93 });
94 } else {
95 let mut markdown = Self::markdown(&entry.diagnostic);
96 markdown.push_str(&format!(
97 " ([back](file://#diagnostic-{buffer_id}-{group_id}-{primary_ix}))"
98 ));
99
100 results.push(DiagnosticBlock {
101 initial_range: entry.range.clone(),
102 severity: entry.diagnostic.severity,
103 diagnostics_editor: diagnostics_editor.clone(),
104 markdown: cx.new(|cx| Markdown::new(markdown.into(), None, None, cx)),
105 });
106 }
107 }
108
109 results
110 }
111
112 fn markdown(diagnostic: &Diagnostic) -> String {
113 let mut markdown = String::new();
114
115 if let Some(md) = &diagnostic.markdown {
116 markdown.push_str(md);
117 } else {
118 markdown.push_str(&Markdown::escape(&diagnostic.message));
119 };
120 markdown
121 }
122}
123
124impl editor::DiagnosticRenderer for DiagnosticRenderer {
125 fn render_group(
126 &self,
127 diagnostic_group: Vec<DiagnosticEntry<Point>>,
128 buffer_id: BufferId,
129 snapshot: EditorSnapshot,
130 editor: WeakEntity<Editor>,
131 cx: &mut App,
132 ) -> Vec<BlockProperties<Anchor>> {
133 let blocks = Self::diagnostic_blocks_for_group(diagnostic_group, buffer_id, None, cx);
134 blocks
135 .into_iter()
136 .map(|block| {
137 let editor = editor.clone();
138 BlockProperties {
139 placement: BlockPlacement::Near(
140 snapshot
141 .buffer_snapshot
142 .anchor_after(block.initial_range.start),
143 ),
144 height: Some(1),
145 style: BlockStyle::Flex,
146 render: Arc::new(move |bcx| block.render_block(editor.clone(), bcx)),
147 priority: 1,
148 }
149 })
150 .collect()
151 }
152
153 fn render_hover(
154 &self,
155 diagnostic_group: Vec<DiagnosticEntry<Point>>,
156 range: Range<Point>,
157 buffer_id: BufferId,
158 cx: &mut App,
159 ) -> Option<Entity<Markdown>> {
160 let blocks = Self::diagnostic_blocks_for_group(diagnostic_group, buffer_id, None, cx);
161 blocks.into_iter().find_map(|block| {
162 if block.initial_range == range {
163 Some(block.markdown)
164 } else {
165 None
166 }
167 })
168 }
169
170 fn open_link(
171 &self,
172 editor: &mut Editor,
173 link: SharedString,
174 window: &mut Window,
175 cx: &mut Context<Editor>,
176 ) {
177 DiagnosticBlock::open_link(editor, &None, link, window, cx);
178 }
179}
180
181#[derive(Clone)]
182pub(crate) struct DiagnosticBlock {
183 pub(crate) initial_range: Range<Point>,
184 pub(crate) severity: DiagnosticSeverity,
185 pub(crate) markdown: Entity<Markdown>,
186 pub(crate) diagnostics_editor: Option<WeakEntity<ProjectDiagnosticsEditor>>,
187}
188
189impl DiagnosticBlock {
190 pub fn render_block(&self, editor: WeakEntity<Editor>, bcx: &BlockContext) -> AnyElement {
191 let cx = &bcx.app;
192 let status_colors = bcx.app.theme().status();
193
194 let max_width = bcx.em_width * 120.;
195
196 let (background_color, border_color) = match self.severity {
197 DiagnosticSeverity::ERROR => (status_colors.error_background, status_colors.error),
198 DiagnosticSeverity::WARNING => {
199 (status_colors.warning_background, status_colors.warning)
200 }
201 DiagnosticSeverity::INFORMATION => (status_colors.info_background, status_colors.info),
202 DiagnosticSeverity::HINT => (status_colors.hint_background, status_colors.info),
203 _ => (status_colors.ignored_background, status_colors.ignored),
204 };
205 let settings = ThemeSettings::get_global(cx);
206 let editor_line_height = (settings.line_height() * settings.buffer_font_size(cx)).round();
207 let line_height = editor_line_height;
208 let diagnostics_editor = self.diagnostics_editor.clone();
209
210 div()
211 .border_l_2()
212 .px_2()
213 .line_height(line_height)
214 .bg(background_color)
215 .border_color(border_color)
216 .max_w(max_width)
217 .child(
218 MarkdownElement::new(self.markdown.clone(), hover_markdown_style(bcx.window, cx))
219 .on_url_click({
220 move |link, window, cx| {
221 editor
222 .update(cx, |editor, cx| {
223 Self::open_link(editor, &diagnostics_editor, link, window, cx)
224 })
225 .ok();
226 }
227 }),
228 )
229 .into_any_element()
230 }
231
232 pub fn open_link(
233 editor: &mut Editor,
234 diagnostics_editor: &Option<WeakEntity<ProjectDiagnosticsEditor>>,
235 link: SharedString,
236 window: &mut Window,
237 cx: &mut Context<Editor>,
238 ) {
239 let Some(diagnostic_link) = link.strip_prefix("file://#diagnostic-") else {
240 editor::hover_popover::open_markdown_url(link, window, cx);
241 return;
242 };
243 let Some((buffer_id, group_id, ix)) = maybe!({
244 let mut parts = diagnostic_link.split('-');
245 let buffer_id: u64 = parts.next()?.parse().ok()?;
246 let group_id: usize = parts.next()?.parse().ok()?;
247 let ix: usize = parts.next()?.parse().ok()?;
248 Some((BufferId::new(buffer_id).ok()?, group_id, ix))
249 }) else {
250 return;
251 };
252
253 if let Some(diagnostics_editor) = diagnostics_editor {
254 if let Some(diagnostic) = diagnostics_editor
255 .update(cx, |diagnostics, _| {
256 diagnostics
257 .diagnostics
258 .get(&buffer_id)
259 .cloned()
260 .unwrap_or_default()
261 .into_iter()
262 .filter(|d| d.diagnostic.group_id == group_id)
263 .nth(ix)
264 })
265 .ok()
266 .flatten()
267 {
268 let multibuffer = editor.buffer().read(cx);
269 let Some(snapshot) = multibuffer
270 .buffer(buffer_id)
271 .map(|entity| entity.read(cx).snapshot())
272 else {
273 return;
274 };
275
276 for (excerpt_id, range) in multibuffer.excerpts_for_buffer(buffer_id, cx) {
277 if range.context.overlaps(&diagnostic.range, &snapshot) {
278 Self::jump_to(
279 editor,
280 Anchor::range_in_buffer(excerpt_id, buffer_id, diagnostic.range),
281 window,
282 cx,
283 );
284 return;
285 }
286 }
287 }
288 } else {
289 if let Some(diagnostic) = editor
290 .snapshot(window, cx)
291 .buffer_snapshot
292 .diagnostic_group(buffer_id, group_id)
293 .nth(ix)
294 {
295 Self::jump_to(editor, diagnostic.range, window, cx)
296 }
297 };
298 }
299
300 fn jump_to<T: ToOffset>(
301 editor: &mut Editor,
302 range: Range<T>,
303 window: &mut Window,
304 cx: &mut Context<Editor>,
305 ) {
306 let snapshot = &editor.buffer().read(cx).snapshot(cx);
307 let range = range.start.to_offset(&snapshot)..range.end.to_offset(&snapshot);
308
309 editor.unfold_ranges(&[range.start..range.end], true, false, cx);
310 editor.change_selections(Some(Autoscroll::fit()), window, cx, |s| {
311 s.select_ranges([range.start..range.start]);
312 });
313 window.focus(&editor.focus_handle(cx));
314 }
315}