1use std::path::Path;
2use std::sync::Arc;
3use std::time::Duration;
4
5use anyhow::{Context as _, Result, anyhow};
6use dap::StackFrameId;
7use gpui::{
8 AnyElement, Entity, EventEmitter, FocusHandle, Focusable, MouseButton, ScrollStrategy,
9 Stateful, Subscription, Task, UniformListScrollHandle, WeakEntity, uniform_list,
10};
11
12use crate::StackTraceView;
13use language::PointUtf16;
14use project::debugger::breakpoint_store::ActiveStackFrame;
15use project::debugger::session::{Session, SessionEvent, StackFrame};
16use project::{ProjectItem, ProjectPath};
17use ui::{Scrollbar, ScrollbarState, Tooltip, prelude::*};
18use workspace::{ItemHandle, Workspace};
19
20use super::RunningState;
21
22#[derive(Debug)]
23pub enum StackFrameListEvent {
24 SelectedStackFrameChanged(StackFrameId),
25 BuiltEntries,
26}
27
28pub struct StackFrameList {
29 focus_handle: FocusHandle,
30 _subscription: Subscription,
31 session: Entity<Session>,
32 state: WeakEntity<RunningState>,
33 entries: Vec<StackFrameEntry>,
34 workspace: WeakEntity<Workspace>,
35 selected_ix: Option<usize>,
36 opened_stack_frame_id: Option<StackFrameId>,
37 scrollbar_state: ScrollbarState,
38 scroll_handle: UniformListScrollHandle,
39 _refresh_task: Task<()>,
40}
41
42#[derive(Debug, PartialEq, Eq)]
43pub enum StackFrameEntry {
44 Normal(dap::StackFrame),
45 Collapsed(Vec<dap::StackFrame>),
46}
47
48impl StackFrameList {
49 pub fn new(
50 workspace: WeakEntity<Workspace>,
51 session: Entity<Session>,
52 state: WeakEntity<RunningState>,
53 window: &mut Window,
54 cx: &mut Context<Self>,
55 ) -> Self {
56 let focus_handle = cx.focus_handle();
57 let scroll_handle = UniformListScrollHandle::new();
58
59 let _subscription =
60 cx.subscribe_in(&session, window, |this, _, event, window, cx| match event {
61 SessionEvent::Threads => {
62 this.schedule_refresh(false, window, cx);
63 }
64 SessionEvent::Stopped(..) | SessionEvent::StackTrace => {
65 this.schedule_refresh(true, window, cx);
66 }
67 _ => {}
68 });
69
70 let mut this = Self {
71 scrollbar_state: ScrollbarState::new(scroll_handle.clone()),
72 session,
73 workspace,
74 focus_handle,
75 state,
76 _subscription,
77 entries: Default::default(),
78 selected_ix: None,
79 opened_stack_frame_id: None,
80 scroll_handle,
81 _refresh_task: Task::ready(()),
82 };
83 this.schedule_refresh(true, window, cx);
84 this
85 }
86
87 #[cfg(test)]
88 pub(crate) fn entries(&self) -> &Vec<StackFrameEntry> {
89 &self.entries
90 }
91
92 pub(crate) fn flatten_entries(&self, show_collapsed: bool) -> Vec<dap::StackFrame> {
93 self.entries
94 .iter()
95 .flat_map(|frame| match frame {
96 StackFrameEntry::Normal(frame) => vec![frame.clone()],
97 StackFrameEntry::Collapsed(frames) => {
98 if show_collapsed {
99 frames.clone()
100 } else {
101 vec![]
102 }
103 }
104 })
105 .collect::<Vec<_>>()
106 }
107
108 fn stack_frames(&self, cx: &mut App) -> Vec<StackFrame> {
109 self.state
110 .read_with(cx, |state, _| state.thread_id)
111 .ok()
112 .flatten()
113 .map(|thread_id| {
114 self.session
115 .update(cx, |this, cx| this.stack_frames(thread_id, cx))
116 })
117 .unwrap_or_default()
118 }
119
120 #[cfg(test)]
121 pub(crate) fn dap_stack_frames(&self, cx: &mut App) -> Vec<dap::StackFrame> {
122 self.stack_frames(cx)
123 .into_iter()
124 .map(|stack_frame| stack_frame.dap.clone())
125 .collect()
126 }
127
128 pub fn opened_stack_frame_id(&self) -> Option<StackFrameId> {
129 self.opened_stack_frame_id
130 }
131
132 pub(super) fn schedule_refresh(
133 &mut self,
134 select_first: bool,
135 window: &mut Window,
136 cx: &mut Context<Self>,
137 ) {
138 const REFRESH_DEBOUNCE: Duration = Duration::from_millis(20);
139
140 self._refresh_task = cx.spawn_in(window, async move |this, cx| {
141 let debounce = this
142 .update(cx, |this, cx| {
143 let new_stack_frames = this.stack_frames(cx);
144 new_stack_frames.is_empty() && !this.entries.is_empty()
145 })
146 .ok()
147 .unwrap_or_default();
148
149 if debounce {
150 cx.background_executor().timer(REFRESH_DEBOUNCE).await;
151 }
152 this.update_in(cx, |this, window, cx| {
153 this.build_entries(select_first, window, cx);
154 cx.notify();
155 })
156 .ok();
157 })
158 }
159
160 pub fn build_entries(
161 &mut self,
162 open_first_stack_frame: bool,
163 window: &mut Window,
164 cx: &mut Context<Self>,
165 ) {
166 let old_selected_frame_id = self
167 .selected_ix
168 .and_then(|ix| self.entries.get(ix))
169 .and_then(|entry| match entry {
170 StackFrameEntry::Normal(stack_frame) => Some(stack_frame.id),
171 StackFrameEntry::Collapsed(stack_frames) => {
172 stack_frames.first().map(|stack_frame| stack_frame.id)
173 }
174 });
175 let mut entries = Vec::new();
176 let mut collapsed_entries = Vec::new();
177 let mut first_stack_frame = None;
178
179 let stack_frames = self.stack_frames(cx);
180 for stack_frame in &stack_frames {
181 match stack_frame.dap.presentation_hint {
182 Some(dap::StackFramePresentationHint::Deemphasize) => {
183 collapsed_entries.push(stack_frame.dap.clone());
184 }
185 _ => {
186 let collapsed_entries = std::mem::take(&mut collapsed_entries);
187 if !collapsed_entries.is_empty() {
188 entries.push(StackFrameEntry::Collapsed(collapsed_entries.clone()));
189 }
190
191 first_stack_frame.get_or_insert(entries.len());
192 entries.push(StackFrameEntry::Normal(stack_frame.dap.clone()));
193 }
194 }
195 }
196
197 let collapsed_entries = std::mem::take(&mut collapsed_entries);
198 if !collapsed_entries.is_empty() {
199 entries.push(StackFrameEntry::Collapsed(collapsed_entries.clone()));
200 }
201
202 std::mem::swap(&mut self.entries, &mut entries);
203
204 if let Some(ix) = first_stack_frame.filter(|_| open_first_stack_frame) {
205 self.select_ix(Some(ix), cx);
206 self.activate_selected_entry(window, cx);
207 } else if let Some(old_selected_frame_id) = old_selected_frame_id {
208 let ix = self.entries.iter().position(|entry| match entry {
209 StackFrameEntry::Normal(frame) => frame.id == old_selected_frame_id,
210 StackFrameEntry::Collapsed(frames) => {
211 frames.iter().any(|frame| frame.id == old_selected_frame_id)
212 }
213 });
214 self.selected_ix = ix;
215 }
216
217 cx.emit(StackFrameListEvent::BuiltEntries);
218 cx.notify();
219 }
220
221 pub fn go_to_stack_frame(
222 &mut self,
223 stack_frame_id: StackFrameId,
224 window: &mut Window,
225 cx: &mut Context<Self>,
226 ) -> Task<Result<()>> {
227 let Some(stack_frame) = self
228 .entries
229 .iter()
230 .flat_map(|entry| match entry {
231 StackFrameEntry::Normal(stack_frame) => std::slice::from_ref(stack_frame),
232 StackFrameEntry::Collapsed(stack_frames) => stack_frames.as_slice(),
233 })
234 .find(|stack_frame| stack_frame.id == stack_frame_id)
235 .cloned()
236 else {
237 return Task::ready(Err(anyhow!("No stack frame for ID")));
238 };
239 self.go_to_stack_frame_inner(stack_frame, window, cx)
240 }
241
242 fn go_to_stack_frame_inner(
243 &mut self,
244 stack_frame: dap::StackFrame,
245 window: &mut Window,
246 cx: &mut Context<Self>,
247 ) -> Task<Result<()>> {
248 let stack_frame_id = stack_frame.id;
249 self.opened_stack_frame_id = Some(stack_frame_id);
250 let Some(abs_path) = Self::abs_path_from_stack_frame(&stack_frame) else {
251 return Task::ready(Err(anyhow!("Project path not found")));
252 };
253 let row = stack_frame.line.saturating_sub(1) as u32;
254 cx.emit(StackFrameListEvent::SelectedStackFrameChanged(
255 stack_frame_id,
256 ));
257 cx.spawn_in(window, async move |this, cx| {
258 let (worktree, relative_path) = this
259 .update(cx, |this, cx| {
260 this.workspace.update(cx, |workspace, cx| {
261 workspace.project().update(cx, |this, cx| {
262 this.find_or_create_worktree(&abs_path, false, cx)
263 })
264 })
265 })??
266 .await?;
267 let buffer = this
268 .update(cx, |this, cx| {
269 this.workspace.update(cx, |this, cx| {
270 this.project().update(cx, |this, cx| {
271 let worktree_id = worktree.read(cx).id();
272 this.open_buffer(
273 ProjectPath {
274 worktree_id,
275 path: relative_path.into(),
276 },
277 cx,
278 )
279 })
280 })
281 })??
282 .await?;
283 let position = buffer.read_with(cx, |this, _| {
284 this.snapshot().anchor_after(PointUtf16::new(row, 0))
285 })?;
286 this.update_in(cx, |this, window, cx| {
287 this.workspace.update(cx, |workspace, cx| {
288 let project_path = buffer
289 .read(cx)
290 .project_path(cx)
291 .context("Could not select a stack frame for unnamed buffer")?;
292
293 let open_preview = !workspace
294 .item_of_type::<StackTraceView>(cx)
295 .map(|viewer| {
296 workspace
297 .active_item(cx)
298 .is_some_and(|item| item.item_id() == viewer.item_id())
299 })
300 .unwrap_or_default();
301
302 anyhow::Ok(workspace.open_path_preview(
303 project_path,
304 None,
305 true,
306 true,
307 open_preview,
308 window,
309 cx,
310 ))
311 })
312 })???
313 .await?;
314
315 this.update(cx, |this, cx| {
316 let thread_id = this.state.read_with(cx, |state, _| {
317 state.thread_id.context("No selected thread ID found")
318 })??;
319
320 this.workspace.update(cx, |workspace, cx| {
321 let breakpoint_store = workspace.project().read(cx).breakpoint_store();
322
323 breakpoint_store.update(cx, |store, cx| {
324 store.set_active_position(
325 ActiveStackFrame {
326 session_id: this.session.read(cx).session_id(),
327 thread_id,
328 stack_frame_id,
329 path: abs_path,
330 position,
331 },
332 cx,
333 );
334 })
335 })
336 })?
337 })
338 }
339
340 pub(crate) fn abs_path_from_stack_frame(stack_frame: &dap::StackFrame) -> Option<Arc<Path>> {
341 stack_frame.source.as_ref().and_then(|s| {
342 s.path
343 .as_deref()
344 .map(|path| Arc::<Path>::from(Path::new(path)))
345 .filter(|path| path.is_absolute())
346 })
347 }
348
349 pub fn restart_stack_frame(&mut self, stack_frame_id: u64, cx: &mut Context<Self>) {
350 self.session.update(cx, |state, cx| {
351 state.restart_stack_frame(stack_frame_id, cx)
352 });
353 }
354
355 fn render_normal_entry(
356 &self,
357 ix: usize,
358 stack_frame: &dap::StackFrame,
359 cx: &mut Context<Self>,
360 ) -> AnyElement {
361 let source = stack_frame.source.clone();
362 let is_selected_frame = Some(ix) == self.selected_ix;
363
364 let path = source.clone().and_then(|s| s.path.or(s.name));
365 let formatted_path = path.map(|path| format!("{}:{}", path, stack_frame.line,));
366 let formatted_path = formatted_path.map(|path| {
367 Label::new(path)
368 .size(LabelSize::XSmall)
369 .line_height_style(LineHeightStyle::UiLabel)
370 .truncate()
371 .color(Color::Muted)
372 });
373
374 let supports_frame_restart = self
375 .session
376 .read(cx)
377 .capabilities()
378 .supports_restart_frame
379 .unwrap_or_default();
380
381 let should_deemphasize = matches!(
382 stack_frame.presentation_hint,
383 Some(
384 dap::StackFramePresentationHint::Subtle
385 | dap::StackFramePresentationHint::Deemphasize
386 )
387 );
388 h_flex()
389 .rounded_md()
390 .justify_between()
391 .w_full()
392 .group("")
393 .id(("stack-frame", stack_frame.id))
394 .p_1()
395 .when(is_selected_frame, |this| {
396 this.bg(cx.theme().colors().element_hover)
397 })
398 .on_any_mouse_down(|_, _, cx| {
399 cx.stop_propagation();
400 })
401 .on_click(cx.listener(move |this, _, window, cx| {
402 this.selected_ix = Some(ix);
403 this.activate_selected_entry(window, cx);
404 }))
405 .hover(|style| style.bg(cx.theme().colors().element_hover).cursor_pointer())
406 .child(
407 v_flex()
408 .gap_0p5()
409 .child(
410 Label::new(stack_frame.name.clone())
411 .size(LabelSize::Small)
412 .truncate()
413 .when(should_deemphasize, |this| this.color(Color::Muted)),
414 )
415 .children(formatted_path),
416 )
417 .when(
418 supports_frame_restart && stack_frame.can_restart.unwrap_or(true),
419 |this| {
420 this.child(
421 h_flex()
422 .id(("restart-stack-frame", stack_frame.id))
423 .visible_on_hover("")
424 .absolute()
425 .right_2()
426 .overflow_hidden()
427 .rounded_md()
428 .border_1()
429 .border_color(cx.theme().colors().element_selected)
430 .bg(cx.theme().colors().element_background)
431 .hover(|style| {
432 style
433 .bg(cx.theme().colors().ghost_element_hover)
434 .cursor_pointer()
435 })
436 .child(
437 IconButton::new(
438 ("restart-stack-frame", stack_frame.id),
439 IconName::DebugRestart,
440 )
441 .icon_size(IconSize::Small)
442 .on_click(cx.listener({
443 let stack_frame_id = stack_frame.id;
444 move |this, _, _window, cx| {
445 this.restart_stack_frame(stack_frame_id, cx);
446 }
447 }))
448 .tooltip(move |window, cx| {
449 Tooltip::text("Restart Stack Frame")(window, cx)
450 }),
451 ),
452 )
453 },
454 )
455 .into_any()
456 }
457
458 pub(crate) fn expand_collapsed_entry(&mut self, ix: usize) {
459 let Some(StackFrameEntry::Collapsed(stack_frames)) = self.entries.get_mut(ix) else {
460 return;
461 };
462 let entries = std::mem::take(stack_frames)
463 .into_iter()
464 .map(StackFrameEntry::Normal);
465 self.entries.splice(ix..ix + 1, entries);
466 self.selected_ix = Some(ix);
467 }
468
469 fn render_collapsed_entry(
470 &self,
471 ix: usize,
472 stack_frames: &Vec<dap::StackFrame>,
473 cx: &mut Context<Self>,
474 ) -> AnyElement {
475 let first_stack_frame = &stack_frames[0];
476 let is_selected = Some(ix) == self.selected_ix;
477
478 h_flex()
479 .rounded_md()
480 .justify_between()
481 .w_full()
482 .group("")
483 .id(("stack-frame", first_stack_frame.id))
484 .p_1()
485 .when(is_selected, |this| {
486 this.bg(cx.theme().colors().element_hover)
487 })
488 .on_any_mouse_down(|_, _, cx| {
489 cx.stop_propagation();
490 })
491 .on_click(cx.listener(move |this, _, window, cx| {
492 this.selected_ix = Some(ix);
493 this.activate_selected_entry(window, cx);
494 }))
495 .hover(|style| style.bg(cx.theme().colors().element_hover).cursor_pointer())
496 .child(
497 v_flex()
498 .text_ui_sm(cx)
499 .truncate()
500 .text_color(cx.theme().colors().text_muted)
501 .child(format!(
502 "Show {} more{}",
503 stack_frames.len(),
504 first_stack_frame
505 .source
506 .as_ref()
507 .and_then(|source| source.origin.as_ref())
508 .map_or(String::new(), |origin| format!(": {}", origin))
509 )),
510 )
511 .into_any()
512 }
513
514 fn render_entry(&self, ix: usize, cx: &mut Context<Self>) -> AnyElement {
515 match &self.entries[ix] {
516 StackFrameEntry::Normal(stack_frame) => self.render_normal_entry(ix, stack_frame, cx),
517 StackFrameEntry::Collapsed(stack_frames) => {
518 self.render_collapsed_entry(ix, stack_frames, cx)
519 }
520 }
521 }
522
523 fn render_vertical_scrollbar(&self, cx: &mut Context<Self>) -> Stateful<Div> {
524 div()
525 .occlude()
526 .id("stack-frame-list-vertical-scrollbar")
527 .on_mouse_move(cx.listener(|_, _, _, cx| {
528 cx.notify();
529 cx.stop_propagation()
530 }))
531 .on_hover(|_, _, cx| {
532 cx.stop_propagation();
533 })
534 .on_any_mouse_down(|_, _, cx| {
535 cx.stop_propagation();
536 })
537 .on_mouse_up(
538 MouseButton::Left,
539 cx.listener(|_, _, _, cx| {
540 cx.stop_propagation();
541 }),
542 )
543 .on_scroll_wheel(cx.listener(|_, _, _, cx| {
544 cx.notify();
545 }))
546 .h_full()
547 .absolute()
548 .right_1()
549 .top_1()
550 .bottom_0()
551 .w(px(12.))
552 .cursor_default()
553 .children(Scrollbar::vertical(self.scrollbar_state.clone()))
554 }
555
556 fn select_ix(&mut self, ix: Option<usize>, cx: &mut Context<Self>) {
557 self.selected_ix = ix;
558 if let Some(ix) = self.selected_ix {
559 self.scroll_handle
560 .scroll_to_item(ix, ScrollStrategy::Center);
561 }
562 cx.notify();
563 }
564
565 fn select_next(&mut self, _: &menu::SelectNext, _window: &mut Window, cx: &mut Context<Self>) {
566 let ix = match self.selected_ix {
567 _ if self.entries.len() == 0 => None,
568 None => Some(0),
569 Some(ix) => {
570 if ix == self.entries.len() - 1 {
571 Some(0)
572 } else {
573 Some(ix + 1)
574 }
575 }
576 };
577 self.select_ix(ix, cx);
578 }
579
580 fn select_previous(
581 &mut self,
582 _: &menu::SelectPrevious,
583 _window: &mut Window,
584 cx: &mut Context<Self>,
585 ) {
586 let ix = match self.selected_ix {
587 _ if self.entries.len() == 0 => None,
588 None => Some(self.entries.len() - 1),
589 Some(ix) => {
590 if ix == 0 {
591 Some(self.entries.len() - 1)
592 } else {
593 Some(ix - 1)
594 }
595 }
596 };
597 self.select_ix(ix, cx);
598 }
599
600 fn select_first(
601 &mut self,
602 _: &menu::SelectFirst,
603 _window: &mut Window,
604 cx: &mut Context<Self>,
605 ) {
606 let ix = if self.entries.len() > 0 {
607 Some(0)
608 } else {
609 None
610 };
611 self.select_ix(ix, cx);
612 }
613
614 fn select_last(&mut self, _: &menu::SelectLast, _window: &mut Window, cx: &mut Context<Self>) {
615 let ix = if self.entries.len() > 0 {
616 Some(self.entries.len() - 1)
617 } else {
618 None
619 };
620 self.select_ix(ix, cx);
621 }
622
623 fn activate_selected_entry(&mut self, window: &mut Window, cx: &mut Context<Self>) {
624 let Some(ix) = self.selected_ix else {
625 return;
626 };
627 let Some(entry) = self.entries.get_mut(ix) else {
628 return;
629 };
630 match entry {
631 StackFrameEntry::Normal(stack_frame) => {
632 let stack_frame = stack_frame.clone();
633 self.go_to_stack_frame_inner(stack_frame, window, cx)
634 .detach_and_log_err(cx)
635 }
636 StackFrameEntry::Collapsed(_) => self.expand_collapsed_entry(ix),
637 }
638 cx.notify();
639 }
640
641 fn confirm(&mut self, _: &menu::Confirm, window: &mut Window, cx: &mut Context<Self>) {
642 self.activate_selected_entry(window, cx);
643 }
644
645 fn render_list(&mut self, _window: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
646 uniform_list(
647 cx.entity(),
648 "stack-frame-list",
649 self.entries.len(),
650 |this, range, _window, cx| range.map(|ix| this.render_entry(ix, cx)).collect(),
651 )
652 .track_scroll(self.scroll_handle.clone())
653 .size_full()
654 }
655}
656
657impl Render for StackFrameList {
658 fn render(&mut self, window: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
659 div()
660 .track_focus(&self.focus_handle)
661 .size_full()
662 .p_1()
663 .on_action(cx.listener(Self::select_next))
664 .on_action(cx.listener(Self::select_previous))
665 .on_action(cx.listener(Self::select_first))
666 .on_action(cx.listener(Self::select_last))
667 .on_action(cx.listener(Self::confirm))
668 .child(self.render_list(window, cx))
669 .child(self.render_vertical_scrollbar(cx))
670 }
671}
672
673impl Focusable for StackFrameList {
674 fn focus_handle(&self, _: &gpui::App) -> gpui::FocusHandle {
675 self.focus_handle.clone()
676 }
677}
678
679impl EventEmitter<StackFrameListEvent> for StackFrameList {}