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, DiagnosticEntryRef};
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<DiagnosticEntryRef<'_, 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];
39 let group_id = primary.diagnostic.group_id;
40 let mut results = vec![];
41 for entry in diagnostic_group.iter() {
42 let mut markdown = Self::markdown(&entry.diagnostic);
43 if entry.diagnostic.is_primary {
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 {
85 if entry.range.start.row.abs_diff(primary.range.start.row) >= 5 {
86 markdown.push_str(&format!(
87 " ([back](file://#diagnostic-{buffer_id}-{group_id}-{primary_ix}))"
88 ));
89 }
90 results.push(DiagnosticBlock {
91 initial_range: entry.range.clone(),
92 severity: entry.diagnostic.severity,
93 diagnostics_editor: diagnostics_editor.clone(),
94 markdown: cx.new(|cx| Markdown::new(markdown.into(), None, None, cx)),
95 });
96 }
97 }
98
99 results
100 }
101
102 fn markdown(diagnostic: &Diagnostic) -> String {
103 let mut markdown = String::new();
104
105 if let Some(md) = &diagnostic.markdown {
106 markdown.push_str(md);
107 } else {
108 markdown.push_str(&Markdown::escape(&diagnostic.message));
109 };
110 markdown
111 }
112}
113
114impl editor::DiagnosticRenderer for DiagnosticRenderer {
115 fn render_group(
116 &self,
117 diagnostic_group: Vec<DiagnosticEntryRef<'_, Point>>,
118 buffer_id: BufferId,
119 snapshot: EditorSnapshot,
120 editor: WeakEntity<Editor>,
121 cx: &mut App,
122 ) -> Vec<BlockProperties<Anchor>> {
123 let blocks = Self::diagnostic_blocks_for_group(diagnostic_group, buffer_id, None, cx);
124
125 blocks
126 .into_iter()
127 .map(|block| {
128 let editor = editor.clone();
129 BlockProperties {
130 placement: BlockPlacement::Near(
131 snapshot
132 .buffer_snapshot()
133 .anchor_after(block.initial_range.start),
134 ),
135 height: Some(1),
136 style: BlockStyle::Flex,
137 render: Arc::new(move |bcx| block.render_block(editor.clone(), bcx)),
138 priority: 1,
139 }
140 })
141 .collect()
142 }
143
144 fn render_hover(
145 &self,
146 diagnostic_group: Vec<DiagnosticEntryRef<'_, Point>>,
147 range: Range<Point>,
148 buffer_id: BufferId,
149 cx: &mut App,
150 ) -> Option<Entity<Markdown>> {
151 let blocks = Self::diagnostic_blocks_for_group(diagnostic_group, buffer_id, None, cx);
152 blocks
153 .into_iter()
154 .find_map(|block| (block.initial_range == range).then(|| block.markdown))
155 }
156
157 fn open_link(
158 &self,
159 editor: &mut Editor,
160 link: SharedString,
161 window: &mut Window,
162 cx: &mut Context<Editor>,
163 ) {
164 DiagnosticBlock::open_link(editor, &None, link, window, cx);
165 }
166}
167
168#[derive(Clone)]
169pub(crate) struct DiagnosticBlock {
170 pub(crate) initial_range: Range<Point>,
171 pub(crate) severity: DiagnosticSeverity,
172 pub(crate) markdown: Entity<Markdown>,
173 pub(crate) diagnostics_editor: Option<Arc<dyn DiagnosticsToolbarEditor>>,
174}
175
176impl DiagnosticBlock {
177 pub fn render_block(&self, editor: WeakEntity<Editor>, bcx: &BlockContext) -> AnyElement {
178 let cx = &bcx.app;
179 let status_colors = cx.theme().status();
180
181 let max_width = bcx.em_width * 120.;
182
183 let (background_color, border_color) = match self.severity {
184 DiagnosticSeverity::ERROR => (status_colors.error_background, status_colors.error),
185 DiagnosticSeverity::WARNING => {
186 (status_colors.warning_background, status_colors.warning)
187 }
188 DiagnosticSeverity::INFORMATION => (status_colors.info_background, status_colors.info),
189 DiagnosticSeverity::HINT => (status_colors.hint_background, status_colors.info),
190 _ => (status_colors.ignored_background, status_colors.ignored),
191 };
192 let settings = ThemeSettings::get_global(cx);
193 let editor_line_height = (settings.line_height() * settings.buffer_font_size(cx)).round();
194 let line_height = editor_line_height;
195 let diagnostics_editor = self.diagnostics_editor.clone();
196
197 div()
198 .border_l_2()
199 .px_2()
200 .line_height(line_height)
201 .bg(background_color)
202 .border_color(border_color)
203 .max_w(max_width)
204 .child(
205 MarkdownElement::new(
206 self.markdown.clone(),
207 diagnostics_markdown_style(bcx.window, cx),
208 )
209 .on_url_click({
210 move |link, window, cx| {
211 editor
212 .update(cx, |editor, cx| {
213 Self::open_link(editor, &diagnostics_editor, link, window, cx)
214 })
215 .ok();
216 }
217 }),
218 )
219 .into_any_element()
220 }
221
222 pub fn open_link(
223 editor: &mut Editor,
224 diagnostics_editor: &Option<Arc<dyn DiagnosticsToolbarEditor>>,
225 link: SharedString,
226 window: &mut Window,
227 cx: &mut Context<Editor>,
228 ) {
229 let Some(diagnostic_link) = link.strip_prefix("file://#diagnostic-") else {
230 editor::hover_popover::open_markdown_url(link, window, cx);
231 return;
232 };
233 let Some((buffer_id, group_id, ix)) = maybe!({
234 let mut parts = diagnostic_link.split('-');
235 let buffer_id: u64 = parts.next()?.parse().ok()?;
236 let group_id: usize = parts.next()?.parse().ok()?;
237 let ix: usize = parts.next()?.parse().ok()?;
238 Some((BufferId::new(buffer_id).ok()?, group_id, ix))
239 }) else {
240 return;
241 };
242
243 if let Some(diagnostics_editor) = diagnostics_editor {
244 if let Some(diagnostic) = diagnostics_editor
245 .get_diagnostics_for_buffer(buffer_id, cx)
246 .into_iter()
247 .filter(|d| d.diagnostic.group_id == group_id)
248 .nth(ix)
249 {
250 let multibuffer = editor.buffer().read(cx);
251 let Some(snapshot) = multibuffer
252 .buffer(buffer_id)
253 .map(|entity| entity.read(cx).snapshot())
254 else {
255 return;
256 };
257
258 for (excerpt_id, range) in multibuffer.excerpts_for_buffer(buffer_id, cx) {
259 if range.context.overlaps(&diagnostic.range, &snapshot) {
260 Self::jump_to(
261 editor,
262 Anchor::range_in_buffer(excerpt_id, buffer_id, diagnostic.range),
263 window,
264 cx,
265 );
266 return;
267 }
268 }
269 }
270 } else if let Some(diagnostic) = editor
271 .snapshot(window, cx)
272 .buffer_snapshot()
273 .diagnostic_group(buffer_id, group_id)
274 .nth(ix)
275 {
276 Self::jump_to(editor, diagnostic.range, window, cx)
277 };
278 }
279
280 fn jump_to<I: ToOffset>(
281 editor: &mut Editor,
282 range: Range<I>,
283 window: &mut Window,
284 cx: &mut Context<Editor>,
285 ) {
286 let snapshot = &editor.buffer().read(cx).snapshot(cx);
287 let range = range.start.to_offset(snapshot)..range.end.to_offset(snapshot);
288
289 editor.unfold_ranges(&[range.start..range.end], true, false, cx);
290 editor.change_selections(Default::default(), window, cx, |s| {
291 s.select_ranges([range.start..range.start]);
292 });
293 window.focus(&editor.focus_handle(cx));
294 }
295}