1use std::path::Path;
2use std::sync::Arc;
3use std::time::Duration;
4
5use anyhow::{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.update(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.read(cx).project_path(cx).ok_or_else(|| {
289 anyhow!("Could not select a stack frame for unnamed buffer")
290 })?;
291
292 let open_preview = !workspace
293 .item_of_type::<StackTraceView>(cx)
294 .map(|viewer| {
295 workspace
296 .active_item(cx)
297 .is_some_and(|item| item.item_id() == viewer.item_id())
298 })
299 .unwrap_or_default();
300
301 anyhow::Ok(workspace.open_path_preview(
302 project_path,
303 None,
304 true,
305 true,
306 open_preview,
307 window,
308 cx,
309 ))
310 })
311 })???
312 .await?;
313
314 this.update(cx, |this, cx| {
315 let Some(thread_id) = this.state.read_with(cx, |state, _| state.thread_id)? else {
316 return Err(anyhow!("No selected thread ID found"));
317 };
318
319 this.workspace.update(cx, |workspace, cx| {
320 let breakpoint_store = workspace.project().read(cx).breakpoint_store();
321
322 breakpoint_store.update(cx, |store, cx| {
323 store.set_active_position(
324 ActiveStackFrame {
325 session_id: this.session.read(cx).session_id(),
326 thread_id,
327 stack_frame_id,
328 path: abs_path,
329 position,
330 },
331 cx,
332 );
333 })
334 })
335 })?
336 })
337 }
338
339 pub(crate) fn abs_path_from_stack_frame(stack_frame: &dap::StackFrame) -> Option<Arc<Path>> {
340 stack_frame.source.as_ref().and_then(|s| {
341 s.path
342 .as_deref()
343 .map(|path| Arc::<Path>::from(Path::new(path)))
344 })
345 }
346
347 pub fn restart_stack_frame(&mut self, stack_frame_id: u64, cx: &mut Context<Self>) {
348 self.session.update(cx, |state, cx| {
349 state.restart_stack_frame(stack_frame_id, cx)
350 });
351 }
352
353 fn render_normal_entry(
354 &self,
355 ix: usize,
356 stack_frame: &dap::StackFrame,
357 cx: &mut Context<Self>,
358 ) -> AnyElement {
359 let source = stack_frame.source.clone();
360 let is_selected_frame = Some(ix) == self.selected_ix;
361
362 let path = source.clone().and_then(|s| s.path.or(s.name));
363 let formatted_path = path.map(|path| format!("{}:{}", path, stack_frame.line,));
364 let formatted_path = formatted_path.map(|path| {
365 Label::new(path)
366 .size(LabelSize::XSmall)
367 .line_height_style(LineHeightStyle::UiLabel)
368 .truncate()
369 .color(Color::Muted)
370 });
371
372 let supports_frame_restart = self
373 .session
374 .read(cx)
375 .capabilities()
376 .supports_restart_frame
377 .unwrap_or_default();
378
379 let should_deemphasize = matches!(
380 stack_frame.presentation_hint,
381 Some(
382 dap::StackFramePresentationHint::Subtle
383 | dap::StackFramePresentationHint::Deemphasize
384 )
385 );
386 h_flex()
387 .rounded_md()
388 .justify_between()
389 .w_full()
390 .group("")
391 .id(("stack-frame", stack_frame.id))
392 .p_1()
393 .when(is_selected_frame, |this| {
394 this.bg(cx.theme().colors().element_hover)
395 })
396 .on_any_mouse_down(|_, _, cx| {
397 cx.stop_propagation();
398 })
399 .on_click(cx.listener(move |this, _, window, cx| {
400 this.selected_ix = Some(ix);
401 this.activate_selected_entry(window, cx);
402 }))
403 .hover(|style| style.bg(cx.theme().colors().element_hover).cursor_pointer())
404 .child(
405 v_flex()
406 .gap_0p5()
407 .child(
408 Label::new(stack_frame.name.clone())
409 .size(LabelSize::Small)
410 .truncate()
411 .when(should_deemphasize, |this| this.color(Color::Muted)),
412 )
413 .children(formatted_path),
414 )
415 .when(
416 supports_frame_restart && stack_frame.can_restart.unwrap_or(true),
417 |this| {
418 this.child(
419 h_flex()
420 .id(("restart-stack-frame", stack_frame.id))
421 .visible_on_hover("")
422 .absolute()
423 .right_2()
424 .overflow_hidden()
425 .rounded_md()
426 .border_1()
427 .border_color(cx.theme().colors().element_selected)
428 .bg(cx.theme().colors().element_background)
429 .hover(|style| {
430 style
431 .bg(cx.theme().colors().ghost_element_hover)
432 .cursor_pointer()
433 })
434 .child(
435 IconButton::new(
436 ("restart-stack-frame", stack_frame.id),
437 IconName::DebugRestart,
438 )
439 .icon_size(IconSize::Small)
440 .on_click(cx.listener({
441 let stack_frame_id = stack_frame.id;
442 move |this, _, _window, cx| {
443 this.restart_stack_frame(stack_frame_id, cx);
444 }
445 }))
446 .tooltip(move |window, cx| {
447 Tooltip::text("Restart Stack Frame")(window, cx)
448 }),
449 ),
450 )
451 },
452 )
453 .into_any()
454 }
455
456 pub(crate) fn expand_collapsed_entry(&mut self, ix: usize) {
457 let Some(StackFrameEntry::Collapsed(stack_frames)) = self.entries.get_mut(ix) else {
458 return;
459 };
460 let entries = std::mem::take(stack_frames)
461 .into_iter()
462 .map(StackFrameEntry::Normal);
463 self.entries.splice(ix..ix + 1, entries);
464 self.selected_ix = Some(ix);
465 }
466
467 fn render_collapsed_entry(
468 &self,
469 ix: usize,
470 stack_frames: &Vec<dap::StackFrame>,
471 cx: &mut Context<Self>,
472 ) -> AnyElement {
473 let first_stack_frame = &stack_frames[0];
474 let is_selected = Some(ix) == self.selected_ix;
475
476 h_flex()
477 .rounded_md()
478 .justify_between()
479 .w_full()
480 .group("")
481 .id(("stack-frame", first_stack_frame.id))
482 .p_1()
483 .when(is_selected, |this| {
484 this.bg(cx.theme().colors().element_hover)
485 })
486 .on_any_mouse_down(|_, _, cx| {
487 cx.stop_propagation();
488 })
489 .on_click(cx.listener(move |this, _, window, cx| {
490 this.selected_ix = Some(ix);
491 this.activate_selected_entry(window, cx);
492 }))
493 .hover(|style| style.bg(cx.theme().colors().element_hover).cursor_pointer())
494 .child(
495 v_flex()
496 .text_ui_sm(cx)
497 .truncate()
498 .text_color(cx.theme().colors().text_muted)
499 .child(format!(
500 "Show {} more{}",
501 stack_frames.len(),
502 first_stack_frame
503 .source
504 .as_ref()
505 .and_then(|source| source.origin.as_ref())
506 .map_or(String::new(), |origin| format!(": {}", origin))
507 )),
508 )
509 .into_any()
510 }
511
512 fn render_entry(&self, ix: usize, cx: &mut Context<Self>) -> AnyElement {
513 match &self.entries[ix] {
514 StackFrameEntry::Normal(stack_frame) => self.render_normal_entry(ix, stack_frame, cx),
515 StackFrameEntry::Collapsed(stack_frames) => {
516 self.render_collapsed_entry(ix, stack_frames, cx)
517 }
518 }
519 }
520
521 fn render_vertical_scrollbar(&self, cx: &mut Context<Self>) -> Stateful<Div> {
522 div()
523 .occlude()
524 .id("stack-frame-list-vertical-scrollbar")
525 .on_mouse_move(cx.listener(|_, _, _, cx| {
526 cx.notify();
527 cx.stop_propagation()
528 }))
529 .on_hover(|_, _, cx| {
530 cx.stop_propagation();
531 })
532 .on_any_mouse_down(|_, _, cx| {
533 cx.stop_propagation();
534 })
535 .on_mouse_up(
536 MouseButton::Left,
537 cx.listener(|_, _, _, cx| {
538 cx.stop_propagation();
539 }),
540 )
541 .on_scroll_wheel(cx.listener(|_, _, _, cx| {
542 cx.notify();
543 }))
544 .h_full()
545 .absolute()
546 .right_1()
547 .top_1()
548 .bottom_0()
549 .w(px(12.))
550 .cursor_default()
551 .children(Scrollbar::vertical(self.scrollbar_state.clone()))
552 }
553
554 fn select_ix(&mut self, ix: Option<usize>, cx: &mut Context<Self>) {
555 self.selected_ix = ix;
556 if let Some(ix) = self.selected_ix {
557 self.scroll_handle
558 .scroll_to_item(ix, ScrollStrategy::Center);
559 }
560 cx.notify();
561 }
562
563 fn select_next(&mut self, _: &menu::SelectNext, _window: &mut Window, cx: &mut Context<Self>) {
564 let ix = match self.selected_ix {
565 _ if self.entries.len() == 0 => None,
566 None => Some(0),
567 Some(ix) => {
568 if ix == self.entries.len() - 1 {
569 Some(0)
570 } else {
571 Some(ix + 1)
572 }
573 }
574 };
575 self.select_ix(ix, cx);
576 }
577
578 fn select_previous(
579 &mut self,
580 _: &menu::SelectPrevious,
581 _window: &mut Window,
582 cx: &mut Context<Self>,
583 ) {
584 let ix = match self.selected_ix {
585 _ if self.entries.len() == 0 => None,
586 None => Some(self.entries.len() - 1),
587 Some(ix) => {
588 if ix == 0 {
589 Some(self.entries.len() - 1)
590 } else {
591 Some(ix - 1)
592 }
593 }
594 };
595 self.select_ix(ix, cx);
596 }
597
598 fn select_first(
599 &mut self,
600 _: &menu::SelectFirst,
601 _window: &mut Window,
602 cx: &mut Context<Self>,
603 ) {
604 let ix = if self.entries.len() > 0 {
605 Some(0)
606 } else {
607 None
608 };
609 self.select_ix(ix, cx);
610 }
611
612 fn select_last(&mut self, _: &menu::SelectLast, _window: &mut Window, cx: &mut Context<Self>) {
613 let ix = if self.entries.len() > 0 {
614 Some(self.entries.len() - 1)
615 } else {
616 None
617 };
618 self.select_ix(ix, cx);
619 }
620
621 fn activate_selected_entry(&mut self, window: &mut Window, cx: &mut Context<Self>) {
622 let Some(ix) = self.selected_ix else {
623 return;
624 };
625 let Some(entry) = self.entries.get_mut(ix) else {
626 return;
627 };
628 match entry {
629 StackFrameEntry::Normal(stack_frame) => {
630 let stack_frame = stack_frame.clone();
631 self.go_to_stack_frame_inner(stack_frame, window, cx)
632 .detach_and_log_err(cx)
633 }
634 StackFrameEntry::Collapsed(_) => self.expand_collapsed_entry(ix),
635 }
636 cx.notify();
637 }
638
639 fn confirm(&mut self, _: &menu::Confirm, window: &mut Window, cx: &mut Context<Self>) {
640 self.activate_selected_entry(window, cx);
641 }
642
643 fn render_list(&mut self, _window: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
644 uniform_list(
645 cx.entity(),
646 "stack-frame-list",
647 self.entries.len(),
648 |this, range, _window, cx| range.map(|ix| this.render_entry(ix, cx)).collect(),
649 )
650 .track_scroll(self.scroll_handle.clone())
651 .size_full()
652 }
653}
654
655impl Render for StackFrameList {
656 fn render(&mut self, window: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
657 div()
658 .track_focus(&self.focus_handle)
659 .size_full()
660 .p_1()
661 .on_action(cx.listener(Self::select_next))
662 .on_action(cx.listener(Self::select_previous))
663 .on_action(cx.listener(Self::select_first))
664 .on_action(cx.listener(Self::select_last))
665 .on_action(cx.listener(Self::confirm))
666 .child(self.render_list(window, cx))
667 .child(self.render_vertical_scrollbar(cx))
668 }
669}
670
671impl Focusable for StackFrameList {
672 fn focus_handle(&self, _: &gpui::App) -> gpui::FocusHandle {
673 self.focus_handle.clone()
674 }
675}
676
677impl EventEmitter<StackFrameListEvent> for StackFrameList {}