use crate::{ ClearAllBreakpoints, Continue, CreateDebuggingSession, Disconnect, Pause, Restart, StepBack, StepInto, StepOut, StepOver, Stop, ToggleIgnoreBreakpoints, }; use crate::{new_session_modal::NewSessionModal, session::DebugSession}; use anyhow::{Result, anyhow}; use collections::HashMap; use command_palette_hooks::CommandPaletteFilter; use dap::{ ContinuedEvent, LoadedSourceEvent, ModuleEvent, OutputEvent, StoppedEvent, ThreadEvent, client::SessionId, debugger_settings::DebuggerSettings, }; use futures::{SinkExt as _, channel::mpsc}; use gpui::{ Action, App, AsyncWindowContext, Context, Entity, EventEmitter, FocusHandle, Focusable, Subscription, Task, WeakEntity, actions, }; use project::{ Project, debugger::{ dap_store::{self, DapStore}, session::ThreadStatus, }, terminals::TerminalKind, }; use rpc::proto::{self}; use settings::Settings; use std::{any::TypeId, path::PathBuf}; use task::DebugTaskDefinition; use terminal_view::terminal_panel::TerminalPanel; use ui::{ContextMenu, Divider, DropdownMenu, Tooltip, prelude::*}; use workspace::{ Pane, Workspace, dock::{DockPosition, Panel, PanelEvent}, pane, }; pub enum DebugPanelEvent { Exited(SessionId), Terminated(SessionId), Stopped { client_id: SessionId, event: StoppedEvent, go_to_stack_frame: bool, }, Thread((SessionId, ThreadEvent)), Continued((SessionId, ContinuedEvent)), Output((SessionId, OutputEvent)), Module((SessionId, ModuleEvent)), LoadedSource((SessionId, LoadedSourceEvent)), ClientShutdown(SessionId), CapabilitiesChanged(SessionId), } actions!(debug_panel, [ToggleFocus]); pub struct DebugPanel { size: Pixels, pane: Entity, /// This represents the last debug definition that was created in the new session modal pub(crate) past_debug_definition: Option, project: WeakEntity, workspace: WeakEntity, _subscriptions: Vec, } impl DebugPanel { pub fn new( workspace: &Workspace, window: &mut Window, cx: &mut Context, ) -> Entity { cx.new(|cx| { let project = workspace.project().clone(); let dap_store = project.read(cx).dap_store(); let pane = cx.new(|cx| { let mut pane = Pane::new( workspace.weak_handle(), project.clone(), Default::default(), None, gpui::NoAction.boxed_clone(), window, cx, ); pane.set_can_split(None); pane.set_can_navigate(true, cx); pane.display_nav_history_buttons(None); pane.set_should_display_tab_bar(|_window, _cx| false); pane.set_close_pane_if_empty(true, cx); pane }); let _subscriptions = vec![ cx.observe(&pane, |_, _, cx| cx.notify()), cx.subscribe_in(&pane, window, Self::handle_pane_event), cx.subscribe_in(&dap_store, window, Self::handle_dap_store_event), ]; let debug_panel = Self { pane, size: px(300.), _subscriptions, past_debug_definition: None, project: project.downgrade(), workspace: workspace.weak_handle(), }; debug_panel }) } pub fn load( workspace: WeakEntity, cx: AsyncWindowContext, ) -> Task>> { cx.spawn(async move |cx| { workspace.update_in(cx, |workspace, window, cx| { let debug_panel = DebugPanel::new(workspace, window, cx); workspace.register_action(|workspace, _: &ClearAllBreakpoints, _, cx| { workspace.project().read(cx).breakpoint_store().update( cx, |breakpoint_store, cx| { breakpoint_store.clear_breakpoints(cx); }, ) }); cx.observe(&debug_panel, |_, debug_panel, cx| { let (has_active_session, supports_restart, support_step_back) = debug_panel .update(cx, |this, cx| { this.active_session(cx) .map(|item| { let running = item.read(cx).mode().as_running().cloned(); match running { Some(running) => { let caps = running.read(cx).capabilities(cx); ( true, caps.supports_restart_request.unwrap_or_default(), caps.supports_step_back.unwrap_or_default(), ) } None => (false, false, false), } }) .unwrap_or((false, false, false)) }); let filter = CommandPaletteFilter::global_mut(cx); let debugger_action_types = [ TypeId::of::(), TypeId::of::(), TypeId::of::(), TypeId::of::(), TypeId::of::(), TypeId::of::(), TypeId::of::(), TypeId::of::(), ]; let step_back_action_type = [TypeId::of::()]; let restart_action_type = [TypeId::of::()]; if has_active_session { filter.show_action_types(debugger_action_types.iter()); if supports_restart { filter.show_action_types(restart_action_type.iter()); } else { filter.hide_action_types(&restart_action_type); } if support_step_back { filter.show_action_types(step_back_action_type.iter()); } else { filter.hide_action_types(&step_back_action_type); } } else { // show only the `debug: start` filter.hide_action_types(&debugger_action_types); filter.hide_action_types(&step_back_action_type); filter.hide_action_types(&restart_action_type); } }) .detach(); debug_panel }) }) } pub fn active_session(&self, cx: &App) -> Option> { self.pane .read(cx) .active_item() .and_then(|panel| panel.downcast::()) } pub fn debug_panel_items_by_client( &self, client_id: &SessionId, cx: &Context, ) -> Vec> { self.pane .read(cx) .items() .filter_map(|item| item.downcast::()) .filter(|item| item.read(cx).session_id(cx) == Some(*client_id)) .map(|item| item.clone()) .collect() } pub fn debug_panel_item_by_client( &self, client_id: SessionId, cx: &mut Context, ) -> Option> { self.pane .read(cx) .items() .filter_map(|item| item.downcast::()) .find(|item| { let item = item.read(cx); item.session_id(cx) == Some(client_id) }) } fn handle_dap_store_event( &mut self, dap_store: &Entity, event: &dap_store::DapStoreEvent, window: &mut Window, cx: &mut Context, ) { match event { dap_store::DapStoreEvent::DebugSessionInitialized(session_id) => { let Some(session) = dap_store.read(cx).session_by_id(session_id) else { return log::error!( "Couldn't get session with id: {session_id:?} from DebugClientStarted event" ); }; let Some(project) = self.project.upgrade() else { return log::error!("Debug Panel out lived it's weak reference to Project"); }; if self.pane.read_with(cx, |pane, cx| { pane.items_of_type::() .any(|item| item.read(cx).session_id(cx) == Some(*session_id)) }) { // We already have an item for this session. return; } let session_item = DebugSession::running( project, self.workspace.clone(), session, cx.weak_entity(), window, cx, ); self.pane.update(cx, |pane, cx| { pane.add_item(Box::new(session_item), true, true, None, window, cx); window.focus(&pane.focus_handle(cx)); cx.notify(); }); } dap_store::DapStoreEvent::RunInTerminal { title, cwd, command, args, envs, sender, .. } => { self.handle_run_in_terminal_request( title.clone(), cwd.clone(), command.clone(), args.clone(), envs.clone(), sender.clone(), window, cx, ) .detach_and_log_err(cx); } _ => {} } } fn handle_run_in_terminal_request( &self, title: Option, cwd: PathBuf, command: Option, args: Vec, envs: HashMap, mut sender: mpsc::Sender>, window: &mut Window, cx: &mut App, ) -> Task> { let terminal_task = self.workspace.update(cx, |workspace, cx| { let terminal_panel = workspace.panel::(cx).ok_or_else(|| { anyhow!("RunInTerminal DAP request failed because TerminalPanel wasn't found") }); let terminal_panel = match terminal_panel { Ok(panel) => panel, Err(err) => return Task::ready(Err(err)), }; terminal_panel.update(cx, |terminal_panel, cx| { let terminal_task = terminal_panel.add_terminal( TerminalKind::Debug { command, args, envs, cwd, title, }, task::RevealStrategy::Always, window, cx, ); cx.spawn(async move |_, cx| { let pid_task = async move { let terminal = terminal_task.await?; terminal.read_with(cx, |terminal, _| terminal.pty_info.pid()) }; pid_task.await }) }) }); cx.background_spawn(async move { match terminal_task { Ok(pid_task) => match pid_task.await { Ok(Some(pid)) => sender.send(Ok(pid.as_u32())).await?, Ok(None) => { sender .send(Err(anyhow!( "Terminal was spawned but PID was not available" ))) .await? } Err(error) => sender.send(Err(anyhow!(error))).await?, }, Err(error) => sender.send(Err(anyhow!(error))).await?, }; Ok(()) }) } fn handle_pane_event( &mut self, _: &Entity, event: &pane::Event, window: &mut Window, cx: &mut Context, ) { match event { pane::Event::Remove { .. } => cx.emit(PanelEvent::Close), pane::Event::ZoomIn => cx.emit(PanelEvent::ZoomIn), pane::Event::ZoomOut => cx.emit(PanelEvent::ZoomOut), pane::Event::AddItem { item } => { self.workspace .update(cx, |workspace, cx| { item.added_to_pane(workspace, self.pane.clone(), window, cx) }) .ok(); } pane::Event::RemovedItem { item } => { if let Some(debug_session) = item.downcast::() { debug_session.update(cx, |session, cx| { session.shutdown(cx); }) } } pane::Event::ActivateItem { local: _, focus_changed, } => { if *focus_changed { if let Some(debug_session) = self .pane .read(cx) .active_item() .and_then(|item| item.downcast::()) { if let Some(running) = debug_session .read_with(cx, |session, _| session.mode().as_running().cloned()) { running.update(cx, |running, cx| { running.go_to_selected_stack_frame(window, cx); }); } } } } _ => {} } } fn top_controls_strip(&self, window: &mut Window, cx: &mut Context) -> Option
{ let active_session = self .pane .read(cx) .active_item() .and_then(|item| item.downcast::()); Some( h_flex() .border_b_1() .border_color(cx.theme().colors().border) .p_1() .justify_between() .w_full() .child( h_flex().gap_2().w_full().when_some( active_session .as_ref() .and_then(|session| session.read(cx).mode().as_running()), |this, running_session| { let thread_status = running_session .read(cx) .thread_status(cx) .unwrap_or(project::debugger::session::ThreadStatus::Exited); let capabilities = running_session.read(cx).capabilities(cx); this.map(|this| { if thread_status == ThreadStatus::Running { this.child( IconButton::new("debug-pause", IconName::DebugPause) .icon_size(IconSize::XSmall) .shape(ui::IconButtonShape::Square) .on_click(window.listener_for( &running_session, |this, _, _window, cx| { this.pause_thread(cx); }, )) .tooltip(move |window, cx| { Tooltip::text("Pause program")(window, cx) }), ) } else { this.child( IconButton::new("debug-continue", IconName::DebugContinue) .icon_size(IconSize::XSmall) .shape(ui::IconButtonShape::Square) .on_click(window.listener_for( &running_session, |this, _, _window, cx| this.continue_thread(cx), )) .disabled(thread_status != ThreadStatus::Stopped) .tooltip(move |window, cx| { Tooltip::text("Continue program")(window, cx) }), ) } }) .child( IconButton::new("debug-step-over", IconName::ArrowRight) .icon_size(IconSize::XSmall) .shape(ui::IconButtonShape::Square) .on_click(window.listener_for( &running_session, |this, _, _window, cx| { this.step_over(cx); }, )) .disabled(thread_status != ThreadStatus::Stopped) .tooltip(move |window, cx| { Tooltip::text("Step over")(window, cx) }), ) .child( IconButton::new("debug-step-out", IconName::ArrowUpRight) .icon_size(IconSize::XSmall) .shape(ui::IconButtonShape::Square) .on_click(window.listener_for( &running_session, |this, _, _window, cx| { this.step_out(cx); }, )) .disabled(thread_status != ThreadStatus::Stopped) .tooltip(move |window, cx| { Tooltip::text("Step out")(window, cx) }), ) .child( IconButton::new("debug-step-into", IconName::ArrowDownRight) .icon_size(IconSize::XSmall) .shape(ui::IconButtonShape::Square) .on_click(window.listener_for( &running_session, |this, _, _window, cx| { this.step_in(cx); }, )) .disabled(thread_status != ThreadStatus::Stopped) .tooltip(move |window, cx| { Tooltip::text("Step in")(window, cx) }), ) .child(Divider::vertical()) .child( IconButton::new( "debug-enable-breakpoint", IconName::DebugDisabledBreakpoint, ) .icon_size(IconSize::XSmall) .shape(ui::IconButtonShape::Square) .disabled(thread_status != ThreadStatus::Stopped), ) .child( IconButton::new("debug-disable-breakpoint", IconName::CircleOff) .icon_size(IconSize::XSmall) .shape(ui::IconButtonShape::Square) .disabled(thread_status != ThreadStatus::Stopped), ) .child( IconButton::new("debug-disable-all-breakpoints", IconName::BugOff) .icon_size(IconSize::XSmall) .shape(ui::IconButtonShape::Square) .disabled( thread_status == ThreadStatus::Exited || thread_status == ThreadStatus::Ended, ) .on_click(window.listener_for( &running_session, |this, _, _window, cx| { this.toggle_ignore_breakpoints(cx); }, )) .tooltip(move |window, cx| { Tooltip::text("Disable all breakpoints")(window, cx) }), ) .child(Divider::vertical()) .child( IconButton::new("debug-restart", IconName::DebugRestart) .icon_size(IconSize::XSmall) .on_click(window.listener_for( &running_session, |this, _, _window, cx| { this.restart_session(cx); }, )) .disabled( !capabilities.supports_restart_request.unwrap_or_default(), ) .tooltip(move |window, cx| { Tooltip::text("Restart")(window, cx) }), ) .child( IconButton::new("debug-stop", IconName::Power) .icon_size(IconSize::XSmall) .on_click(window.listener_for( &running_session, |this, _, _window, cx| { this.stop_thread(cx); }, )) .disabled( thread_status != ThreadStatus::Stopped && thread_status != ThreadStatus::Running, ) .tooltip({ let label = if capabilities .supports_terminate_threads_request .unwrap_or_default() { "Terminate Thread" } else { "Terminate all Threads" }; move |window, cx| Tooltip::text(label)(window, cx) }), ) }, ), ) .child( h_flex() .gap_2() .when_some( active_session .as_ref() .and_then(|session| session.read(cx).mode().as_running()) .cloned(), |this, session| { this.child( session.update(cx, |this, cx| this.thread_dropdown(window, cx)), ) .child(Divider::vertical()) }, ) .when_some(active_session.as_ref(), |this, session| { let pane = self.pane.downgrade(); let label = session.read(cx).label(cx); this.child(DropdownMenu::new( "debugger-session-list", label, ContextMenu::build(window, cx, move |mut this, _, cx| { let sessions = pane .read_with(cx, |pane, _| { pane.items().map(|item| item.boxed_clone()).collect() }) .ok() .unwrap_or_else(Vec::new); for (index, item) in sessions.into_iter().enumerate() { if let Some(session) = item.downcast::() { let pane = pane.clone(); this = this.entry( session.read(cx).label(cx), None, move |window, cx| { pane.update(cx, |pane, cx| { pane.activate_item( index, true, true, window, cx, ); }) .ok(); }, ); } } this }), )) .child(Divider::vertical()) }) .child( IconButton::new("debug-new-session", IconName::Plus) .icon_size(IconSize::Small) .on_click({ let workspace = self.workspace.clone(); let weak_panel = cx.weak_entity(); let past_debug_definition = self.past_debug_definition.clone(); move |_, window, cx| { let weak_panel = weak_panel.clone(); let past_debug_definition = past_debug_definition.clone(); let _ = workspace.update(cx, |this, cx| { let workspace = cx.weak_entity(); this.toggle_modal(window, cx, |window, cx| { NewSessionModal::new( past_debug_definition, weak_panel, workspace, window, cx, ) }); }); } }) .tooltip(|window, cx| { Tooltip::for_action( "New Debug Session", &CreateDebuggingSession, window, cx, ) }), ), ), ) } } impl EventEmitter for DebugPanel {} impl EventEmitter for DebugPanel {} impl EventEmitter for DebugPanel {} impl Focusable for DebugPanel { fn focus_handle(&self, cx: &App) -> FocusHandle { self.pane.focus_handle(cx) } } impl Panel for DebugPanel { fn pane(&self) -> Option> { Some(self.pane.clone()) } fn persistent_name() -> &'static str { "DebugPanel" } fn position(&self, _window: &Window, _cx: &App) -> DockPosition { DockPosition::Bottom } fn position_is_valid(&self, position: DockPosition) -> bool { position == DockPosition::Bottom } fn set_position( &mut self, _position: DockPosition, _window: &mut Window, _cx: &mut Context, ) { } fn size(&self, _window: &Window, _: &App) -> Pixels { self.size } fn set_size(&mut self, size: Option, _window: &mut Window, _cx: &mut Context) { self.size = size.unwrap(); } fn remote_id() -> Option { Some(proto::PanelId::DebugPanel) } fn icon(&self, _window: &Window, _cx: &App) -> Option { Some(IconName::Debug) } fn icon_tooltip(&self, _window: &Window, cx: &App) -> Option<&'static str> { if DebuggerSettings::get_global(cx).button { Some("Debug Panel") } else { None } } fn toggle_action(&self) -> Box { Box::new(ToggleFocus) } fn activation_priority(&self) -> u32 { 9 } fn set_active(&mut self, _: bool, _: &mut Window, _: &mut Context) {} } impl Render for DebugPanel { fn render(&mut self, window: &mut Window, cx: &mut Context) -> impl IntoElement { let has_sessions = self.pane.read(cx).items_len() > 0; v_flex() .size_full() .key_context("DebugPanel") .child(h_flex().children(self.top_controls_strip(window, cx))) .track_focus(&self.focus_handle(cx)) .map(|this| { if has_sessions { this.child(self.pane.clone()) } else { this.child( v_flex() .h_full() .gap_1() .items_center() .justify_center() .child( h_flex().child( Label::new("No Debugging Sessions") .size(LabelSize::Small) .color(Color::Muted), ), ) .child( h_flex().flex_shrink().child( Button::new("spawn-new-session-empty-state", "New Session") .size(ButtonSize::Large) .on_click(|_, window, cx| { window.dispatch_action( CreateDebuggingSession.boxed_clone(), cx, ); }), ), ), ) } }) .into_any() } }