1use std::{ops::Range, sync::Arc};
2
3use editor::{
4 Anchor, Editor, EditorSnapshot, ToOffset,
5 display_map::{BlockContext, BlockPlacement, BlockProperties, BlockStyle},
6 hover_popover::diagnostics_markdown_style,
7};
8use gpui::{AppContext, Entity, Focusable, WeakEntity};
9use language::{BufferId, Diagnostic, DiagnosticEntry};
10use lsp::DiagnosticSeverity;
11use markdown::{Markdown, MarkdownElement};
12use settings::Settings;
13use text::{AnchorRangeExt, Point};
14use theme::ThemeSettings;
15use ui::{
16 ActiveTheme, AnyElement, App, Context, IntoElement, ParentElement, SharedString, Styled,
17 Window, div,
18};
19use util::maybe;
20
21use crate::toolbar_controls::DiagnosticsToolbarEditor;
22
23pub struct DiagnosticRenderer;
24
25impl DiagnosticRenderer {
26 pub fn diagnostic_blocks_for_group(
27 diagnostic_group: Vec<DiagnosticEntry<Point>>,
28 buffer_id: BufferId,
29 diagnostics_editor: Option<Arc<dyn DiagnosticsToolbarEditor>>,
30 cx: &mut App,
31 ) -> Vec<DiagnosticBlock> {
32 let Some(primary_ix) = diagnostic_group
33 .iter()
34 .position(|d| d.diagnostic.is_primary)
35 else {
36 return Vec::new();
37 };
38 let primary = diagnostic_group[primary_ix].clone();
39 let group_id = primary.diagnostic.group_id;
40 let mut results = vec![];
41 for entry in diagnostic_group.iter() {
42 if entry.diagnostic.is_primary {
43 let mut markdown = Self::markdown(&entry.diagnostic);
44 let diagnostic = &primary.diagnostic;
45 if diagnostic.source.is_some() || diagnostic.code.is_some() {
46 markdown.push_str(" (");
47 }
48 if let Some(source) = diagnostic.source.as_ref() {
49 markdown.push_str(&Markdown::escape(source));
50 }
51 if diagnostic.source.is_some() && diagnostic.code.is_some() {
52 markdown.push(' ');
53 }
54 if let Some(code) = diagnostic.code.as_ref() {
55 if let Some(description) = diagnostic.code_description.as_ref() {
56 markdown.push('[');
57 markdown.push_str(&Markdown::escape(&code.to_string()));
58 markdown.push_str("](");
59 markdown.push_str(&Markdown::escape(description.as_ref()));
60 markdown.push(')');
61 } else {
62 markdown.push_str(&Markdown::escape(&code.to_string()));
63 }
64 }
65 if diagnostic.source.is_some() || diagnostic.code.is_some() {
66 markdown.push(')');
67 }
68
69 for (ix, entry) in diagnostic_group.iter().enumerate() {
70 if entry.range.start.row.abs_diff(primary.range.start.row) >= 5 {
71 markdown.push_str("\n- hint: [");
72 markdown.push_str(&Markdown::escape(&entry.diagnostic.message));
73 markdown.push_str(&format!(
74 "](file://#diagnostic-{buffer_id}-{group_id}-{ix})\n",
75 ))
76 }
77 }
78 results.push(DiagnosticBlock {
79 initial_range: primary.range.clone(),
80 severity: primary.diagnostic.severity,
81 diagnostics_editor: diagnostics_editor.clone(),
82 markdown: cx.new(|cx| Markdown::new(markdown.into(), None, None, cx)),
83 });
84 } else if entry.range.start.row.abs_diff(primary.range.start.row) < 5 {
85 let markdown = Self::markdown(&entry.diagnostic);
86
87 results.push(DiagnosticBlock {
88 initial_range: entry.range.clone(),
89 severity: entry.diagnostic.severity,
90 diagnostics_editor: diagnostics_editor.clone(),
91 markdown: cx.new(|cx| Markdown::new(markdown.into(), None, None, cx)),
92 });
93 } else {
94 let mut markdown = Self::markdown(&entry.diagnostic);
95 markdown.push_str(&format!(
96 " ([back](file://#diagnostic-{buffer_id}-{group_id}-{primary_ix}))"
97 ));
98
99 results.push(DiagnosticBlock {
100 initial_range: entry.range.clone(),
101 severity: entry.diagnostic.severity,
102 diagnostics_editor: diagnostics_editor.clone(),
103 markdown: cx.new(|cx| Markdown::new(markdown.into(), None, None, cx)),
104 });
105 }
106 }
107
108 results
109 }
110
111 fn markdown(diagnostic: &Diagnostic) -> String {
112 let mut markdown = String::new();
113
114 if let Some(md) = &diagnostic.markdown {
115 markdown.push_str(md);
116 } else {
117 markdown.push_str(&Markdown::escape(&diagnostic.message));
118 };
119 markdown
120 }
121}
122
123impl editor::DiagnosticRenderer for DiagnosticRenderer {
124 fn render_group(
125 &self,
126 diagnostic_group: Vec<DiagnosticEntry<Point>>,
127 buffer_id: BufferId,
128 snapshot: EditorSnapshot,
129 editor: WeakEntity<Editor>,
130 cx: &mut App,
131 ) -> Vec<BlockProperties<Anchor>> {
132 let blocks = Self::diagnostic_blocks_for_group(diagnostic_group, buffer_id, None, cx);
133
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<Arc<dyn DiagnosticsToolbarEditor>>,
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(
219 self.markdown.clone(),
220 diagnostics_markdown_style(bcx.window, cx),
221 )
222 .on_url_click({
223 move |link, window, cx| {
224 editor
225 .update(cx, |editor, cx| {
226 Self::open_link(editor, &diagnostics_editor, link, window, cx)
227 })
228 .ok();
229 }
230 }),
231 )
232 .into_any_element()
233 }
234
235 pub fn open_link(
236 editor: &mut Editor,
237 diagnostics_editor: &Option<Arc<dyn DiagnosticsToolbarEditor>>,
238 link: SharedString,
239 window: &mut Window,
240 cx: &mut Context<Editor>,
241 ) {
242 let Some(diagnostic_link) = link.strip_prefix("file://#diagnostic-") else {
243 editor::hover_popover::open_markdown_url(link, window, cx);
244 return;
245 };
246 let Some((buffer_id, group_id, ix)) = maybe!({
247 let mut parts = diagnostic_link.split('-');
248 let buffer_id: u64 = parts.next()?.parse().ok()?;
249 let group_id: usize = parts.next()?.parse().ok()?;
250 let ix: usize = parts.next()?.parse().ok()?;
251 Some((BufferId::new(buffer_id).ok()?, group_id, ix))
252 }) else {
253 return;
254 };
255
256 if let Some(diagnostics_editor) = diagnostics_editor {
257 if let Some(diagnostic) = diagnostics_editor
258 .get_diagnostics_for_buffer(buffer_id, cx)
259 .into_iter()
260 .filter(|d| d.diagnostic.group_id == group_id)
261 .nth(ix)
262 {
263 let multibuffer = editor.buffer().read(cx);
264 let Some(snapshot) = multibuffer
265 .buffer(buffer_id)
266 .map(|entity| entity.read(cx).snapshot())
267 else {
268 return;
269 };
270
271 for (excerpt_id, range) in multibuffer.excerpts_for_buffer(buffer_id, cx) {
272 if range.context.overlaps(&diagnostic.range, &snapshot) {
273 Self::jump_to(
274 editor,
275 Anchor::range_in_buffer(excerpt_id, buffer_id, diagnostic.range),
276 window,
277 cx,
278 );
279 return;
280 }
281 }
282 }
283 } else if let Some(diagnostic) = editor
284 .snapshot(window, cx)
285 .buffer_snapshot
286 .diagnostic_group(buffer_id, group_id)
287 .nth(ix)
288 {
289 Self::jump_to(editor, diagnostic.range, window, cx)
290 };
291 }
292
293 fn jump_to<I: ToOffset>(
294 editor: &mut Editor,
295 range: Range<I>,
296 window: &mut Window,
297 cx: &mut Context<Editor>,
298 ) {
299 let snapshot = &editor.buffer().read(cx).snapshot(cx);
300 let range = range.start.to_offset(snapshot)..range.end.to_offset(snapshot);
301
302 editor.unfold_ranges(&[range.start..range.end], true, false, cx);
303 editor.change_selections(Default::default(), window, cx, |s| {
304 s.select_ranges([range.start..range.start]);
305 });
306 window.focus(&editor.focus_handle(cx));
307 }
308}